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

​International Shipping

Endpoint

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

​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

  • shipmentIdstring · uuid · required

​Update customs documentation › Headers

  • X-Correlation-IDstring · uuid

    Unique identifier for tracking requests across multiple services

  • Idempotency-Keystring · uuid

    Unique key to ensure idempotency of the request

  • X-Customs-Regionstring · enum

    Customs processing region for the shipment

    Enum values:
    EU
    NA
    APAC
    Default: NA

​Update customs documentation › Request Body

  • itemsobject[] · required
  • purposestring · enum
    Enum values:
    COMMERCIAL
    PERSONAL
    GIFT
    RETURN
    REPAIR
  • incotermstring · enum
    Enum values:
    DAP
    DDP
    FCA
    EXW

​Update customs documentation › Responses

    • idstring · uuid
    • statusstring · enum
      Enum values:
      PENDING
      APPROVED
      REJECTED
    • customsValuenumber · float
    • currencystring
    • documentsobject[]

​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

  • shipmentIdstring · uuid · required

​Pay import duties › Request Body

  • paymentMethodstring · enum · required
    Enum values:
    CREDIT_CARD
    BANK_TRANSFER
    ACCOUNT_BALANCE
  • paymentDetailsobject

​Pay import duties › Responses

    • amountnumber · float
    • currencystring
    • receiptstring · uri
Rates & BillingDocumentation