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

​Documentation

Endpoints for generating and retrieving shipment-related documents.

Endpoint

​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 label › path Parameters

  • shipmentId
    string · uuid · required

​Get shipping label › query Parameters

  • format
    string · enum

    Label format

    Enum values:
    PDF
    PNG
    ZPL

​Get shipping label › Headers

  • Accept
    string · enum

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

    Enum values:
    application/json
    application/xml

​Get shipping label › Responses

    • shipmentId
      string · uuid · required
    • format
      string · enum · required
      Enum values:
      PDF
      PNG
      ZPL
    • id
      string · uuid · readOnly
    • url
      string · uri · readOnly
    • createdAt
      string · date-time · readOnly
    • expiresAt
      string · 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 invoice › path Parameters

  • shipmentId
    string · uuid · required

​Get commercial invoice › query Parameters

  • format
    string · enum

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

    Enum values:
    PDF
    DOCX
    XML
    JSON
    EDI
  • template
    string · enum

    Country-specific template to use

    Enum values:
    STANDARD
    EU
    US
    CN
    UK
  • include
    string[]

    Additional documents to include

​Get commercial invoice › Responses

    • documents
      object[]
    • customsStatus
      string · 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

  • shipmentId
    string · uuid · required

​Get commercial invoice (legacy) › query Parameters

  • format
    string · enum
    Enum values:
    PDF
    DOCX

​Get commercial invoice (legacy) › Responses

    • url
      string · uri
    • expiresAt
      string · date-time