List shipments and their document statuses
Retrieve each shipment associated with the given id, including its tracking number and registered carrier documents.
Response
The request was a success.
Example response
[
{
"shipment_id": "se-28529731",
"tracking_number": "1Z999AA10123456784",
"documents": [
{
"document_id": "7f3c1b2a-9d4e-4f5a-8c6b-2e1d0a9b8c7d",
"type": "usmca_commercial_invoice_certification_of_origin",
"file_name": "usmca-certification-of-origin.pdf",
"status": "awaiting_upload",
"error": "The uploaded file could not be read.",
"external_id": "1Z999AA10123456784"
}
]
}
]Changes
Changed in 1 of the 6 revisions of this API.12
- ●
added the new
freight_connection_inactiveenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status404response-property-enum-value-added
- ●
added the new
freight_connection_inactiveenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status500response-property-enum-value-added
- ●
added the new
freight_provider_id_requiredenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status404response-property-enum-value-added
- ●
added the new
freight_provider_id_requiredenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status500response-property-enum-value-added
- ●
added the new
freight_shipment_not_batchableenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status404response-property-enum-value-added
- ●
added the new
freight_shipment_not_batchableenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status500response-property-enum-value-added
- ●
added the new
freight_shipment_not_foundenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status404response-property-enum-value-added
- ●
added the new
freight_shipment_not_foundenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status500response-property-enum-value-added
- ●
added the new
freight_tracking_not_availableenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status404response-property-enum-value-added
- ●
added the new
freight_tracking_not_availableenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status500response-property-enum-value-added
- ●
added the new
freight_tracking_not_foundenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status404response-property-enum-value-added
- ●
added the new
freight_tracking_not_foundenum value to theerrors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/response property for the response status500response-property-enum-value-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●