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

​Shipping Labels & Stamps API

This API allows you to create shipping labels and stamps for your shipments.

Authentication

All endpoints require a valid API key passed in the X-API-Key header.

Endpoint
Stamps

​Create a shipping stamp

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

Creates a new shipping stamp for a shipment.

The generated stamp will be available for download through the returned URL for 24 hours.

​Request Body

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

​Responses

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

​Invalidate a shipping stamp

PUT
https://api.sh.example.com/v1
/stamps/{id}/invalidate

Invalidates a shipping stamp, making it no longer available for download.

​path Parameters

  • id
    string
    required

    The ID of the stamp to invalidate

​Responses

    No response specified
Labels

​Create a shipping label

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

Creates a new shipping label for a shipment.

The generated label will be available for download through the returned URL for 24 hours.

​Request Body

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

​Responses

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

​Invalidate a shipping label

PUT
https://api.sh.example.com/v1
/labels/{id}/invalidate

Invalidates a shipping label, making it no longer available for download.

​path Parameters

  • id
    string
    required

    The ID of the label to invalidate

​Responses

    No response specified

​Get tracking number

GET
https://api.sh.example.com/v1
/labels/{id}/trackingnumber

Retrieves the tracking number associated with a shipping label.

​path Parameters

  • id
    string
    required

    The ID of the shipping label

​query Parameters

  • format
    string

    The format of the response

  • limit
    integer

    Maximum number of tracking events to return

​Responses

    • trackingNumber
      string
    • carrier
      string
    • trackingUrl
      string
      optional

​Get shipping label

GET
https://api.sh.example.com/v1
/labels/{id}

Retrieves a shipping label by ID. The label can be requested in different formats.

​path Parameters

  • id
    string
    required

    The ID of the shipping label

​query Parameters

  • format
    string

    The desired format of the label

​Responses

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