Steps that must be followed:
Create Manifest – endpoint for manifest creation for each carrier
Each carrier has its own requirements for label creation. Feel free to select the one that suits your needs.
We also removed all the unnecessary fields from the request payload, and you will see only required fields for labels creation for each carrier.
Get Manifest – endpoint for retrieving statuses for created manifests
Using manifest_id from previous request response, you will be able to retrieve the status of your manifest creation request from STEP 1. Your goal here is to receive the status “FINISHED”. In case you don’t see any status changes for some time (5 minutes or more) contact us at email@example.com
Ideally you can ping this API each ~1 min or whatever is suitable for your system. This way you can keep a track of status changes and as soon as it reaches the right status, you will be able to download the requested labels.
Manifest Label – as the name says, this endpoint is used when you receive the status “FINISHED” from the STEP 2.
You must use the correct manifest_id from STEP 1.
How to get errors from external providers if manifest has received status FINISHED_WITH_ERROR?
We are constantly working on improving our validation, however sometimes we cannot avoid receiving errors from our service provider system’s, for such cases please follow instructions below:
Step 1. Use endpoint: https://api.eurora.com/gts-multi-carrier-external-v1#operation/getOrders
As parameters specify manifest_id and status (FINISHED_WITH_ERROR).
This will return the list of orders that have received errors for the manifest.
Step 2. For each of the orders received execute endpoint: https://api.eurora.com/gts-multi-carrier-external-v1#operation/getOrder
Which will return the details of the error occurred. For more information on what the error means please contact support.
Optional endpoints that can be used:
TRACKING – we have two endpoints that can be used to receive tracking statuses
Multi Tracking Events - https://api.integration.eurora.com/gts-multi-carrier-external-v1#operation/getTrackingEvents - you can list the array of strings (multiple tracking numbers) and retrieve tracking status for each of them
Tracking Events - https://api.integration.eurora.com/gts-multi-carrier-external-v1#operation/getTrackingEvent - this one can be used to retrieve the tracking status for single tracking number per request
ORDER – we have three endpoints that you can use to retrieve each orders information
Orders - https://api.integration.eurora.com/gts-multi-carrier-external-v1#operation/getOrders - to retrieve all the orders searched by specific parameters. You can search by manifest_id, referenceNo, status, etc..
Order - https://api.integration.eurora.com/gts-multi-carrier-external-v1#operation/getOrder - to retrieve the data for each parcel by tracking number
Order label - https://api.integration.eurora.com/gts-multi-carrier-external-v1#operation/getLabel - to get PDF label for specific parcel, by tracking number
Multi Order label - https://api.integration.eurora.com/gts-multi-carrier-external-v1#operation/getLabels - to retrieve multiple label PDFs for multiple tracking numbers (array of strings), by tracking numbers