Skip to content

Get parcels

Request

Retrieve a list of parcels associated with the carrier. This endpoint allows fetching detailed information about parcels, including their status and history.

Security
ApiKeyAuth
Query
idsstringrequired

Comma-separated list of parcel IDs to retrieve

Example:ids=12345131,G6789011,A1234511
curl -i -X GET \
  'https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/parcels?ids=12345131%2CG6789011%2CA1234511' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Parcels fetched successfully

Bodyapplication/json
Array [
shipmentUidstring

The unique identifier of the parcel shipment in the GLS/NXT Platform

Example:"anyParcelId123"
lockerUidstring

The unique identifier of the locker in the GLS/NXT Platform

Example:"anyLockerId123"
carrierParcelIdstring

The identifier of the parcel in the carrier's system

Example:"anyCarrierParcelId123"
carrierLockerIdstring or null

The identifier of the locker in the carrier's system

Example:"Locker1"
shipmentTypestring(shipment_type)

The type of shipment.

Enum:"LAST_MILE""ALTERNATIVE_DELIVERY""FIRST_MILE""RETURN"
Example:"LAST_MILE"
dimensionsStatusstring(dimensions_status)

The status of the parcel dimensions.

Enum:"PARCEL_DIMENSIONS_EXCEED""PARCEL_DIMENSIONS_OK""PARCEL_DIMENSIONS_UNKNOWN"
Example:"PARCEL_DIMENSIONS_OK"
shipmentStatusstring(shipment_status)

The status of the shipment.

Enum:"BOOKING_PRE_CHECK""BOOKING_REQUESTED""BOOKING_CREATED""BOOKING_CANCELLED""BOOKING_CANCELLATION_FAILED""BOOKING_EXPIRED""BOOKING_REJECTED_INVALID_LOCKER""BOOKING_REJECTED_PROVIDER_ERROR""BOOKING_REJECTED_LOCKER_IS_FULL""BOOKING_REJECTED_NO_FREE_FITTING_COMPARTMENT"
Example:"CONSIGNEE_COLLECTED"
isFinalboolean
Example:true
accessCodesobject or null(access_codes)

Access codes for the parcel

consigneeobject or null(consignee)

The details of the consignee.

eventsArray of objects(parcel_events)
allocationTypestring(allocation_type)

The allocation type of the shipment.

Enum:"HARD_RESERVATION""SOFT_RESERVATION"
Example:"HARD_RESERVATION"
providerNamestring or null

The name of the locker network provider

Example:"LOCKY_PT"
providerLockerIdstring or null

The identifier of the locker in the provider's system

Example:"1178"
shipmentSignatureobject(signature)

A Base64-encoded image representing the consignee's signature, captured upon parcel collection

requiresAccessibleCompartmentboolean
Example:true
labelTypestring

Label mode for the shipment. LABELLESS means no printed label is used and LABELED means a printed label is used.

Enum:"LABELLESS""LABELED"
Example:"LABELLESS"
referenceCodestring

Reference code scanned by driver during pickup of the labelless parcel. This field is only relevant for LABELLESS shipments.

Example:"LBL000000018"
secondaryShipmentIdstring or null

A secondary identifier for the shipment, separate from carrierParcelId.

Example:"EXP-CODE-0001"
]
Response
[
  {
    "shipmentUid": "anyParcelId123",
    "lockerUid": "anyLockerId123",
    "carrierParcelId": "anyCarrierParcelId123",
    "carrierLockerId": "Locker1",
    "shipmentType": "LAST_MILE",
    "dimensionsStatus": "PARCEL_DIMENSIONS_OK",
    "shipmentStatus": "CONSIGNEE_COLLECTED",
    "isFinal": true,
    "accessCodes": { … },
    "consignee": { … },
    "events": [ … ],
    "allocationType": "HARD_RESERVATION",
    "providerName": "LOCKY_PT",
    "providerLockerId": "1178",
    "shipmentSignature": { … },
    "requiresAccessibleCompartment": true,
    "labelType": "LABELLESS",
    "referenceCode": "LBL000000018",
    "secondaryShipmentId": "EXP-CODE-0001"
  }
]