Skip to content
Bookogsend / Developers
Esc
↑↓navigate↵open⌘Jpreview

List shipments

Lists shipments with stored prices and package tracking.

Permission

SHIPMENTS_READ

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

GET/shipments
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.

Query parameters
pageSizeinteger

Maximum records per page: 1–200, default 20. Results are newest first.

min 1 · max 200 · default: 20
cursorstring

Copy nextCursor from the previous response to fetch the next page. Keep the same filters; omit for the first page.

min length 1
statusstring | string[]

Filter by shipment status. Repeat the status query parameter to include multiple statuses. Omit to include all statuses.

customerReferencestring

Exact customer-reference match, including an empty string. Omit to disable this filter.

createdFromstring<date-time>

Inclusive creation-time lower bound as an RFC 3339 timestamp with seconds and a timezone, for example 2030-01-01T00:00:00+01:00.

matches T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$
createdTostring<date-time>

Exclusive creation-time upper bound as an RFC 3339 timestamp with seconds and a timezone. Must not precede createdFrom.

matches T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$
Responses
200

Successful result

successanyrequired
messagestringrequired
dataobjectrequired
Show properties
shipmentsShipment[]
Show properties
Array of Shipment
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
packagesobject[]required
Show properties
Array of object
idstringrequired
typestringrequired
trackingNumberstring | anyrequired
Show properties
Any of:
string
string
any
any
nationalTrackingNumberstring | anyrequired
Show properties
Any of:
string
string
any
any
deliveryStatusstringrequired
labelReadybooleanrequired
nextCursorstring | null
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" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "success": true,
  "message": "Shipments retrieved.",
  "data": {
    "shipments": [],
    "nextCursor": null
  },
  "requestId": "<request-id>"
}