Get shipment details

Retrieves shipment status, stored details, package tracking, and label readiness.

Behavior

Reads do not reprice the shipment. Saved-address updates do not change its snapshots.
A FAILED shipment includes a failure code and message.
Read this endpoint after booking to observe background progress.

Permission

SHIPMENTS_READ

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

GET/shipments/{id}

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

200

Successful result

successanyrequired

messagestringrequired

dataobjectrequired

Show properties

idstringrequired

statusstringrequired

Allowed:PENDINGPROCESSINGBOOKEDPICKED_UPDELIVEREDCANCELEDFAILED

serviceCodestringrequired

createdAtstring<date-time>required

pickupDatestringrequired

customerReferencestring | anyrequired

Show properties

Any of:

string

string

any

any

pricePricerequired

Show properties

currencystringrequired

baseAmountstringrequired

surchargeAmountstringrequired

palletExchangeAmountstringrequired

taxAmountstringrequired

totalAmountstringrequired

packagesShipmentPackage[]required

Show properties

Array of ShipmentPackage

idstringrequired

typestringrequired

trackingNumberstring | anyrequired

Show properties

Any of:

string

string

any

any

nationalTrackingNumberstring | anyrequired

Show properties

Any of:

string

string

any

any

deliveryStatusstringrequired

weightnumberrequired

lengthnumber | anyrequired

Show properties

Any of:

number

number

any

any

widthnumber | anyrequired

Show properties

Any of:

number

number

any

any

heightnumber | anyrequired

Show properties

Any of:

number

number

any

any

descriptionstring | anyrequired

Show properties

Any of:

string

string

any

any

hasDgbooleanrequired

dgobject | anyrequired

Show properties

Any of:

object

hazardClassstringrequired

unNumberstringrequired

properShippingNamestringrequired

weightnumberrequired

packingGroupstringrequired

flashPointstring | anyrequired

Show properties

Any of:

string

string

any

any

technicalNamestring | anyrequired

Show properties

Any of:

string

string

any

any

marinePollutantstring | anyrequired

Show properties

Any of:

string

string

any

any

any

any

labelReadybooleanrequired

senderAddress

Show properties

namestringrequired

Person or company name. Required and nonempty after trimming; see maxLength. Shipment services may impose a lower name limit.

min length 1 · max length 40

street1stringrequired

Primary street address, including house number. Required and nonempty after trimming; see maxLength and service fieldLimits.

min length 1 · max length 54

street2string | any

Optional additional address line. Omit or send null to clear it; see maxLength and service fieldLimits.

default: null

Show properties

Any of:

string

string

any

any

citystringrequired

Town or city. Required and nonempty after trimming; see maxLength.

min length 1 · max length 30

zipstringrequired

Postal code as text, preserving leading zeros. It must match the country for carrier shipments; see maxLength.

min length 1 · max length 10

countrystringrequired

Supported country code in two-letter uppercase ISO format, such as DK. The country and service must have an available route and price.

matches ^[A-Z]{2}$

addressTypestringrequired

RESIDENTIAL for a private address or COMMERCIAL for a business address.

Allowed:RESIDENTIALCOMMERCIAL

regionstring | any

Optional state, province, or region as text. Omit or send null to clear it.

default: null

Show properties

Any of:

string

string

any

any

attentionstring | any

Optional contact person or attention line. Omit or send null to clear it; see maxLength.

default: null

Show properties

Any of:

string

string

any

any

emailstring<email> | any

Valid contact email address, or null. Required for a shipment receiver when GET /services reports receiverEmailRequired.

default: null

Show properties

Any of:

string<email>

string<email>

any

any

phonestring | any

Telephone number in international E.164 format, such as +4512345678, or null. Required for a shipment receiver when receiverPhoneRequired is true.

default: null

Show properties

Any of:

string

string

any

any

mobilestring | any

Mobile number in international E.164 format, such as +4512345678, or null. Required for a shipment receiver when receiverMobileRequired is true.

default: null

Show properties

Any of:

string

string

any

any

receiverAddress

Show properties

namestringrequired

Person or company name. Required and nonempty after trimming; see maxLength. Shipment services may impose a lower name limit.

min length 1 · max length 40

street1stringrequired

Primary street address, including house number. Required and nonempty after trimming; see maxLength and service fieldLimits.

min length 1 · max length 54

street2string | any

Optional additional address line. Omit or send null to clear it; see maxLength and service fieldLimits.

default: null

Show properties

Any of:

string

string

any

any

citystringrequired

Town or city. Required and nonempty after trimming; see maxLength.

min length 1 · max length 30

zipstringrequired

Postal code as text, preserving leading zeros. It must match the country for carrier shipments; see maxLength.

min length 1 · max length 10

countrystringrequired

Supported country code in two-letter uppercase ISO format, such as DK. The country and service must have an available route and price.

matches ^[A-Z]{2}$

addressTypestringrequired

RESIDENTIAL for a private address or COMMERCIAL for a business address.

Allowed:RESIDENTIALCOMMERCIAL

regionstring | any

Optional state, province, or region as text. Omit or send null to clear it.

default: null

Show properties

Any of:

string

string

any

any

attentionstring | any

Optional contact person or attention line. Omit or send null to clear it; see maxLength.

default: null

Show properties

Any of:

string

string

any

any

emailstring<email> | any

Valid contact email address, or null. Required for a shipment receiver when GET /services reports receiverEmailRequired.

default: null

Show properties

Any of:

string<email>

string<email>

any

any

phonestring | any

Telephone number in international E.164 format, such as +4512345678, or null. Required for a shipment receiver when receiverPhoneRequired is true.

default: null

Show properties

Any of:

string

string

any

any

mobilestring | any

Mobile number in international E.164 format, such as +4512345678, or null. Required for a shipment receiver when receiverMobileRequired is true.

default: null

Show properties

Any of:

string

string

any

any

deliveryNotestring | null

failureobject | null

Show properties

codeany

Allowed:INVALID_ZIPCODEINVALID_SHIPMENT_DATEUNKNOWN_PROVIDER_ERROR

messagestring

requestIdstringrequired

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

Request

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

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

Response

{
  "success": true,
  "message": "Shipment retrieved.",
  "data": {
    "id": "<shipment-id>",
    "status": "PENDING",
    "serviceCode": "BUSINESS_PARCEL",
    "createdAt": "2030-01-01T10:00:00.000Z",
    "pickupDate": "2030-01-15",
    "customerReference": null,
    "deliveryNote": null,
    "sender": {
      "name": "Example Company",
      "street1": "Østerbrogade 1",
      "city": "København Ø",
      "zip": "2100",
      "country": "DK",
      "addressType": "COMMERCIAL",
      "street2": null,
      "region": null,
      "attention": null,
      "email": null,
      "phone": null,
      "mobile": null
    },
    "receiver": {
      "name": "Example Company",
      "street1": "Østerbrogade 1",
      "city": "København Ø",
      "zip": "2100",
      "country": "DK",
      "addressType": "COMMERCIAL",
      "street2": null,
      "region": null,
      "attention": null,
      "email": null,
      "phone": null,
      "mobile": null
    },
    "price": {
      "currency": "DKK",
      "baseAmount": "100.00",
      "surchargeAmount": "0.00",
      "palletExchangeAmount": "0.00",
      "taxAmount": "25.00",
      "totalAmount": "125.00"
    },
    "packages": [
      {
        "type": "BUSINESS_PARCEL",
        "weight": 1,
        "length": 30,
        "width": 20,
        "height": 10,
        "hasDg": false,
        "id": "<package-id>",
        "description": null,
        "dg": null,
        "trackingNumber": null,
        "nationalTrackingNumber": null,
        "deliveryStatus": "PENDING"
      }
    ],
    "labelReady": false,
    "failure": null
  },
  "requestId": "<request-id>"
}

{
  "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
}