Download shipment label

Downloads the shipment’s existing PDF label through a signed URL.

Prerequisites

The service must support printable labels.
The shipment must be BOOKED, PICKED_UP, or DELIVERED.
A PDF label must already exist.

Behavior

Follow the 302 Location redirect. The URL expires after five minutes; request a fresh URL when needed.
This endpoint does not book shipments or regenerate labels.
labelReady indicates lifecycle readiness. It does not check whether the PDF exists.
409 LABEL_NOT_READY means the shipment or PDF is not ready. 400 LABEL_NOT_SUPPORTED means the service has no printable label.

Permission

SHIPMENTS_READ

See Troubleshooting for authentication, access, rate-limit, and service errors.

GET/shipments/{id}/label

Authorization

AuthorizationBearer token · headerrequired

Required header: Authorization: Bearer <customer-api-key>. Use a Customer API key with the operation's required permission. Never use a dashboard or webshop token.

Path parameters

idstringrequired

ID of the shipment. Obtain it from a list or create response. Unavailable IDs return 404.

min length 1

Responses

302

Redirect to the existing PDF label. Signed URL expires after five minutes; fetch a fresh URL rather than storing it.

400

Invalid input or unsupported operation.

successanyrequired

messagestringrequired

dataanyrequired

requestIdstringrequired

errorCodestringrequired

errorsobject | anyrequired

Show properties

Any of:

object

fieldsobject[]

Show properties

Array of object

pathstringrequired

errorCodestringrequired

messagestringrequired

pricePrice

Show properties

currencystringrequired

baseAmountstringrequired

surchargeAmountstringrequired

palletExchangeAmountstringrequired

taxAmountstringrequired

totalAmountstringrequired

currentStatusstring

retryAfterSecondsinteger

min 1

any

any

404

Resource does not exist or belongs to another account.

successanyrequired

messagestringrequired

dataanyrequired

requestIdstringrequired

errorCodestringrequired

errorsobject | anyrequired

Show properties

Any of:

object

fieldsobject[]

Show properties

Array of object

pathstringrequired

errorCodestringrequired

messagestringrequired

pricePrice

Show properties

currencystringrequired

baseAmountstringrequired

surchargeAmountstringrequired

palletExchangeAmountstringrequired

taxAmountstringrequired

totalAmountstringrequired

currentStatusstring

retryAfterSecondsinteger

min 1

any

any

409

Label is not ready or its PDF does not exist.

successanyrequired

messagestringrequired

dataanyrequired

requestIdstringrequired

errorCodestringrequired

errorsobject | anyrequired

Show properties

Any of:

object

fieldsobject[]

Show properties

Array of object

pathstringrequired

errorCodestringrequired

messagestringrequired

pricePrice

Show properties

currencystringrequired

baseAmountstringrequired

surchargeAmountstringrequired

palletExchangeAmountstringrequired

taxAmountstringrequired

totalAmountstringrequired

currentStatusstring

retryAfterSecondsinteger

min 1

any

any

Request

curl -X GET "https://bookogsend.dk/api/v1/customer/shipments/%3Cshipment-id%3E/label" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://bookogsend.dk/api/v1/customer/shipments/%3Cshipment-id%3E/label", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Response

Redirect to the existing PDF label. Signed URL expires after five minutes; fetch a fresh URL rather than storing it.

{
  "success": false,
  "message": "Invalid input or unsupported operation.",
  "data": null,
  "requestId": "request-id",
  "errorCode": "BAD_REQUEST",
  "errors": null
}

{
  "success": false,
  "message": "Resource does not exist or belongs to another account.",
  "data": null,
  "requestId": "request-id",
  "errorCode": "NOT_FOUND",
  "errors": null
}

{
  "success": false,
  "message": "The shipment label is not ready.",
  "data": null,
  "requestId": "<request-id>",
  "errorCode": "LABEL_NOT_READY",
  "errors": null
}