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

  • shipmentIdstring
  • formatstring
  • idstringoptional
  • urlstringoptional
  • createdAtstringoptional
  • expiresAtstringoptional

​Responses

    • shipmentIdstring
    • formatstring
    • idstringoptional
    • urlstringoptional
    • createdAtstringoptional
    • expiresAtstringoptional

​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

  • idrequiredstring

    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

  • shipmentIdstring
  • formatstring
  • idstringoptional
  • sizestringoptional
  • urlstringoptional
  • createdAtstringoptional
  • expiresAtstringoptional

​Responses

    • shipmentIdstring
    • formatstring
    • idstringoptional
    • sizestringoptional
    • urlstringoptional
    • createdAtstringoptional
    • expiresAtstringoptional

​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

  • idrequiredstring

    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

  • idrequiredstring

    The ID of the shipping label

​Responses

    • trackingNumberstring
    • carrierstring
    • trackingUrlstringoptional