Labels & Stamps API

Stamps (3.0.0)

Endpoint

Download schema

Endpoints for managing postage stamps. Stamps provide:

Proof of postage payment
Digital verification
Support for multiple output formats (PDF, PNG, ZPL)
24-hour validity period

Create a shipping stamp

POST

https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io

/stamps

Creates a new shipping stamp for a shipment.

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

Create a shipping stamp › Request Body

shipmentId

string · uuid · required

format

string · enum · required

Enum values:

PDF

PNG

ZPL

id

string · uuid · readOnly

url

string · uri · readOnly

createdAt

string · date-time · readOnly

expiresAt

string · date-time · readOnly

Create a shipping stamp › Responses

Stamp created successfully

shipmentId

string · uuid · required

format

string · enum · required

Enum values:

PDF

PNG

ZPL

id

string · uuid · readOnly

url

string · uri · readOnly

createdAt

string · date-time · readOnly

expiresAt

string · date-time · readOnly

POST/stamps

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

fetch('https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io//stamps', 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"
}

json

application/json

Example Responses

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

json

application/json

Invalidate a shipping stamp

PUT

https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io

/stamps/{id}/invalid

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

Invalidate a shipping stamp › path Parameters

id

string · uuid · required

The ID of the stamp to invalidate

Invalidate a shipping stamp › query Parameters

ids

string[] · required · style: form

The ID of the stamp to invalidate

Invalidate a shipping stamp › Responses

Stamp invalidated successfully

No data returned

PUT/stamps/{id}/invalid

const options = {method: 'PUT'};

fetch('https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io//stamps/:id/invalid?ids=%3Cvalue%3E', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

No example specified for this content type

Labels Other endpoints

Create a shipping stamp

POST

https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io

/stamps

Creates a new shipping stamp for a shipment.

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

Create a shipping stamp › Request Body

shipmentId

string · uuid · required

format

string · enum · required

Enum values:

PDF

PNG

ZPL

id

string · uuid · readOnly

url

string · uri · readOnly

createdAt

string · date-time · readOnly

expiresAt

string · date-time · readOnly

Create a shipping stamp › Responses

Stamp created successfully

shipmentId

string · uuid · required

format

string · enum · required

Enum values:

PDF

PNG

ZPL

id

string · uuid · readOnly

url

string · uri · readOnly

createdAt

string · date-time · readOnly

expiresAt

string · date-time · readOnly

const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: JSON.stringify({shipmentId: '123e4567-e89b-12d3-a456-426614174000', format: 'PDF'}) }; fetch('https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io//stamps', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));

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

Invalidate a shipping stamp

PUT

https://eedefc50718545d6b3a6cd7ea38faf06_oas.api.mockbin.io

/stamps/{id}/invalid

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

Invalidate a shipping stamp › path Parameters

id

string · uuid · required

The ID of the stamp to invalidate

Invalidate a shipping stamp › query Parameters

ids

string[] · required · style: form

The ID of the stamp to invalidate

Invalidate a shipping stamp › Responses

Stamp invalidated successfully

No data returned