Labels
Download a label PDF
GET/shipments/{shipmentId}/labels/{labelId}.pdf
Scope labels.readLIVE keys only
Download a label PDF
Request
Path parameters
| Name | In | Type | Description |
|---|---|---|---|
shipmentIdRequired | path | string | Pattern ^(?:QD-SHP-[A-F0-9]{24}|QDSHP[A-Z0-9]{3,31}|QD-TST-[A-F0-9]{24}|QDTST[A-Z0-9]{3,31})$ |
labelIdRequired | path | string | Pattern ^(?:QD-LBL-[A-F0-9]{24}|QDLBL[A-Z0-9]{3,31})$ |
Query parameters
| Name | In | Type | Description |
|---|---|---|---|
formatOptional | query | string | a6 (default) or a4 (A6 centred on A4).One of a6, a4 |
Response
| Status | Meaning |
|---|---|
200 |
The body is the PDF file (application/pdf).
Errors
Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.
| Status | When |
|---|---|
400 | The request is not valid. A field is missing or invalid, or the Idempotency-Key header is missing or malformed. |
401 | Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked. |
403 | The 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). |
404 | Not 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. |
429 | Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key. |