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

Labels & Stamps API

Labels (3.0.0)

Endpoint

Download schema

Endpoints for managing shipping labels. Labels are printable documents that contain:

Shipping address information
Tracking barcodes
Carrier-specific routing data
Package details

Create a shipping label

POST

https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io

/labels

Creates a new shipping label for a shipment.

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

Create a shipping label › Request Body

shipmentId

string · uuid · required

format

string · enum · required

Enum values:

PDF

PNG

ZPL

id

string · uuid · readOnly

size

string · enum

Enum values:

4x6

6x4

8.5x11

url

string · uri · readOnly

createdAt

string · date-time · readOnly

expiresAt

string · date-time · readOnly

Create a shipping label › Responses

Label created successfully

shipmentId

string · uuid · required

format

string · enum · required

Enum values:

PDF

PNG

ZPL

id

string · uuid · readOnly

size

string · enum

Enum values:

4x6

6x4

8.5x11

url

string · uri · readOnly

createdAt

string · date-time · readOnly

expiresAt

string · date-time · readOnly

POST/labels

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({shipmentId: '123e4567-e89b-12d3-a456-426614174000', format: 'PDF', size: '4x6'})
};

fetch('https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io//labels', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Request Body

{
  "shipmentId": "123e4567-e89b-12d3-a456-426614174000",
  "format": "PDF",
  "size": "4x6"
}

json

application/json

Example Responses

{
  "id": "987fcdeb-51a2-43f7-9876-543210abcdef",
  "shipmentId": "123e4567-e89b-12d3-a456-426614174000",
  "format": "PDF",
  "size": "4x6",
  "url": "https://assets.sh.example.com/labels/label-123456.pdf",
  "createdAt": "2025-01-09T12:00:00Z",
  "expiresAt": "2025-01-10T12:00:00Z"
}

json

application/json

Invalidate a shipping label

PUT

https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io

/labels/{id}/invalidate

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

Invalidate a shipping label › path Parameters

id

string · uuid · required

The ID of the label to invalidate

Invalidate a shipping label › Responses

Label invalidated successfully

No data returned

PUT/labels/{id}/invalidate

const options = {method: 'PUT'};

fetch('https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io//labels/:id/invalidate', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

No example specified for this content type

Get tracking number

GET

https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io

/labels/{id}/trackingnumber

Retrieves the tracking number associated with a shipping label.

Get tracking number › path Parameters

id

string · uuid · required

The ID of the shipping label

Get tracking number › query Parameters

format

string · enum

The format of the response

Enum values:

basic

detailed

carrier-specific

Default: basic

limit

integer · min: 1 · max: 100

Maximum number of tracking events to return

Default: 10

carrier

string · enum

Filter tracking information by specific carrier

Enum values:

UPS

USPS

FedEx

DHL

Default: null

events_since

string · date-time

Only return tracking events after this timestamp

sort

string · enum

Sort order for tracking events

Enum values:

newest_first

oldest_first

Default: newest_first

Get tracking number › Responses

Tracking number retrieved successfully

trackingNumber

string · required

carrier

string · required

trackingUrl

string · uri

GET/labels/{id}/trackingnumber

const options = {method: 'GET'};

fetch('https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io//labels/:id/trackingnumber', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "trackingNumber": "1Z999AA1234567890",
  "carrier": "UPS",
  "trackingUrl": "https://www.ups.com/track?tracknum=1Z999AA1234567890"
}

json

application/json

Get shipping label

GET

https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io

/labels/{id}

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

Get shipping label › path Parameters

id

string · uuid · required

The ID of the shipping label

Get shipping label › query Parameters

format

string · enum

The desired format of the label

Enum values:

PDF

PNG

ZPL

JPEG

TIFF

SVG

EPS

BMP

Default: PDF

Get shipping label › Responses

Label retrieved successfully

shipmentId

string · uuid · required

format

string · enum · required

Enum values:

PDF

PNG

ZPL

id

string · uuid · readOnly

size

string · enum

Enum values:

4x6

6x4

8.5x11

url

string · uri · readOnly

createdAt

string · date-time · readOnly

expiresAt

string · date-time · readOnly

GET/labels/{id}

const options = {method: 'GET'};

fetch('https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io//labels/:id', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "id": "987fcdeb-51a2-43f7-9876-543210abcdef",
  "shipmentId": "123e4567-e89b-12d3-a456-426614174000",
  "format": "PDF",
  "size": "4x6",
  "url": "https://assets.sh.example.com/labels/label-123456.pdf",
  "createdAt": "2025-01-09T12:00:00Z",
  "expiresAt": "2025-01-10T12:00:00Z"
}

json

application/json

Stamps

Labels & Stamps API

Labels (3.0.0)

Endpoint

Download schema

Endpoints for managing shipping labels. Labels are printable documents that contain:

Shipping address information
Tracking barcodes
Carrier-specific routing data
Package details

Create a shipping label

POST

https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io

/labels

Creates a new shipping label for a shipment.

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

Create a shipping label › Request Body

shipmentId

string · uuid · required

format

string · enum · required

Enum values:

PDF

PNG

ZPL

id

string · uuid · readOnly

size

string · enum

Enum values:

4x6

6x4

8.5x11

url

string · uri · readOnly

createdAt

string · date-time · readOnly

expiresAt

string · date-time · readOnly

Create a shipping label › Responses

Label created successfully

shipmentId

string · uuid · required

format

string · enum · required

Enum values:

PDF

PNG

ZPL

id

string · uuid · readOnly

size

string · enum

Enum values:

4x6

6x4

8.5x11

url

string · uri · readOnly

createdAt

string · date-time · readOnly

expiresAt

string · date-time · readOnly

POST/labels

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({shipmentId: '123e4567-e89b-12d3-a456-426614174000', format: 'PDF', size: '4x6'})
};

fetch('https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io//labels', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Request Body

{
  "shipmentId": "123e4567-e89b-12d3-a456-426614174000",
  "format": "PDF",
  "size": "4x6"
}

json

application/json

Example Responses

{
  "id": "987fcdeb-51a2-43f7-9876-543210abcdef",
  "shipmentId": "123e4567-e89b-12d3-a456-426614174000",
  "format": "PDF",
  "size": "4x6",
  "url": "https://assets.sh.example.com/labels/label-123456.pdf",
  "createdAt": "2025-01-09T12:00:00Z",
  "expiresAt": "2025-01-10T12:00:00Z"
}

json

application/json

Invalidate a shipping label

PUT

https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io

/labels/{id}/invalidate

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

Invalidate a shipping label › path Parameters

id

string · uuid · required

The ID of the label to invalidate

Invalidate a shipping label › Responses

Label invalidated successfully

No data returned

PUT/labels/{id}/invalidate

const options = {method: 'PUT'};

fetch('https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io//labels/:id/invalidate', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

No example specified for this content type

Get tracking number

GET

https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io

/labels/{id}/trackingnumber

Retrieves the tracking number associated with a shipping label.

Get tracking number › path Parameters

id

string · uuid · required

The ID of the shipping label

Get tracking number › query Parameters

format

string · enum

The format of the response

Enum values:

basic

detailed

carrier-specific

Default: basic

limit

integer · min: 1 · max: 100

Maximum number of tracking events to return

Default: 10

carrier

string · enum

Filter tracking information by specific carrier

Enum values:

UPS

USPS

FedEx

DHL

Default: null

events_since

string · date-time

Only return tracking events after this timestamp

sort

string · enum

Sort order for tracking events

Enum values:

newest_first

oldest_first

Default: newest_first

Get tracking number › Responses

Tracking number retrieved successfully

trackingNumber

string · required

carrier

string · required

trackingUrl

string · uri

GET/labels/{id}/trackingnumber

const options = {method: 'GET'};

fetch('https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io//labels/:id/trackingnumber', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "trackingNumber": "1Z999AA1234567890",
  "carrier": "UPS",
  "trackingUrl": "https://www.ups.com/track?tracknum=1Z999AA1234567890"
}

json

application/json

Get shipping label

GET

https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io

/labels/{id}

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

Get shipping label › path Parameters

id

string · uuid · required

The ID of the shipping label

Get shipping label › query Parameters

format

string · enum

The desired format of the label

Enum values:

PDF

PNG

ZPL

JPEG

TIFF

SVG

EPS

BMP

Default: PDF

Get shipping label › Responses

Label retrieved successfully

shipmentId

string · uuid · required

format

string · enum · required

Enum values:

PDF

PNG

ZPL

id

string · uuid · readOnly

size

string · enum

Enum values:

4x6

6x4

8.5x11

url

string · uri · readOnly

createdAt

string · date-time · readOnly

expiresAt

string · date-time · readOnly

GET/labels/{id}

const options = {method: 'GET'};

fetch('https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io//labels/:id', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "id": "987fcdeb-51a2-43f7-9876-543210abcdef",
  "shipmentId": "123e4567-e89b-12d3-a456-426614174000",
  "format": "PDF",
  "size": "4x6",
  "url": "https://assets.sh.example.com/labels/label-123456.pdf",
  "createdAt": "2025-01-09T12:00:00Z",
  "expiresAt": "2025-01-10T12:00:00Z"
}

json

application/json

Stamps