Endpoints for generating and retrieving shipment-related documents.
Get shipping 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.
path Parameters
shipmentIdstringย ยทย uuidย ยทย required
query Parameters
formatstringย ยทย enumLabel format
Enum values:PDFPNGZPL
Headers
Acceptstringย ยทย enumResponse format. Use application/xml for EDI-compliant responses following EDIFACT D96A standard.
Enum values:application/jsonapplication/xmlDefault: application/json
Responses
Label generated successfully
shipmentIdstringย ยทย uuidย ยทย requiredformatstringย ยทย enumย ยทย requiredEnum values:PDFPNGZPL
idstringย ยทย uuidย ยทย readOnlyurlstringย ยทย uriย ยทย readOnlycreatedAtstringย ยทย date-timeย ยทย readOnlyexpiresAtstringย ยทย date-timeย ยทย readOnly
Get 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.
path Parameters
shipmentIdstringย ยทย uuidย ยทย required
query Parameters
formatstringย ยทย enumDocument format. XML/EDI formats follow international customs standards.
Enum values:PDFDOCXXMLJSONEDItemplatestringย ยทย enumCountry-specific template to use
Enum values:STANDARDEUUSCNUKincludestring[]Additional documents to include
Enum values:digital_signaturecustoms_preclearancepacking_listcertificate_origin
Responses
Commercial invoice generated successfully
documentsobject[]customsStatusstringย ยทย enumEnum values:PENDINGPRE_CLEAREDCLEARED
Get commercial invoice (legacy)
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.
path Parameters
shipmentIdstringย ยทย uuidย ยทย required
query Parameters
formatstringย ยทย enumEnum values:PDFDOCX
Responses
Commercial invoice generated successfully
urlstringย ยทย uriexpiresAtstringย ยทย date-time