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 · 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:
    EU
    NA
    APAC

​Update customs documentation › Request Body

  • items
    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

    • id
      string · uuid
    • status
      string · enum
      Enum values:
      PENDING
      APPROVED
      REJECTED
    • customsValue
      number · float
    • currency
      string
    • documents
      object[]

​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 · uuid · required

​Pay import duties › Request Body

  • paymentMethod
    string · enum · required
    Enum values:
    CREDIT_CARD
    BANK_TRANSFER
    ACCOUNT_BALANCE
  • paymentDetails
    object

​Pay import duties › Responses

    • amount
      number · float
    • currency
      string
    • receipt
      string · uri