Skip to content

Get lockers by UIDs

Request

Retrieve one or more lockers by their UIDs in a single request.

  • The ids query parameter accepts a comma-separated list of locker UIDs (e.g. ids=10000001,10000002).
  • Maximum 10 UIDs per request — exceeding the limit returns 400.
  • Returns 200 with a JSON array when at least one numeric UID is present; non-existent UIDs, UIDs belonging to other carriers, and non-numeric tokens within a mixed input are silently omitted.
  • Returns 400 when ids is missing, blank, or contains no numeric tokens.
Security
ApiKeyAuth
Query
idsstring, [ 1 .. 200 ] charactersrequired

Comma-separated locker UIDs. Up to 10 numeric UIDs per request. Non-numeric tokens within a mixed input are silently dropped before the cap check; an input with no numeric tokens at all returns 400.

Example:ids=10000001,10000002
curl -i -X GET \
  'https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/lockers/by-uid?ids=10000001%2C10000002' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of matching lockers retrieved successfully. Missing or inaccessible UIDs 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": [ … ]
  }
]