# Get parcels

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


Endpoint: GET /parcels
Version: 1.1.0
Security: ApiKeyAuth

## Query parameters:

  - `ids` (string, required)
    Comma-separated list of parcel IDs to retrieve
    Example: "12345131,G6789011,A1234511"

## Response 200 fields (application/json):

  - `shipmentUid` (string)
    The unique identifier of the parcel shipment in the GLS/NXT Platform
    Example: "anyParcelId123"

  - `lockerUid` (string)
    The unique identifier of the locker in the GLS/NXT Platform
    Example: "anyLockerId123"

  - `carrierParcelId` (string)
    The identifier of the parcel in the carrier's system
    Example: "anyCarrierParcelId123"

  - `carrierLockerId` (string,null)
    The identifier of the locker in the carrier's system
    Example: "Locker1"

  - `shipmentType` (string)
    The type of shipment.
    Enum: "LAST_MILE", "ALTERNATIVE_DELIVERY", "FIRST_MILE", "RETURN"

  - `dimensionsStatus` (string)
    The status of the parcel dimensions.
    Enum: "PARCEL_DIMENSIONS_EXCEED", "PARCEL_DIMENSIONS_OK", "PARCEL_DIMENSIONS_UNKNOWN"

  - `shipmentStatus` (string)
    The status of the shipment.
    Enum: "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", "COLLECTION_NOT_POSSIBLE"

  - `accessCodes` (object,null)
    Access codes for the parcel

  - `accessCodes.consigneeCollectionCode` (object,null)
    The access code for the consignee collection

  - `accessCodes.consigneeCollectionCode.code` (string, required)
    Example: "anyValidCode123"

  - `accessCodes.consigneeCollectionCode.validUntil` (string)
    Code validity in UTC timestamp [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format.
    Example: "2025-01-27T12:00:00Z"

  - `accessCodes.consigneeCollection` (string)
    Example: "anyValidCode123"

  - `consignee` (object,null)
    The details of the consignee.

  - `consignee.name` (string,null)
    Example: "John Doe"

  - `consignee.email` (string,null)
    Example: "john.doe@google.com"

  - `events` (array)

  - `events.timestamp` (string)
    Example: "2025-08-20T00:00:00Z"

  - `events.eventType` (string)
    The status of the shipment.
    Enum: "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", "COLLECTION_NOT_POSSIBLE"

  - `allocationType` (string)
    The allocation type of the shipment.
    Enum: "HARD_RESERVATION", "SOFT_RESERVATION"

  - `shipmentSignature` (object)
    A Base64-encoded image representing the consignee's signature, captured upon parcel collection

  - `shipmentSignature.imageBase64` (string)
    Example: "imageBase64StringHere"

  - `shipmentSignature.format` (string)

## Response 400 fields (application/json):

  - `errorCode` (string)
    A code representing the type of error.
    Example: "INVALID_REQUEST"

  - `message` (string)
    A message describing the error.
    Example: "Bad request due to invalid input"

## Response 401 fields (application/json):

  - `errorCode` (string)
    A code representing the type of error.
    Example: "UNAUTHORIZED"

  - `message` (string)
    A message describing the error.
    Example: "The requested resource requires authentication"

## Response 404 fields (application/json):

  - `errorCode` (string)
    A code representing the type of error.
    Example: "NOT_FOUND"

  - `message` (string)
    A message describing the error.
    Example: "The requested resource was not found"

## Response 500 fields (application/json):

  - `errorCode` (string)
    A code representing the type of error.
    Example: "SERVER_ERROR"

  - `message` (string)
    A message describing the error.
    Example: "The server encountered an internal error"