Skip to content

Get a specific locker group

Request

Retrieve details of a specific locker group by its unique identifier.

Security
ApiKeyAuth
Path
uidinteger, (int64)required

The unique identifier of the locker group.

Example:6838265090
curl -i -X GET \
  https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/locker-groups/6838265090 \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Locker group retrieved successfully.

Bodyapplication/json
uidstring

The unique identifier of the locker group.

Example:"6838265090"
keystringrequired

The locker group type key. A locker may belong to at most one group per key.

Example:"DEPOT"
categorystringrequired

The category the locker group type belongs to.

Example:"DISTRIBUTION_CENTER"
namestringrequired

The name of the locker group.

Example:"Berlin Central"
Response
{
  "uid": "6838265090",
  "key": "DEPOT",
  "category": "DISTRIBUTION_CENTER",
  "name": "Berlin Central"
}