# Locker API

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.


## Create a new locker

 - [POST /lockers](https://docs.glsnxt.com/openapi-carrier-integration-api/locker-api/createlocker.md): Create a new locker with the specified details for the carrier, provider, location, and features.

## Get a list of lockers

 - [GET /lockers](https://docs.glsnxt.com/openapi-carrier-integration-api/locker-api/listlockers.md): Retrieve a list of lockers with optional filters such as location, status, carrier, and provider.

## Update a locker

 - [PATCH /lockers/{uid}](https://docs.glsnxt.com/openapi-carrier-integration-api/locker-api/updatelocker.md): Update the details of an existing locker, including carrier details, provider details, location, and features.

## Get lockers by UIDs

 - [GET /lockers/by-uid](https://docs.glsnxt.com/openapi-carrier-integration-api/locker-api/getlockersbyuids.md): 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.

## Get a list of existing locker model and locker version pairs for provider

 - [GET /lockers/providers](https://docs.glsnxt.com/openapi-carrier-integration-api/locker-api/listlockerproviders.md): Retrieve a list of existing locker model and locker version pairs for each provider.

## Update Locker Status

 - [PATCH /lockers/status](https://docs.glsnxt.com/openapi-carrier-integration-api/locker-api/updatelockerstatus.md): Update the status of an existing locker.