Installation and setup

Requirements

• CS-Cart or Multi-Vendor 4.17.2 or later.
• Administrator access to the store’s admin panel.
• A Mondial Relay contract with access to the web services. Mondial Relay has two of them, with different credentials, both issued in Mondial Relay Connect once your account has been integrated:
  • API 2 (shipments and labels): a login (usually an address ending in @business-api.mondialrelay.com), a password and a customer id of up to 8 characters. In Connect open Administration > Gestion des utilisateurs, select the user, add the right Configuration des API, log out and in again, open Configuration des API, select API Version V2.0 and check or generate the credentials. The document shows the test customer id BDTEST only as a placeholder: your test values are issued to you.
  • API 1 (Point Relais search and tracking): a brand code (“Enseigne”, 8 characters) and a private key. For first tests Mondial Relay publishes a public test account: brand BDTEST13, private key TestAPI1key.
• Which products you may use (Point Relais, XL, home delivery) and the countries are decided by your contract. Home delivery is available with the shipment web service only if your contract includes it.
• A cron job on your server (step 8).

Install the add-on

1. Download the kv_mondial_relay-<version>.zip package from your Kavio Labs or CS-Cart Marketplace account.
2. In the admin panel, open Add-ons > Manage add-ons.
3. Click the gear button and choose Manual installation, then upload the archive.
4. Find Mondial Relay Pickup Points & Labels in the list and make sure its status is Active.
5. Enter your license key under Settings > License (Kavio Labs downloads) and click Check now.

Connect Mondial Relay

1. Open Orders > Mondial Relay shipments and the Connection tab (or Settings > Connection).
2. Choose Test mode. Under Point Relais search and tracking (API 1) enter the brand and the private key (the public test account BDTEST13 / TestAPI1key works for the search). Under Labels (API 2) enter the login, password and customer id of your test environment.
3. Enter the Shipper (sender address): company name, street and house number, postal code, city, country (default FR), e-mail and phone in international format (+33...). Empty fields fall back to the company data of your store (of the vendor in Multi-Vendor).
4. Click Save and test. The test runs a one-result Point Relais search near Paris with the API 1 credentials. The shipment web service has no read-only operation, so the API 2 credentials are only saved: they are proven by the first label.
5. Create a first label for a test order in test mode (the shipment web service sends test requests to connect-api-sandbox.mondialrelay.com). Switch to Live and enter the live credentials only after that works.
6. Open Administration > Shipping & taxes > Shipping methods, add a method, choose one of the services Mondial Relay Point Relais (24R), Mondial Relay Point Relais XL (24L) or Mondial Relay Home delivery (HOM). On the Configure tab enter your price (or weight table) and the countries. See Configuration.
7. In the add-on settings choose the label format and size and, if you want labels created automatically, the order status.
8. Add the cron job from the settings page (Cron section), every minute is fine. Overlapping runs are prevented.

Multi-Vendor

By default the marketplace owner connects one account for all vendors (Marketplace owner mode on): vendors have no Connection tab and cannot create labels on the owner’s contract. Switch it off to let each vendor connect their own Mondial Relay account in the vendor panel (Connection tab).

Update

1. Upload the new package the same way. Your settings, credentials and data are kept.
2. The add-on adds missing tables and settings by itself on the first request after the update.

See CHANGELOG for what changed in each version.

Uninstall

Open Add-ons > Manage add-ons, click the add-on’s gear button and choose Uninstall. This removes the add-on’s settings, language variables, shipping services and their shipping methods, and the database tables, including the stored credentials, labels and Point Relais choices.