Open the pickup code link
Public. The link of the pickup code text message. Gives the code only while the parcel is out for delivery, never the recipient details.
path Parameters
tokenThe token at the end of the link.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Open the pickup code link › Responses
What the link shows.
tracking_numberstatuspickup_codeOnly while the parcel is out for delivery or waits at a pickup point.
The pickup point where the parcel waits for the recipient; null for a delivery to an address.
The carrier that delivers the parcel: its public brand and support contact only.
Text a confirmation code to the recipient
Public. Sends a six-digit code to the phone number the shipper gave. One code a minute and five a day per parcel; a code lasts ten minutes.
path Parameters
trackingNumberTwo-letter carrier prefix, 8 digits and a check digit. Spaces and case are ignored.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Text a confirmation code to the recipient › Responses
The code was sent.
verification_idexpires_at^(?:(?:\d\d[2468][04… · requiredChange a delivery as the recipient
Public, confirmed by the text message code. Pick another day among the next five working days, collect the parcel at the hub after a failed attempt, or leave directions for the driver.
path Parameters
trackingNumberTwo-letter carrier prefix, 8 digits and a check digit. Spaces and case are ignored.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Change a delivery as the recipient › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: verification_id, code, kind +1 more | |
| type = object · requires: verification_id, code, kind | |
| type = object · requires: verification_id, code, kind +1 more |
verification_idcode^\d{6}$ · requiredThe six digits sent by text message.
kinddate^(?:(?:\d\d[2468][04… · requiredA Noumea day among the next five working days.
Change a delivery as the recipient › Responses
The public tracking view after the change.
tracking_numberstatusservice_kinddelivery_confirmationWhat the recipient must do at the door.
destination_zoneparcel_countWhen the next delivery attempt is expected: the window of the current attempt while out for delivery, the next attempt after a failed one. null when unknown.
failure_reasonWhy the last attempt failed, while the status is delivery_failed.
The carrier that delivers the parcel: its public brand and support contact only.
The pickup point where the parcel waits for the recipient, once it got there; null before, or for a delivery to an address.