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

​Rates & Billing

Endpoints related to calculating shipping rates, billing, and insurance.

Endpoint

​Calculate shipping rates

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

Calculate available shipping rates for a shipment based on service level, destination, and package details

​Calculate shipping rates › path Parameters

  • shipmentId
    string · uuid · required

​Calculate shipping rates › Request Body

  • serviceLevel
    string · enum · required
    Enum values:
    ECONOMY
    STANDARD
    EXPRESS
    SAME_DAY
  • insurance
    object

​Calculate shipping rates › Responses

    • baseRate
      number · float
    • fees
      object[]
    • totalRate
      number · float
    • currency
      string
    • transitTime
      object

​Add insurance

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

Add or modify insurance coverage for a shipment

​Add insurance › path Parameters

  • shipmentId
    string · uuid · required

​Add insurance › Request Body

  • coverage
    number · float · required
  • items
    object[]

​Add insurance › Responses

    • premium
      number · float
    • coverage
      number · float
    • policyNumber
      string