International Shipping

Server

Operations for managing customs documentation, duties, and international shipment processes.

Sector 7G Advisory

Interstellar customs regulations were updated in Stardate 2025.3. All shipments crossing the Outer Rim must include a Quantum Manifest.

Update customs documentation

PUT

https://c1cf69108515455da09b5a33ff336111-oas.api.mockbin.io

/shipments/{shipmentId}/customs

Bearer (JWT)

X-API-Key (header)

Update or add customs documentation for international shipments

Update customs documentation › path Parameters

shipmentId

string · uuid · required

Update customs documentation › Headers

X-Correlation-ID

string · uuid

Unique identifier for tracking requests across multiple services

Idempotency-Key

string · uuid

Unique key to ensure idempotency of the request

X-Customs-Region

string · enum

Customs processing region for the shipment

Enum values:

APAC

Default: NA

Update customs documentation › Request Body

object[] · required

purpose

string · enum

Enum values:

COMMERCIAL

PERSONAL

GIFT

RETURN

REPAIR

incoterm

string · enum

Enum values:

DAP

DDP

FCA

EXW

Update customs documentation › Responses

200

Customs documentation updated successfully

id

string · uuid

status

string · enum

Enum values:

PENDING

APPROVED

REJECTED

customsValue

number · float

currency

string

object[]

PUT/shipments/{shipmentId}/customs

fetch('https://c1cf69108515455da09b5a33ff336111-oas.api.mockbin.io/shipments/:shipmentId/customs', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer <token>'
  },
  body: JSON.stringify({
    items: [
      {
        description: 'Smartphone',
        quantity: 10,
        value: 399.99,
        weight: 0.18,
        hsCode: '851712',
        originCountry: 'CN'
      },
      {
        description: 'Protective Cases',
        quantity: 10,
        value: 9.99,
        weight: 0.05,
        hsCode: '392690',
        originCountry: 'CN'
      }
    ],
    purpose: 'COMMERCIAL',
    incoterm: 'DDP'
  })
})

Example Request Body

{
  "items": [
    {
      "description": "Smartphone",
      "quantity": 10,
      "value": 399.99,
      "weight": 0.18,
      "hsCode": "851712",
      "originCountry": "CN"
    },
    {
      "description": "Protective Cases",
      "quantity": 10,
      "value": 9.99,
      "weight": 0.05,
      "hsCode": "392690",
      "originCountry": "CN"
    }
  ],
  "purpose": "COMMERCIAL",
  "incoterm": "DDP"
}

json

application/json

Example Responses

{
  "id": "a1b2c3d4-e5f6-4a5b-9c8d-1a2b3c4d5e6f",
  "status": "APPROVED",
  "customsValue": 4099.8,
  "currency": "USD",
  "documents": [
    {
      "type": "COMMERCIAL_INVOICE",
      "url": "https://api.sh.example.com/v1/customs/docs/invoice_12345.pdf"
    },
    {
      "type": "DECLARATION",
      "url": "https://api.sh.example.com/v1/customs/docs/declaration_12345.pdf"
    }
  ]
}

json

application/json

Pay import duties

POST

https://c1cf69108515455da09b5a33ff336111-oas.api.mockbin.io

/shipments/{shipmentId}/customs/duties

X-API-Key (header)

+Bearer (JWT)

Pay import duties and taxes for an international shipment. Requires both an API key and a bearer token.

Pay import duties › path Parameters

shipmentId

string · uuid · required

Pay import duties › Request Body

paymentMethod

string · enum · required

Enum values:

CREDIT_CARD

BANK_TRANSFER

ACCOUNT_BALANCE

object

Pay import duties › Responses

200

Duties paid successfully

amount

number · float

currency

string

receipt

string · uri

Rates & Billing Documentation