The Locker API endpoints provide comprehensive management of lockers, including their creation, updating, and retrieval. These endpoints support:
- Locker Creation: Set up new lockers with necessary details such as location, internal carrier IDs, and specific locker features.
- Locker Information Retrieval: Access detailed information about lockers, including their status and location.
- Locker Updates: Update existing locker details to reflect changes in status or configuration.
Key Features:
- Flexible Locker Management: Create and update lockers to keep information current and accurate.
- Detailed Location Data: Access geographic and logistical details of each locker.
- Compartment Management: Manage the availability and allocation of compartments within lockers.
Get a list of lockers
Retrieve a list of lockers with optional filters such as location, status, carrier, and provider.
query Parameters
providerNameFilter lockers by provider name.
statusFilter lockers by status.
cityFilter lockers by city.
countryCodeFilter lockers by country code (ISO 3166-1 alpha-2).
compartmentSizeFilter lockers by the size of compartments available.
Locker compartment size.
ownedByWhen true, return only the lockers that the carrier owns.
Get a list of lockers › Responses
List of lockers retrieved successfully.
uidThe internal unique identifier assigned to the locker.
The details of the locker on the Carrier's system.
The details of the locker on the Provider's system.
Details about the geographical location of the locker.
Features available in the locker. null when the locker has no feature data.
Locker availability schedule.
Conditional constraints (enforced server-side, not by the generated client):
- If
accessModeisSCHEDULED,weeklyScheduleMUST be provided and non-empty. - If
accessModeisALWAYS,weeklyScheduleMUST be omitted.
Additional metadata associated with the locker. null when the carrier locker has none.
ownedByCarrierIndicates which carrier owns the locker. null means the locker belongs to a 3rd party provider.
A list of different compartment types available in the locker.
Create a new locker
Create a new locker with the specified details for the carrier, provider, location, and features.
Create a new locker › Request Body
The carrier's details for the locker. Requests use these fields in addition to the shared carrier fields.
The provider's details for the locker. Requests use these fields in addition to the shared provider fields.
Details about the geographical location of the locker.
Additional metadata associated with the locker.
Features available in the locker.
Locker groups to assign, identified by key and uid; at most one per type key.
Create a new locker › Responses
Locker created successfully.
uidThe internal unique identifier assigned to the locker.
The details of the locker on the Carrier's system.
The details of the locker on the Provider's system.
Details about the geographical location of the locker.
Features available in the locker. null when the locker has no feature data.
Locker availability schedule.
Conditional constraints (enforced server-side, not by the generated client):
- If
accessModeisSCHEDULED,weeklyScheduleMUST be provided and non-empty. - If
accessModeisALWAYS,weeklyScheduleMUST be omitted.
Additional metadata associated with the locker. null when the carrier locker has none.
ownedByCarrierIndicates which carrier owns the locker. null means the locker belongs to a 3rd party provider.
A list of different compartment types available in the locker.
Update a locker
Update the details of an existing locker, including carrier details, provider details, location, and features.
path Parameters
uidThe OOH Platform UID for the locker.
Update a locker › Request Body
The carrier's details for the locker. Requests use these fields in addition to the shared carrier fields.
Details about the geographical location of the locker.
Additional metadata associated with the locker.
Features available in the locker.
Locker groups to assign, identified by key and uid; at most one per type key. Omit to leave current groups unchanged.
The provider fields a locker update can change.
Update a locker › Responses
Locker updated successfully.
uidThe internal unique identifier assigned to the locker.
The details of the locker on the Carrier's system.
The details of the locker on the Provider's system.
Details about the geographical location of the locker.
Features available in the locker. null when the locker has no feature data.
Locker availability schedule.
Conditional constraints (enforced server-side, not by the generated client):
- If
accessModeisSCHEDULED,weeklyScheduleMUST be provided and non-empty. - If
accessModeisALWAYS,weeklyScheduleMUST be omitted.
Additional metadata associated with the locker. null when the carrier locker has none.
ownedByCarrierIndicates which carrier owns the locker. null means the locker belongs to a 3rd party provider.
A list of different compartment types available in the locker.
Get lockers by UIDs
Retrieve one or more lockers by their UIDs in a single request.
- The
idsquery 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
idsis missing, blank, or contains no numeric tokens.
query Parameters
idsComma-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.
Get lockers by UIDs › Responses
List of matching lockers retrieved successfully. Missing or inaccessible UIDs are silently omitted.
uidThe internal unique identifier assigned to the locker.
The details of the locker on the Carrier's system.
The details of the locker on the Provider's system.
Details about the geographical location of the locker.
Features available in the locker. null when the locker has no feature data.
Locker availability schedule.
Conditional constraints (enforced server-side, not by the generated client):
- If
accessModeisSCHEDULED,weeklyScheduleMUST be provided and non-empty. - If
accessModeisALWAYS,weeklyScheduleMUST be omitted.
Additional metadata associated with the locker. null when the carrier locker has none.
ownedByCarrierIndicates which carrier owns the locker. null means the locker belongs to a 3rd party provider.
A list of different compartment types available in the locker.
Get lockers by carrier locker ids
Retrieve one or more lockers by their carrier locker ids in a single request.
- The
idsquery 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-uidcannot 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
idsis missing, blank, or contains no non-empty tokens.
query Parameters
idsComma-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.
Get lockers by carrier locker ids › Responses
List of matching lockers retrieved successfully. Missing or inaccessible carrier locker ids are silently omitted.
uidThe internal unique identifier assigned to the locker.
The details of the locker on the Carrier's system.
The details of the locker on the Provider's system.
Details about the geographical location of the locker.
Features available in the locker. null when the locker has no feature data.
Locker availability schedule.
Conditional constraints (enforced server-side, not by the generated client):
- If
accessModeisSCHEDULED,weeklyScheduleMUST be provided and non-empty. - If
accessModeisALWAYS,weeklyScheduleMUST be omitted.
Additional metadata associated with the locker. null when the carrier locker has none.
ownedByCarrierIndicates which carrier owns the locker. null means the locker belongs to a 3rd party provider.
A list of different compartment types available in the locker.
Get a list of existing locker model and locker version pairs for provider
Retrieve a list of existing locker model and locker version pairs for each provider.
Get a list of existing locker model and locker version pairs for provider › Responses
List of existing locker model and locker version pairs for each provider retrieved successfully.
providerNameThe name of the locker provider.
lockerModelThe model of the locker provided by the provider.
lockerVersionThe version of the locker model provided by the provider.
providerUidThe unique identifier of the provider on the GLS/NXT system.
Update Locker Status
Update the status of an existing locker.
Update Locker Status › Request Body
lockerUidThe unique identifier of the locker in the GLS/NXT Platform
statusUpdate Locker Status › Responses
Locker status updated successfully.