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

​Shipment API

This API allows you to create and track shipments through the Ship Happens platform.

Authentication

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

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

​path Parameters

  • shipmentId
    string
    required

​Request Body

  • serviceLevel
    string
  • insurance
    object
    optional

​Responses

    • baseRate
      number
      optional
    • fees
      object[]
      optional
    • totalRate
      number
      optional
    • currency
      string
      optional
    • transitTime
      object
      optional

​Add insurance

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

Add or modify insurance coverage for a shipment

​path Parameters

  • shipmentId
    string
    required

​Request Body

  • coverage
    number
  • items
    object[]
    optional

​Responses

    • premium
      number
      optional
    • coverage
      number
      optional
    • policyNumber
      string
      optional