Developers
API referenceBusiness sign in

Labels

Issue the first label

POST/shipments/{shipmentId}/labels

Scope labels.writeLIVE keys onlyIdempotency-Key required

Send an empty JSON body. Later calls return the existing label with replayed: true.

Request

Headers

Request headers
NameInTypeDescription
AuthorizationRequiredheaderstringBearer <API key>
Idempotency-KeyRequiredheaderstring8–160 characters (A-Z, a-z, 0-9, . _ : -). Retrying with the same key and body returns the original result; another body returns 409. See Idempotency.Pattern ^[A-Za-z0-9._:-]{8,160}$

Path parameters

Path parameters
NameInTypeDescription
shipmentIdRequiredpathstringPattern ^(?:QD-SHP-[A-F0-9]{24}|QDSHP[A-Z0-9]{3,31}|QD-TST-[A-F0-9]{24}|QDTST[A-Z0-9]{3,31})$

Send an empty JSON object ({}) as the body.

Response

Success responses
StatusMeaning
200Existing label
201Issued

The body is { "status": "success", "data": … }. Fields of data (LabelResult):

Response data
FieldTypeDescription
labelRequiredobject
public_idRequiredstringLabel IDPattern ^(?:QD-LBL-[A-F0-9]{24}|QDLBL[A-Z0-9]{3,31})$
version_numberRequiredinteger
replayedRequiredboolean

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

Error responses
StatusWhen
400The request is not valid. A field is missing or invalid, or the Idempotency-Key header is missing or malformed.
401Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked.
403The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED).
404Not found for this Business and environment. IDs from another Business or environment are always 404. Not found for this Business and environment. IDs from another Business or the other environment are always 404.
409Idempotency key reused with another body, or the resource changed state. The idempotency key was used with a different body, a reference is already taken, or the resource changed state.
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.