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

​Rates & Billing

Endpoint

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

​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

  • shipmentIdstring · uuid · required

​Calculate shipping rates › Request Body

  • serviceLevelstring · enum · required
    Enum values:
    ECONOMY
    STANDARD
    EXPRESS
    SAME_DAY
  • insuranceobject

​Calculate shipping rates › Responses

    • baseRatenumber · float
    • feesobject[]
    • totalRatenumber · float
    • currencystring
    • transitTimeobject

​Add insurance

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

Add or modify insurance coverage for a shipment

​Add insurance › path Parameters

  • shipmentIdstring · uuid · required

​Add insurance › Request Body

  • coveragenumber · float · required
  • itemsobject[]

​Add insurance › Responses

    • premiumnumber · float
    • coveragenumber · float
    • policyNumberstring
Shipment ManagementInternational Shipping