Usage

Offer Mondial Relay at the checkout

1. Create one shipping method per service you sell (Administration > Shipping & taxes > Shipping methods): Point Relais (24R), Point Relais XL (24L) and/or Home delivery (HOM). Fill the Configure tab (price or weight table, countries, optional free-shipping threshold).
2. Point Relais and Point Relais XL. Under the method the customer sees the card Mondial Relay Point Relais with the button Choose Point Relais. The button opens the Mondial Relay picker (map and list) for the delivery country and postal code. The customer chooses a point; the card then shows its name, address and opening hours and the button changes to Change. The order cannot be placed without a point (“Please choose a Point Relais before you place the order.”).
3. The choice is checked on the server: the add-on asks the Mondial Relay point search for that point number and country, the point must be in the same country as the delivery address (status 92 otherwise) and, for the XL method, it must appear in an XL search. The address and opening hours that are saved with the order are the ones Mondial Relay answers with, not the ones the browser reports.
4. Home delivery. No picker. The customer’s phone number is required by Mondial Relay; an order without a valid number is refused when the label is created.

Create a label

1. Open the order. The Mondial Relay label and tracking tab shows the chosen Point Relais and the shipments of the order. (The add-on page is under Orders > Mondial Relay shipments.)
2. Click Create label. The add-on sends one ShipmentCreationRequest and stores the label (PDF or ZPL), the 8-digit shipment number (also the tracking number) and the reference of the request. The reference is shown on the tab as O<order>-<row>, for example O1234-56.
3. Download label gives the stored file. Print it at its own size: Mondial Relay does not accept resized labels. The label is also created automatically when you set “Create the label when the order status becomes”.
4. A rejected request (for example an invalid postal code) shows Mondial Relay’s error code and text. Fix the order and click again. Failed automatic jobs are retried where a retry makes sense and are listed under Jobs.

Per order only one active shipment exists. No label is created for orders that are cancelled, declined, failed, incomplete or backordered, or that are paid with the payment method you marked as cash on delivery. Names and addresses are written without accents (the documented patterns are ASCII) and cut at the documented lengths, see Conformance.

Return label

On the order’s tab click Create return label. A second request is sent with the customer as sender, your shop as recipient, collection mode REL and delivery mode LCC; the file is available as Return label. The reference of a return request is R<order>-<row>. Label-free returns with a QR code (a V-2.7.1 option for some countries) are not supported: the add-on asks for PDF or ZPL.

Cancel

Cancel shipment removes the label in the store and marks the shipment cancelled. The Mondial Relay web services have no cancel operation, so Mondial Relay is not told and the shipment still exists there. A new label creates a second shipment. If the parcel was already handed over, contact Mondial Relay.

Labels that got no answer

A label cannot be undone and there is no way to look a shipment up by its reference through the web service, so the add-on never repeats a request whose result it does not know. The request is saved before it is sent (state Label request sent to Mondial Relay). If Mondial Relay does not answer in time (timeout, server error, status -1 or 99999) or the request is interrupted, the shipment shows Result unknown: check Mondial Relay Connect and nothing is sent again, not by the queue and not by a second click.

Look for the shipment in Mondial Relay Connect. Then on the order’s tab either:

• enter its 8-digit shipment number and click Adopt shipment. The number is checked with the tracking service (an unknown parcel answers status 94); the label has to be reprinted in Mondial Relay Connect; or
• click Nothing was created at Mondial Relay (after you checked Connect) to allow a new label.

The reference shown on the tab (O<order>-<row>) is sent as OrderNo; the customer reference K<order id> is sent as CustomerNo. In the sample label both appear as the label values MR.Expedition.ReferenceExterne and MR.Expedition.ReferenceClient; where Connect lets you search for them is not described in the documents, so look by date and recipient if needed.

In Multi-Vendor with the marketplace owner account mode, vendors can see shipments of their orders but cannot create labels on the owner’s contract.

Tracking

The cron job reads WSI2_TracingColisDetaille (API 1) for every open shipment about every 5 hours, first 30 minutes after the label was created. Mondial Relay asks for at most 4 to 6 queries per shipment and day and no batch use, so shipments with a problem are checked every 12 hours, delivered shipments are never queried again, and a run handles at most 200 shipments. Refresh tracking checks one shipment at once; use it sparingly because it counts against the same limit.

Mondial Relay’s tracking codes map to: 80 recorded parcel = created, 81 parcel in process = in transit, 82 delivered, 83 anomaly = problem. Status 94 (unknown parcel) keeps “created”: Mondial Relay may not have scanned the parcel yet. The order shows the latest event with its place and the date and time as Mondial Relay sends them. Tracking needs the API 1 credentials; without them nothing is read. The tracking number links to the Mondial Relay tracking page (see Conformance for what could not be verified).

Rates

Privacy

• Mondial Relay. The add-on sends the recipient’s name, address and the order reference. The e-mail address and phone number of the customer are not sent for Point Relais deliveries unless you switch on “Send e-mail address and mobile number to Mondial Relay”. Home delivery always sends the customer’s phone number (mandatory in the document) and never the e-mail address unless the setting is on. The sender’s address, e-mail and phone are your own.
• Third-party servers at the checkout. The picker is the Mondial Relay widget. It is loaded in the customer’s browser only when the customer opens the picker: the script comes from widget.mondialrelay.com, the map library (Leaflet) from unpkg.com, and the map tiles from OpenStreetMap servers, so these servers see the customer’s IP address and the postal code searched. The picker panel shows a notice about it. Mention it in your privacy policy.
• Nothing is sent to Kavio Labs except the daily license check (domain, add-on version).