Create a locker group

Request

Creates a new locker group for the carrier.

Security

ApiKeyAuth

Bodyapplication/jsonrequired

typeKeystringrequired

The locker group type key from the global catalog.

Example:"DEPOT"

namestringrequired

The name of the locker group.

Example:"Berlin Central"

curl -i -X POST \
  https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/locker-groups \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "typeKey": "DEPOT",
    "name": "Berlin Central"
  }'

Responses

Locker group created 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"
}