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

​International Shipping

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

Endpoint

​Update customs documentation

PUT
https://api.sh.example.com/v1
/shipments/{shipmentId}/customs

Update or add customs documentation for international shipments

​Update customs documentation › path Parameters

  • shipmentId
    string
    required

​Update customs documentation › Headers

  • X-Correlation-ID
    string

    Unique identifier for tracking requests across multiple services

  • Idempotency-Key
    string

    Unique key to ensure idempotency of the request

  • X-Customs-Region
    string

    Customs processing region for the shipment

​Update customs documentation › Request Body

  • items
    object[]
  • purpose
    string
    optional
  • incoterm
    string
    optional

​Update customs documentation › Responses

    • id
      string
      optional
    • status
      string
      optional
    • customsValue
      number
      optional
    • currency
      string
      optional
    • documents
      object[]
      optional

​Pay import duties

POST
https://api.sh.example.com/v1
/shipments/{shipmentId}/customs/duties

Pay import duties and taxes for an international shipment

​Pay import duties › path Parameters

  • shipmentId
    string
    required

​Pay import duties › Request Body

  • paymentMethod
    string
  • paymentDetails
    object
    optional

​Pay import duties › Responses

    • amount
      number
      optional
    • currency
      string
      optional
    • receipt
      string
      optional