Skip to content

Locker Group API

The Locker Group API endpoints let carriers organise their lockers into named, typed groups. These endpoints support:

  • Type Catalog: Retrieve the global catalog of available locker group types.
  • Group Management: Create, rename, retrieve, list, and delete locker groups.
  • Locker Assignment: Assign and remove the carrier's lockers to and from a group.

Key Features:

  • Typed Groups: Each group has a type from the shared catalog; a locker may belong to at most one group per type key.
  • Carrier-scoped: Groups and their lockers are scoped to the calling carrier.
Operations

Get available locker group types

Request

Returns the global catalog of locker group types that can be used to create locker groups.

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

Responses

List of locker group types retrieved successfully.

Bodyapplication/json
Array [
keystringrequired

The unique key identifying the locker group type.

Example:"DEPOT"
categorystringrequired

The category the locker group type belongs to.

Example:"DISTRIBUTION_CENTER"
]
Response
[
  {
    "key": "DEPOT",
    "category": "DISTRIBUTION_CENTER"
  }
]