documents

List shipments and their document statuses

Changed on

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

get/v1/shipments/{shipment_id}/labels

Request

  • Base URL: https://api.shipengine.com
  • URL: https://api.shipengine.com/v1/shipments/{shipment_id}/labels
  • Auth: API key in header API-Key

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

Changes

  • e998dffc42beRevision changes
    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

  • 020f57d6f5b8Revision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status