documents

Register a document for a label

Changed on

Register a carrier document against a label. The response returns an upload target; upload the document file to that target, then call the send documents endpoint to transmit it to the carrier. Carrier information is resolved automatically from the label.

post/v1/labels/{label_id}/documents

Request

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

Request body

type'commercial_invoice' | 'certificate_of_origin' | 'usmca_commercial_invoice_certification_of_origin' | 'usmca_certification_of_origin' | 'pro_forma_invoice' | 'other' | 'authorization_form' | 'export_accompanying_document' | 'export_license' | 'import_permit' | 'one_time_nafta' | 'power_of_attorney' | 'packing_list' | 'sed_document' | 'shippers_letter_of_instruction' | 'declaration' | 'section_232_customs_affidavit' required

The type of carrier document being registered. Supported values vary by carrier. See the Carrier Document Upload guide for the document types each carrier accepts.

format'PDF' | 'PNG'

The file format of the document being uploaded.

file_namestring required

The file name of the document, including its extension.

Example request

{
  "type": "usmca_commercial_invoice_certification_of_origin",
  "format": "PDF",
  "file_name": "usmca-certification-of-origin.pdf"
}

Response

The document was registered successfully.

document_idstring

The unique identifier assigned to the registered document.

Example response

{
  "document_id": "019eb24e-cd4e-7609-b740-c2324fe93272",
  "upload": {
    "url": "https://carrier-doc-upload.s3.amazonaws.com",
    "fields": {
      "Content-Type": "application/pdf",
      "key": "019eb24e-cd4e-7609-b740-c2324fe93272.pdf",
      "x-amz-meta-document-id": "019eb24e-cd4e-7609-b740-c2324fe93272",
      "x-amz-meta-seller-id": "8801990",
      "X-Amz-Algorithm": "AWS4-HMAC-SHA256",
      "X-Amz-Credential": "ASIA.../20260610/us-east-1/s3/aws4_request",
      "X-Amz-Date": "20260610T161249Z",
      "Policy": "eyJleHBpcmF0aW9uIjoi...",
      "X-Amz-Signature": "b81189b9df29...",
      "X-Amz-Security-Token": "IQoJb3JpZ2lu..."
    }
  }
}

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 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 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

    • 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

    • 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

      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

      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

    • 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