Skip to content

Get lockers by carrier locker ids

Request

Retrieve one or more lockers by their carrier locker ids in a single request.

  • The ids query parameter accepts a comma-separated list of carrier locker ids (e.g. ids=DE46677,DE12345).
  • Carrier locker ids are alphanumeric and kept as-is — this is exactly the case /lockers/by-uid cannot handle.
  • Maximum 10 ids per request — exceeding the limit returns 400.
  • Returns 200 with a JSON array; non-existent ids and ids belonging to other carriers are silently omitted.
  • Returns 400 when ids is missing, blank, or contains no non-empty tokens.
Security
ApiKeyAuth
Query
idsstring, [ 1 .. 200 ] charactersrequired

Comma-separated carrier locker ids. Up to 10 ids per request. Empty tokens are dropped before the cap check; an input with no non-empty tokens returns 400.

Example:ids=DE46677,DE12345
curl -i -X GET \
  'https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/lockers/by-carrier-locker-id?ids=DE46677%2CDE12345' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of matching lockers retrieved successfully. Missing or inaccessible carrier locker ids are silently omitted.

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": [ … ]
  }
]