Get parcels

GET /parcels

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

Query parameters

ids string Required

Comma-separated list of parcel IDs to retrieve

Responses

200 application/json

Parcels fetched successfully
Hide response attributes Show response attributes object
- shipmentUid string
  
  The unique identifier of the parcel shipment in the GLS/NXT Platform
- lockerUid string
  
  The unique identifier of the locker in the GLS/NXT Platform
- carrierParcelId string
  
  The identifier of the parcel in the carrier's system
- carrierLockerId string | null
  
  The identifier of the locker in the carrier's system
- shipmentType string
  
  The type of shipment.
  
  Values are LAST_MILE, ALTERNATIVE_DELIVERY, FIRST_MILE, or RETURN.
- dimensionsStatus string
  
  The status of the parcel dimensions.
  
  Values are PARCEL_DIMENSIONS_EXCEED, PARCEL_DIMENSIONS_OK, or PARCEL_DIMENSIONS_UNKNOWN.
- shipmentStatus string
  
  The status of the shipment.
  
  Values are BOOKING_PRE_CHECK, BOOKING_REQUESTED, BOOKING_CREATED, BOOKING_CANCELLED, BOOKING_REJECTED_INVALID_LOCKER, BOOKING_REJECTED_PROVIDER_ERROR, BOOKING_REJECTED_LOCKER_UNAVAILABLE, BOOKING_REJECTED_DIMENSIONS_EXCEED, BOOKING_REJECTED_INVALID_CONSIGNEE, COURIER_DELIVERED, COURIER_DELIVERY_EXPIRED, COURIER_DELIVERY_LABEL_SCANNED, COURIER_COLLECTED, COURIER_COLLECTED_EXPIRED, COURIER_COLLECTION_LABEL_SCANNED, COURIER_COLLECTION_LABEL_NOT_AVAILABLE, CONSIGNEE_COLLECTED, CONSIGNEE_DELIVERED, CONSIGNEE_DELIVERY_EXPIRED, CONSIGNEE_COLLECTION_EXPIRED, DELIVERY_PARCEL_TOO_BIG, DELIVERY_COMPARTMENT_BROKEN, DELIVERY_COMPARTMENT_OCCUPIED, DELIVERY_NOT_POSSIBLE, COLLECTION_PARCEL_NOT_AVAILABLE, COLLECTION_COMPARTMENT_BROKEN, or COLLECTION_NOT_POSSIBLE.
- accessCodes object | null
  
  Access codes for the parcel
  
  Hide accessCodes attributes Show accessCodes attributes object | null
  
  consigneeCollection string Deprecated
  
  consigneeCollectionCode object | null
  
  Access codes with valid until timestamp.
  
  Hide consigneeCollectionCode attributes Show consigneeCollectionCode attributes object | null
  
  code string Required
  
  validUntil string(date-time)
  
  Code validity in UTC timestamp ISO 8601 format.
- consignee object | null
  
  The details of the consignee.
  
  Hide consignee attributes Show consignee attributes object | null
  
  name string | null
  
  email string | null
- events array[object]
  
  Hide events attributes Show events attributes object
  
  timestamp string(date-time)
  
  eventType string
  
  The status of the shipment.
  
  Values are BOOKING_PRE_CHECK, BOOKING_REQUESTED, BOOKING_CREATED, BOOKING_CANCELLED, BOOKING_REJECTED_INVALID_LOCKER, BOOKING_REJECTED_PROVIDER_ERROR, BOOKING_REJECTED_LOCKER_UNAVAILABLE, BOOKING_REJECTED_DIMENSIONS_EXCEED, BOOKING_REJECTED_INVALID_CONSIGNEE, COURIER_DELIVERED, COURIER_DELIVERY_EXPIRED, COURIER_DELIVERY_LABEL_SCANNED, COURIER_COLLECTED, COURIER_COLLECTED_EXPIRED, COURIER_COLLECTION_LABEL_SCANNED, COURIER_COLLECTION_LABEL_NOT_AVAILABLE, CONSIGNEE_COLLECTED, CONSIGNEE_DELIVERED, CONSIGNEE_DELIVERY_EXPIRED, CONSIGNEE_COLLECTION_EXPIRED, DELIVERY_PARCEL_TOO_BIG, DELIVERY_COMPARTMENT_BROKEN, DELIVERY_COMPARTMENT_OCCUPIED, DELIVERY_NOT_POSSIBLE, COLLECTION_PARCEL_NOT_AVAILABLE, COLLECTION_COMPARTMENT_BROKEN, or COLLECTION_NOT_POSSIBLE.
- allocationType string
  
  The allocation type of the shipment.
  
  Values are HARD_RESERVATION or SOFT_RESERVATION.
400 application/json

Bad request due to invalid input.
Hide response attributes Show response attributes object
- errorCode string
  
  A code representing the type of error.
- message string
  
  A message describing the error.
401 application/json

The requested resource requires authentication.
Hide response attributes Show response attributes object
- errorCode string
  
  A code representing the type of error.
- message string
  
  A message describing the error.
404 application/json

The requested resource was not found.
Hide response attributes Show response attributes object
- errorCode string
  
  A code representing the type of error.
- message string
  
  A message describing the error.
500 application/json

The server encountered an internal error.
Hide response attributes Show response attributes object
- errorCode string
  
  A code representing the type of error.
- message string
  
  A message describing the error.

GET /parcels

curl \
 --request GET 'https://api.staging.glsnxt.com/ooh/carrier-connector/v1/parcels?ids=12345%2CG67890%2CA12345' \
 --header "X-API-Key: $API_KEY"

Response examples (200)

[
  {
    "shipmentUid": "anyParcelId123",
    "lockerUid": "anyLockerId123",
    "carrierParcelId": "anyCarrierParcelId123",
    "carrierLockerId": "Locker1",
    "shipmentType": "LAST_MILE",
    "dimensionsStatus": "PARCEL_DIMENSIONS_OK",
    "shipmentStatus": "BOOKING_PRE_CHECK",
    "accessCodes": {
      "consigneeCollection": "anyValidCode123",
      "consigneeCollectionCode": {
        "code": "anyValidCode123",
        "validUntil": "2025-01-27T12:00:00Z"
      }
    },
    "consignee": {
      "name": "John Doe",
      "email": "john.doe@google.com"
    },
    "events": [
      {
        "timestamp": "2025-08-20T00:00:00Z",
        "eventType": "BOOKING_PRE_CHECK"
      }
    ],
    "allocationType": "HARD_RESERVATION"
  }
]

Response examples (400)

{
  "errorCode": "INVALID_REQUEST",
  "message": "Bad request due to invalid input"
}

Response examples (401)

{
  "errorCode": "UNAUTHORIZED",
  "message": "The requested resource requires authentication"
}

Response examples (404)

{
  "errorCode": "NOT_FOUND",
  "message": "The requested resource was not found"
}

Response examples (500)

{
  "errorCode": "SERVER_ERROR",
  "message": "The server encountered an internal error"
}