Shipment API

Documentation

Endpoint

Endpoints for generating and retrieving shipment-related documents.

Get shipping label

GET

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/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

Default: application/json

Get shipping label › Responses

Label generated successfully

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/shipments/{shipmentId}/label

const options = {method: 'GET'};

fetch('https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io//shipments/:shipmentId/label', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "shipmentId": "123e4567-e89b-12d3-a456-426614174000",
  "format": "PDF",
  "url": "https://api.sh.example.com/v1/labels/550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2025-01-09T12:00:00Z",
  "expiresAt": "2025-01-16T12:00:00Z"
}

json

Get commercial invoice

GET

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/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

include

string[]

Additional documents to include

Enum values:

digital_signature

customs_preclearance

packing_list

certificate_origin

Get commercial invoice › Responses

200

Commercial invoice generated successfully

object[]

customsStatus

string · enum

Enum values:

PENDING

PRE_CLEARED

CLEARED

GET/shipments/{shipmentId}/documents/v2/commercial-invoice

const options = {method: 'GET'};

fetch('https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io//shipments/:shipmentId/documents/v2/commercial-invoice', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "documents": [
    {
      "type": "COMMERCIAL_INVOICE",
      "url": "https://api.sh.example.com/v2/documents/invoice_123456.pdf",
      "format": "PDF",
      "template": "EU",
      "expiresAt": "2025-01-16T12:00:00Z",
      "digitalSignature": {
        "signedBy": "John Doe",
        "signedAt": "2025-01-09T12:00:00Z",
        "validUntil": "2026-01-09T12:00:00Z",
        "certificateId": "CERT-123456"
      }
    },
    {
      "type": "CUSTOMS_PRECLEARANCE",
      "url": "https://api.sh.example.com/v2/documents/preclearance_123456.pdf",
      "format": "PDF",
      "expiresAt": "2025-01-16T12:00:00Z"
    }
  ],
  "customsStatus": "PRE_CLEARED"
}

json

application/json

deprecated

Get commercial invoice (legacy)

GET

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/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

200

Commercial invoice generated successfully

url

string · uri

expiresAt

string · date-time

GET/shipments/{shipmentId}/documents/commercial-invoice

const options = {method: 'GET'};

fetch('https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io//shipments/:shipmentId/documents/commercial-invoice', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "url": "https://api.sh.example.com/v1/documents/invoice_123456.pdf",
  "expiresAt": "2025-01-16T12:00:00Z"
}

json

application/json

International Shipping Schemas

Get shipping label

GET

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/shipments/{shipmentId}/label

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

Default: application/json

Get shipping label › Responses

Label generated successfully

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://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/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

include

string[]

Additional documents to include

Enum values:

digital_signature

customs_preclearance

packing_list

certificate_origin

Get commercial invoice › Responses

200

Commercial invoice generated successfully

object[]

customsStatus

string · enum

Enum values:

PENDING

PRE_CLEARED

CLEARED

const options = {method: 'GET'}; fetch('https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io//shipments/:shipmentId/documents/v2/commercial-invoice', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));

{ "documents": [ { "type": "COMMERCIAL_INVOICE", "url": "https://api.sh.example.com/v2/documents/invoice_123456.pdf", "format": "PDF", "template": "EU", "expiresAt": "2025-01-16T12:00:00Z", "digitalSignature": { "signedBy": "John Doe", "signedAt": "2025-01-09T12:00:00Z", "validUntil": "2026-01-09T12:00:00Z", "certificateId": "CERT-123456" } }, { "type": "CUSTOMS_PRECLEARANCE", "url": "https://api.sh.example.com/v2/documents/preclearance_123456.pdf", "format": "PDF", "expiresAt": "2025-01-16T12:00:00Z" } ], "customsStatus": "PRE_CLEARED" }

Get commercial invoice (legacy)

GET

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/shipments/{shipmentId}/documents/commercial-invoice

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

200

Commercial invoice generated successfully

url

string · uri

expiresAt

string · date-time