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

​Create a new shipment

POST
https://api.sh.example.com/v1
/shipments

Creates a new shipment with the provided details

​Request Body

  • recipientAddress
    object
  • senderAddress
    recursive
  • packages
    object[]
  • id
    string
    optional
  • status
    string
    optional
  • trackingNumber
    string
    optional
  • createdAt
    string
    optional

​Responses

    • recipientAddress
      object
    • senderAddress
      recursive
    • packages
      object[]
    • id
      string
      optional
    • status
      string
      optional
    • trackingNumber
      string
      optional
    • createdAt
      string
      optional

​Track a shipment

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

Get the current status and tracking information for a shipment

​path Parameters

  • trackingNumber
    string
    required

​Responses

    • recipientAddress
      object
    • senderAddress
      recursive
    • packages
      object[]
    • id
      string
      optional
    • status
      string
      optional
    • trackingNumber
      string
      optional
    • createdAt
      string
      optional

​Hold shipment

PUT
https://api.sh.example.com/v1
/shipments/{shipmentId}/hold

Place a shipment on hold at a facility

​path Parameters

  • shipmentId
    string
    required

​Request Body

  • holdUntil
    string
  • reason
    string
    optional
  • facilityId
    string
    optional

​Responses

    • status
      string
      optional
    • holdLocation
      string
      optional
    • holdUntil
      string
      optional