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

​Documentation

Endpoint

​Get shipping label

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

​Get shipping label › path Parameters

  • shipmentIdstring · uuid · required

​Get shipping label › query Parameters

  • formatstring · enum
    Enum values:
    PDF
    PNG
    ZPL

​Get shipping label › Headers

  • Acceptstring · enum
    Enum values:
    application/json
    application/xml
    Default: application/json

​Get shipping label › Responses

    • 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

​Get commercial invoice › path Parameters

  • shipmentIdstring · uuid · required

​Get commercial invoice › query Parameters

  • formatstring · enum
    Enum values:
    PDF
    DOCX
    XML
    JSON
    EDI
  • templatestring · enum
    Enum values:
    STANDARD
    EU
    US
    CN
    UK
  • includestring[]
    Enum values:
    digital_signature
    customs_preclearance
    packing_list
    certificate_origin

​Get commercial invoice › Responses

    • 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

​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
International ShippingTracking & Notifications