latestOpenAPI 3.0.0Proprietary2026-08-22131410675.6 KB

8d8a7cf79204

documents

List shipments and their document statuses

Retrieve each shipment associated with the given id, including its tracking number and registered carrier documents.

get/v1/shipments/{shipment_id}/labels

Response

The request was a success.

shipment_idstring

The unique identifier of the shipment.

tracking_numberstring

The tracking number of the shipment.

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"
      }
    ]
  }
]