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

​Get shipment tracking events

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

Retrieve detailed tracking events for a shipment

​path Parameters

  • shipmentId
    string
    required

​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

​path Parameters

  • shipmentId
    string
    required

​Request Body

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

​Responses

    • status
      string
      optional
    • channels
      string[]
      optional