Skip to content

Get parcels (v2)

Request

Retrieve a paginated list of parcels associated with the carrier, filterable by locker and/or parcel IDs.

  • At least one of lockerId, carrierLockerId or ids must be provided.
  • When more than one filter is given, the result is the intersection of all provided filters.
  • By default this endpoint returns parcels regardless of status — both active bookings and completed/final parcels linked to the locker. Pass isFinal to narrow the result to open (false) or finalized (true) parcels.
Security
ApiKeyAuth
Query
lockerIdstring

The platform locker UID to filter by. At least one of lockerId, carrierLockerId or ids is required.

Example:lockerId=anyLockerId123
carrierLockerIdstring

The carrier's own locker identifier to filter by. At least one of lockerId, carrierLockerId or ids is required.

Example:carrierLockerId=2760935259
idsstring

Comma-separated list of parcel IDs to filter by. At least one of lockerId, carrierLockerId or ids is required.

Example:ids=12345131,G6789011,A1234511
isFinalboolean

Optional finality filter. When omitted, no status filter is applied (all statuses). true returns only finalized parcels, false returns only open ones. Must be lowercase true or false.

Example:isFinal=false
pageinteger, (int32)

The page number to retrieve (1-based).

Default:1
Example:page=1
pageSizeinteger, (int32), <= 100

The number of items per page. Maximum 100.

Default:30
Example:pageSize=30
curl -i -X GET \
  'https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/v2/parcels?lockerId=anyLockerId123&carrierLockerId=2760935259&ids=12345131%2CG6789011%2CA1234511&isFinal=false&page=1&pageSize=30' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Parcels fetched successfully

Bodyapplication/json
contentArray of objects(parcel_response)required

The list of parcels for the current page.

pageNumberinteger, (int32)required

The current page number (1-based).

Example:1
pageSizeinteger, (int32)required

The number of items per page.

Example:30
isLastbooleanrequired

Whether this is the last page.

Example:true
Response
{
  "content": [
    { … }
  ],
  "pageNumber": 1,
  "pageSize": 30,
  "isLast": true
}