Register a document for a shipment

Register a carrier document against a shipment. The response returns an upload target; upload the document file to that target so it can later be sent to the carrier.

post/v1/shipments/{shipment_id}/documents

Request body

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

Changed in 1 of the 5 revisions of this API.18

Aug 15, 2026f3a66d20456518See the full diff
- ●
  added the new freight_connection_inactive enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new freight_connection_inactive enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_connection_inactive enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_provider_id_required enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new freight_provider_id_required enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_provider_id_required enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_batchable enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_batchable enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_batchable enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_shipment_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_available enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_available enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_available enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new freight_tracking_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500
  response-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

Full history