Get a list of locker groups

Request

Returns the carrier's locker groups, optionally filtered by type key and name.

Security

ApiKeyAuth

Query

lockerGroupTypeKeysArray of strings

Filter locker groups by one or more type keys.

Example:lockerGroupTypeKeys=DEPOT

lockerGroupNamestring

Filter locker groups by name.

Example:lockerGroupName=Berlin Central

curl -i -X GET \
  'https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/locker-groups?lockerGroupTypeKeys=DEPOT&lockerGroupName=Berlin%20Central' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of locker groups retrieved successfully.

Bodyapplication/json

Array [

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"
  }
]