Get parcel details

GET /app/enduser/parcels/{parcelIds}
App key auth

Fetch connection and access details for specified parcel IDs. This endpoint allows end-users to retrieve detailed information about their parcels.

Path parameters

  • parcelIds string Required

    Comma-separated list of parcel IDs

Responses

  • 200 application/json

    Parcel details fetched successfully

    Hide response attributes Show response attributes object
    • externalLockerId string | null

      The unique identifier assigned by the carrier to the locker

    • providerLockerId string

      The unique identifier assigned by the provider to the locker

    • name string | null

      The name associated with the locker (if available)

    • hasScreen boolean

      Indicates if the locker has a screen or not

    • lockerModules array[object]
      Hide lockerModules attributes Show lockerModules attributes object
      • moduleId string | null

        UID of the locker module

      • lockerAccessCode string | null

        Access code for the locker

      • pickupParcels array[object]

        List of shipments available for pickup from the locker

        Information about shipments associated with the locker.

        Hide pickupParcels attributes Show pickupParcels attributes object
      • deliveryParcels array[object]

        List of shipments available for delivery to the locker

        Information about shipments associated with the locker.

        Hide deliveryParcels attributes Show deliveryParcels attributes object
  • 401 application/json

    Unauthorized. The request is missing valid authentication credentials.

    Hide response attribute Show response attribute object
    • error string

      Error message indicating lack of authorization
  • 400 application/json

    Bad Request. The request is malformed or missing required parameters.

    Hide response attribute Show response attribute object
    • error string

      Error message detailing the cause of the bad request
  • 404

    Parcel not found

  • 500 application/json

    Internal Server Error. An unexpected error occurred on the server.

    Hide response attribute Show response attribute object
    • error string

      Error message indicating an internal server error
GET /app/enduser/parcels/{parcelIds} 
curl \
 --request GET 'https://api.staging.glsnxt.com/ooh/carrier-connector/v1/app/enduser/parcels/{parcelIds}' \
 --header "X-APP-Key: $API_KEY"
Response examples (200) 
{
  "externalLockerId": "locker123",
  "providerLockerId": "providerLocker456",
  "name": "Main Street Locker",
  "hasScreen": true,
  "lockerModules": [
    {
      "moduleId": "module789",
      "lockerAccessCode": "123456",
      "pickupParcels": [
        {
          "parcelId": "parcel123",
          "allocationType": "HARD_RESERVATION",
          "shipmentType": "LAST_MILE",
          "compartmentAccessToken": "access123",
          "compartmentSenseToken": "sense456"
        }
      ],
      "deliveryParcels": [
        {
          "parcelId": "parcel123",
          "allocationType": "HARD_RESERVATION",
          "shipmentType": "LAST_MILE",
          "compartmentAccessToken": "access123",
          "compartmentSenseToken": "sense456"
        }
      ]
    }
  ]
}
Response examples (401) 
{
  "error": "Unauthorized"
}
Response examples (400) 
{
  "error": "Invalid request. Check parameters and try again."
}
Response examples (500) 
{
  "error": "Internal Server Error"
}