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

​Tracking & Notifications

Endpoint

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

​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

  • shipmentIdstring · uuid · required

​Get shipment tracking events › Responses

    • shipmentIdstring · uuid
    • eventsobject[]

​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

  • shipmentIdstring · uuid · required

​Set up notifications › Request Body

  • emailstring[]
  • smsstring[]
  • webhooksstring[]
  • eventsstring[]
    Enum values:
    PICKUP_SCHEDULED
    IN_TRANSIT
    OUT_FOR_DELIVERY
    DELIVERED
    EXCEPTION
DocumentationSchemas