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

​Tracking & Notifications

Endpoints for tracking shipments and configuring notifications for shipment status updates.

Endpoint

​Get shipment tracking events

GET
https://api.sh.example.com/v1
/shipments/{shipmentId}/events

Retrieve detailed tracking events for a shipment

​Get shipment tracking events › path Parameters

  • shipmentId
    string
    required

​Get shipment tracking events › Responses

    • shipmentId
      string
      optional
    • events
      object[]
      optional

​Set up notifications

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

Configure notification preferences for shipment status updates

​Set up notifications › path Parameters

  • shipmentId
    string
    required

​Set up notifications › Request Body

  • email
    string[]
    optional
  • sms
    string[]
    optional
  • webhooks
    string[]
    optional
  • events
    string[]
    optional

​Set up notifications › Responses

    • status
      string
      optional
    • channels
      string[]
      optional