We're announcing 🧑‍🚀 inter-galactic shipping ✨ for 3025!
Shipment API

Documentation

Endpoint

Endpoints for generating and retrieving shipment-related documents.


Get shipping label

GET
https://api.sh.example.com/v1
/shipments/{shipmentId}/label

Get the shipping label for a shipment in various formats. Supports both JSON and XML responses. XML format follows the EDIFACT D96A standard for shipping label interchange, while JSON is provided for modern API integrations.

Get shipping labelpath Parameters

  • shipmentIdstring · uuid · required

Get shipping labelquery Parameters

  • formatstring · enum

    Label format

    Enum values:
    PDF
    PNG
    ZPL

Get shipping labelHeaders

  • Acceptstring · enum

    Response format. Use application/xml for EDI-compliant responses following EDIFACT D96A standard.

    Enum values:
    application/json
    application/xml
    Default: application/json

Get shipping labelResponses

    • shipmentIdstring · uuid · required
    • formatstring · enum · required
      Enum values:
      PDF
      PNG
      ZPL
    • idstring · uuid · readOnly
    • urlstring · uri · readOnly
    • createdAtstring · date-time · readOnly
    • expiresAtstring · date-time · readOnly

Get commercial invoice

GET
https://api.sh.example.com/v1
/shipments/{shipmentId}/documents/v2/commercial-invoice

Generate an enhanced commercial invoice with digital signatures, multiple format support, and customs pre-clearance capabilities. Supports both standard formats and country-specific templates.

Get commercial invoicepath Parameters

  • shipmentIdstring · uuid · required

Get commercial invoicequery Parameters

  • formatstring · enum

    Document format. XML/EDI formats follow international customs standards.

    Enum values:
    PDF
    DOCX
    XML
    JSON
    EDI
  • templatestring · enum

    Country-specific template to use

    Enum values:
    STANDARD
    EU
    US
    CN
    UK
  • includestring[]

    Additional documents to include

    Enum values:
    digital_signature
    customs_preclearance
    packing_list
    certificate_origin

Get commercial invoiceResponses

    • documentsobject[]
    • customsStatusstring · enum
      Enum values:
      PENDING
      PRE_CLEARED
      CLEARED

deprecated

Get commercial invoice (legacy)

GET
https://api.sh.example.com/v1
/shipments/{shipmentId}/documents/commercial-invoice

Generate a basic commercial invoice for an international shipment. This endpoint is deprecated, please use /shipments/{shipmentId}/documents/v2/commercial-invoice for enhanced features including digital signatures, multiple formats, and customs pre-clearance.

Get commercial invoice (legacy)path Parameters

  • shipmentIdstring · uuid · required

Get commercial invoice (legacy)query Parameters

  • formatstring · enum
    Enum values:
    PDF
    DOCX

Get commercial invoice (legacy)Responses

    • urlstring · uri
    • expiresAtstring · date-time