Get Order by Reference
Retrieving Specific Order Information
This request is crucial for receiving updates about your order.
Where {{order_reference}} is the order reference you received in the response after placing your order.
It is generally used to:
- Update Order Status. You can periodically repeat the get order request to update your parcel's shipping status or other information later.
Optionally, If you can't process callbacks, you may need to manually make Get Order request to ensure whether the order was accepted or canceled, as well as to obtain a shipping label for your parcel.
- Obtain a shipping label that must be attached to the parcel before handing it over to the courier or placing it in a parcel locker.
- Acquire a courier tracking number.
- Get the pickup arrival time (when the courier will arrive to pick up your parcel.
- As well as all other data you may require about the order.
It's important to understand that some details, such as the shipping label and carrier tracking number, won't be immediately available after placing an order. Typically, these details become available shortly thereafter. As such, we recommend against attempting to update your order immediately after its placing an order to avoid any inconvenience.
To ensure you receive all necessary information as soon as it becomes available, we suggest setting up a callback processor on your system. Once your order has been processed on our end, we will send a callback to your server with all the required details. The data sent in this callback will mirror the information you receive in a standard Get Order response. Please note, the processing time for orders on our side can vary from 1 second to up to 20 minutes. We will typically send a callback to your system once we have processed and accepted the order.
Callback Optional callback from our server.
- When our team processes the order you will get a POST to your callback URL from our server.
- Some orders are processed almost instantly, while others may take longer (up to 20 minutes).
- If an order cannot be processed for any reason, it will be canceled, and you will receive a callback response indicating that the order placement has failed.
- The Payload of the callback requst is the same as you get in response in Get Order request.
- At present, our system will only send a callback request to your server a
single time (whether the order was accepted on not). It will not send any further callbacks regarding updates
to the order. If you require updates on your order status, you will need
to manually make a Get Order Request.