Skip to content

Get a list of lockers

Request

Retrieve a list of lockers with optional filters such as location, status, carrier, and provider.

Security
ApiKeyAuth
Query
providerNamestring

Filter lockers by provider name.

Example:providerName=BLOQ
statusstring(status)

Filter lockers by status.

Enum:"ACTIVE""INACTIVE""MAINTENANCE""DECOMMISSIONED"
Example:status=ACTIVE
citystring

Filter lockers by city.

Example:city=Berlin
countryCodestring

Filter lockers by country code (ISO 3166-1 alpha-2).

Example:countryCode=DE
compartmentSizestring(compartment_size)

Filter lockers by the size of compartments available.

Enum:"XXSMALL""XSMALL""SMALL""XMEDIUM""MEDIUM""LARGE""XLARGE""XXLARGE""ULARGE""UULARGE"
Example:compartmentSize=MEDIUM
curl -i -X GET \
  'https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/lockers?providerName=BLOQ&status=ACTIVE&city=Berlin&countryCode=DE&compartmentSize=MEDIUM' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of lockers retrieved successfully.

Bodyapplication/json
Array [
uidstring

The internal unique identifier assigned to the locker.

Example:"1002377838"
carrierobject(carrier)

The details of the locker on the Carrier's system.

providerobject(provider)

The details of the locker on the Provider's system.

locationobject(location)

Details about the geographical location of the locker.

featuresobject(features)

Features available in the locker.

openingHoursobject(opening_hours)

Locker availability schedule.

Conditional constraints (enforced server-side, not by the generated client):

  • If accessMode is SCHEDULED, weeklySchedule MUST be provided and non-empty.
  • If accessMode is ALWAYS, weeklySchedule MUST be omitted.
metadataArray of objects(metadata)

Additional metadata associated with the locker.

ownedByCarrierstring or null

Indicates which carrier owns the locker. null means the locker belongs to a 3rd party provider.

Example:"GLS"
compartmentTypesArray of objects or null(compartment)

A list of different compartment types available in the locker.

Example:
[
  {
    "size": "SMALL",
    "count": 10,
    "height": 200,
    "width": 400,
    "length": 600
  },
  {
    "size": "MEDIUM",
    "count": 4,
    "height": 400,
    "width": 400,
    "length": 600
  },
  {
    "size": "LARGE",
    "count": 2,
    "height": 800,
    "width": 400,
    "length": 600
  }
]
]
Response
[
  {
    "uid": "1002377838",
    "carrier": { … },
    "provider": { … },
    "location": { … },
    "features": { … },
    "openingHours": { … },
    "metadata": [ … ],
    "ownedByCarrier": "GLS",
    "compartmentTypes": [ … ]
  }
]