Skip to main content

Labels

Purchase a Label​

Use a selected returned Rate identifier with Create a Label. See Select a Rate for the application-owned step that precedes this state-changing request. The current request shape uses rate.id:

{
  "rate": {
    "id": "<selected Rate identifier>"
  }
}

On a successful result, postageLabel.id is the returned Label identifier. For the complete request and response schemas, see the API Reference.

After a timeout or lost response, resend the same purchase request or read the Order: a repeat of the same request is recognized server-side and replays its outcome instead of buying a second Label. See Buy a Label.

Download a Label​

Use Download a Label as the documented retrieval workflow. A 200 response has a binary body for application/pdf or application/zpl. The format value selects PDF (1) or a ZPL printer resolution — 300 DPI (2), 203 DPI (3), or 600 DPI (4).

A 202 response means only that the requested label file is pending or still being generated. See the API Reference and Label Errors for documented 404, 409, and 500 behavior. For status-aware binary handling, see Download a Label.

Cancel a Label​

Use Cancel a Label. The operation returns a JSON result containing data.isSuccess. For request handling and public boundaries, see Cancel a Label.

Boundaries​

This page does not define a Label business-state machine or a recovery workflow. The complete API contract remains in the API Reference.