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

​Shipment API

This API allows you to create and track shipments through the Cosmo Cargo platform.

Authentication

All endpoints require a valid API key passed in the X-API-Key header.

Endpoint

​Update customs documentation

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

Update or add customs documentation for international shipments

​path Parameters

  • shipmentId
    string
    required

​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

​Request Body

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

​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

​path Parameters

  • shipmentId
    string
    required

​Request Body

  • paymentMethod
    string
  • paymentDetails
    object
    optional

​Responses

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