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

​Shipment Management

Endpoints for creating, tracking, updating, and managing shipments.

Endpoint

​Create a new shipment

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

Creates a new shipment with the provided details

​Create a new shipment › Headers

  • X-Correlation-ID
    string

    Unique identifier for tracking requests across multiple services

  • Idempotency-Key
    string

    Unique key to ensure idempotency of the request

  • X-API-Version
    string

    API version requested by the client

  • X-Request-Priority
    string

    Priority level for processing the shipment request

​Create a new shipment › Request Body

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

​Create a new shipment › Responses

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

​Track a shipment

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

Get the current status and tracking information for a shipment

​Track a shipment › path Parameters

  • trackingNumber
    string
    required

​Track a shipment › Headers

  • X-Correlation-ID
    string

    Unique identifier for tracking requests across multiple services

  • X-API-Version
    string

    API version requested by the client

  • X-Cache-Control
    string

    Caching behavior for the tracking response

​Track a shipment › Responses

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

​Cancel shipment

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

Cancel a shipment that hasn't been picked up yet

​Cancel shipment › path Parameters

  • trackingNumber
    string
    required

​Cancel shipment › Responses

    • status
      string
      optional
    • refundAmount
      number
      optional
    • currency
      string
      optional

​Hold shipment

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

Place a shipment on hold at a facility

​Hold shipment › path Parameters

  • shipmentId
    string
    required

​Hold shipment › Request Body

  • holdUntil
    string
  • reason
    string
    optional
  • facilityId
    string
    optional

​Hold shipment › Responses

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