🚚 Couriers
Ship24 API allows providing one or many courierCode for a shipment on various endpoints. Providing such courierCode on a shipment improves Ship24 tracking accuracy, as it indicates to Ship24 which courier is handling the shipment.
Although our system is able to automatically detect the courier from the tracking number in most cases, feel free to provide the courierCode just in case, or if the automatic detection fails to detect the courier.
We allow providing multiple couriers because a single shipment can be handled by many couriers during its lifecycle. For each shipment, up to 3 couriers can be provided at a time, for a total of 9 couriers maximum per shipment.
Getting the list of couriers
The list of couriers can be retrieved either:
- by fetching them from the
GET /couriersendpoint - by downloading it as CSV file from the Dashboard 💾 .(🔐Sign-up required).
Additional information
Required Fields
Some couriers require specific additional information in order to get tracking results. Our system won't block your API request if this information is not provided, but as a result, it may not be able to successfully retrieve tracking results for those specific couriers.
| Field value | Description |
|---|---|
is_destination_postcode_required at 1 (CSV) or true (API) | This courier requires the recipient's postal code (or ZIP code) in the field destinationPostCode. |
is_destination_country_code_required at 1 (CSV) or true (API) | This courier requires the recipient's country code in the field destinationCountryCode. |
Note: The field destinationPostCode is loosely validated in order to not block your API request in the event of an invalid value.
Deprecated Couriers
Some couriers may no longer be covered by our system, typically due to discontinued business operations. Please ensure that you are not using a deprecated courierCode when tracking shipments, using the is_deprecated field. Our system won't block your API request if this courierCode provided, but the value will be ignored.
| Field value | Description |
|---|---|
is_deprecated at 1 (CSV) or true (API) | This courier is deprecated, please avoid providing the courier's code in the field courierCode. |