For the book response, there can be errors at the top-level request or for individual orders booked.
If the error occurs at the top-level request (order format, authorization), then this error code applies. Otherwise, the response is successful and individual errors are applied in the body of each booked item.
error_description
string
false
Human-readable description of the top-level error encountered.
count
integer
false
Number of items in the response
Response schema for response
Name
Type
Required
Description
courier
string
false
The courier where the booking was made
manifest
string
false
The Manifest ID of the booking
manifest_pdf
string
false
A URL to a printable copy of the shipping manifest. This is a pre-signed URL, generated by the Shippit platform to provide access to a secured document. The pre-signed URL remains valid for 7 days. If you need to access this document after expiration, please make another request for a new URL to be issued.
order_count
integer(int32)
false
How many orders were included in this manifest.
success
boolean
false
Whether or not the booking succeeded
orders
string
false
An array of order tracking numbers included in this status. Used to indicate which orders failed to manifest in the case where success = false.
error
string
false
Error code that applies to the individual bookings / orders referenced.
error_description
string
false
Human-readable error message applied to the individual bookings / orders referenced.
