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 shipping label

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

Get the shipping label for a shipment in various formats. Supports both JSON and XML responses. XML format follows the EDIFACT D96A standard for shipping label interchange, while JSON is provided for modern API integrations.

​path Parameters

  • shipmentId
    string
    required

​query Parameters

  • format
    string

    Label format

​Headers

  • Accept
    string

    Response format. Use application/xml for EDI-compliant responses following EDIFACT D96A standard.

​Responses

    • shipmentId
      string
    • format
      string
    • id
      string
      optional
    • url
      string
      optional
    • createdAt
      string
      optional
    • expiresAt
      string
      optional

​Get commercial invoice

GET
https://api.sh.example.com/v1
/shipments/{shipmentId}/documents/commercial-invoice

Generate a commercial invoice for an international shipment

​path Parameters

  • shipmentId
    string
    required

​query Parameters

  • format
    string

​Responses

    • url
      string
      optional
    • expiresAt
      string
      optional