Settings
Open Add-ons > Manage add-ons > Mondial Relay Pickup Points & Labels > Settings.
General
Section titled “General”| Setting | Default | Description |
|---|---|---|
| Enable | On | When off, no new work is started. Jobs of work that is already under way are still processed. |
| Marketplace owner mode | On | On: every order is processed with the marketplace owner’s Mondial Relay account and vendors have no connection page. Off: each vendor connects their own account. |
| Debug log | Off | Also stores every HTTP call with a masked summary. The label request (personal data and password) is logged as its shape only; passwords and keys are never stored. Switch off when you are done. |
| Log retention (days) | 90 | Older log entries are removed by the cron run. |
| Create the label when the order status becomes | empty | Empty = create labels by hand on the order page. |
| Also create a CS-Cart shipment | On | Records the Mondial Relay shipment number as a regular shipment so the customer’s order page and notifications show it. |
| Label format | PDF (OutputType PdfUrl) or ZPL for thermal printers (OutputType ZplCode, format Generic_ZPL_10x15_200dpi). |
|
| Label size | 10x15 | OutputFormat of PDF labels: 10x15 (one label per page), A4 or A5. Mondial Relay requires that labels are not resized when printed. |
| Cash on delivery payment method | empty | Mondial Relay ended cash on delivery (V-2.7.1, “End of COD”). Orders paid with this method are not sent: the label is refused with a clear message. Empty = no check. |
| Default parcel weight (kg) | 1 | Used when no product of the order has a weight. Mondial Relay requires a weight of at least 10 g. |
| Package length / width / depth (cm) | empty | Optional. Sent with the parcel when set. Mondial Relay requires dimensions for some flows (for example Poland, which this version does not cover). |
| Days between the order and the hand-over | 0 | Sent as DelaiEnvoi to the Point Relais search and as SearchDelay to the picker, so that points that are closed when you hand the parcel over are not offered (0 to 30). |
| Parcel content text | empty | Optional short text printed on the label (up to 40 characters, for example Books). Empty = nothing is sent. |
| Send e-mail address and mobile number to Mondial Relay | Off | Data protection. Off: Point Relais deliveries send no e-mail address and no phone number. Home delivery always sends the customer’s phone number because Mondial Relay requires it (error 10085), but never the e-mail address unless this is on. On: e-mail address and phone number are also sent for Point Relais deliveries so that Mondial Relay can notify the customer. Tell your customers in your privacy policy. |
Connection
Section titled “Connection”Credentials are not ordinary settings: they are entered on the Connection page and stored encrypted (AES-256-GCM, key derived from your store’s own secret). Secrets are never shown again; leave a secret field empty to keep the saved value. Test and live credentials are kept side by side.
| Field | Description |
|---|---|
| Mode | Test (Mondial Relay sandbox) sends label requests to connect-api-sandbox.mondialrelay.com and uses the test credentials. Live uses connect-api.mondialrelay.com and creates real shipments. The search and tracking web service (API 1) has a single address, api.mondialrelay.com, for both modes; only the brand and key differ. |
| Login (shipment web service) | The API 2 login from Mondial Relay Connect (Administration > Configuration des API, API version V2.0), usually an address ending in @business-api.mondialrelay.com. |
| Password (shipment web service) | The API 2 password. It travels inside the XML request to Mondial Relay (that is how the service authenticates) and is never logged. |
| Customer id | The customer id of your Mondial Relay account (up to 8 letters and digits; BDTEST is the placeholder in the document), sent as CustomerId. |
| Brand (Enseigne) | The 8-character brand code of the search and tracking web service and of the picker. Public test account: BDTEST13. |
| Private key (search and tracking) | The private key of the brand, used to compute the Security hash of every API 1 call. Public test key: TestAPI1key. |
| Shipper (sender address) | Name (company), street and house number, address line 2, postal code, city, country (ISO code, default FR), e-mail, phone (international format). Printed on the label as the sender. Empty = company data of the store (of the vendor in Multi-Vendor). Needed: name, street, postal code, city. |
You can save only the API 1 block (search and tracking) or only the API 2 block (labels); labels need API 2, the Point Relais picker and tracking need API 1.
Shipping method (Configure tab)
Section titled “Shipping method (Configure tab)”Mondial Relay’s web services have no price operation: the customer’s price is yours.
| Field | Description |
|---|---|
| Price | Flat price per parcel, in the primary currency of the store. Ignored when a weight table is set. |
| Price by weight | Pairs “up to kg = price”, for example 2=4.99, 5=5.99, 10=7.49. The first row that holds the cart weight is used; a heavier cart does not get the method. |
| Free shipping from | Order subtotal (primary currency) from which the price is 0. Empty = never free. |
| Countries (zone) | Destination countries this method serves, comma separated ISO codes (FR,BE,ES,NL). Default FR. Mondial Relay delivers to the countries of its network that your contract covers; Mondial Relay answers with an error for the rest. |
| Maximum weight (kg) | The method is hidden for heavier carts. Empty = no limit in the store. Weight limits per product are checked by Mondial Relay when the label is created. |
| Delivery time text | Optional text shown next to the price, for example “2-4 working days”. The web services do not publish delivery times. |
The three services
Section titled “The three services”| Service | Code | Delivery mode | What the customer gets |
|---|---|---|---|
| Mondial Relay Point Relais | mr_24r |
24R | Delivery to a Point Relais or Locker, chosen at the checkout. |
| Mondial Relay Point Relais XL | mr_24l |
24L | Delivery to a Point Relais XL for larger parcels, chosen at the checkout. |
| Mondial Relay Home delivery | mr_hom |
HOM | Delivery to the customer’s address. Needs a phone number of the customer and a contract that includes home delivery. |
The D+1 delivery (XOH) is not offered: Mondial Relay requires an additional EDI file besides the shipment request (“a specific action is mandatory by EDI”).
The queue runs from cron. Use either the command line or the secret web address shown in the Cron section of the settings:
php /path/to/store/admin.php --dispatch=kv_mondial_relay.cronhttps://your-store.example/index.php?dispatch=kv_mondial_relay.cron&key=<secret>
Tracking is scheduled by the same run (open shipments about every 5 hours).
Log and jobs
Section titled “Log and jobs”- Log lists every call and job with filters (level, action, text, dates) and a CSV export.
- Jobs lists the queue. A job that fails is retried after 5 minutes, 15 minutes, 1 hour, 3 hours and 12 hours, then marked “Gave up”; use Retry to queue it again. A label whose result is unknown is never retried (see Usage).
Multi-Vendor
Section titled “Multi-Vendor”In the vendor panel a vendor sees only their own records. With the marketplace owner mode off the vendor also gets the Connection tab for their own account. In owner mode vendors can see the shipments of their orders but cannot create labels on the owner’s contract, and “Run the queue now” is for administrators only.