Get locker details

GET /app/courier/lockers/{lockerUid}
App key auth

Fetch connection and access details for a specific locker including parcels available for pickup and delivery. This endpoint provides essential information for couriers to manage lockers efficiently.

Path parameters

  • lockerUid string Required

    The Locker UID

Query parameters

  • weekdays integer

    Duration in weekdays for fetching session details (between 4 and 10).

    Minimum value is 4, maximum value is 10.

Responses

  • 200 application/json

    Locker 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

    • location object

      Geographic location details of a locker

      Hide location attributes Show location attributes object
      • street string
      • streetNumber string
      • postalCode string
      • city string
      • lon number(double)
      • lat number(double)
      • countryCode string
      • locationCode string | null
    • 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
        • parcelId string

          The unique identifier assigned by the carrier to the shipment

        • allocationType string

          The type of allocation for the shipment

        • shipmentType string

          The type of the shipment

        • compartmentAccessToken string | null

          Access token to open the compartment of the locker

        • compartmentSenseToken string | null

          Sense token to get events from the compartment of the locker

      • 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
        • parcelId string

          The unique identifier assigned by the carrier to the shipment

        • allocationType string

          The type of allocation for the shipment

        • shipmentType string

          The type of the shipment

        • compartmentAccessToken string | null

          Access token to open the compartment of the locker

        • compartmentSenseToken string | null

          Sense token to get events from the compartment of the locker
  • 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

    Locker 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/courier/lockers/{lockerUid} 
curl \
 --request GET 'https://api.glsnxt.com/ooh/carrier-connector/v1/app/courier/lockers/{lockerUid}' \
 --header "X-APP-Key: $API_KEY"
Response examples (200) 
{
  "externalLockerId": "locker123",
  "providerLockerId": "providerLocker456",
  "name": "Main Street Locker",
  "hasScreen": true,
  "location": {
    "street": "Main Street",
    "streetNumber": "123",
    "postalCode": "12345",
    "city": "Berlin",
    "lon": 13.4051,
    "lat": 22.5201,
    "countryCode": "DE",
    "locationCode": "LOC123"
  },
  "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"
}