GLS/NXT OOH Platform Integration REST API

Locker Group API

Server

Download schema

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.

Get available locker group types

GET

https://api.staging.glsnxt.com/ooh/carrier-connector/v1

/locker-groups/types

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

Get available locker group types › Responses

List of locker group types retrieved successfully.

locker_group_type[]

A locker group type from the global catalog.

locker_group_type

key

string · required

The unique key identifying the locker group type.

category

string · required

The category the locker group type belongs to.

Get a list of locker groups

GET

https://api.staging.glsnxt.com/ooh/carrier-connector/v1

/locker-groups

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

Get a list of locker groups › query Parameters

lockerGroupTypeKeys

string[]

Filter locker groups by one or more type keys.

lockerGroupName

string

Filter locker groups by name.

Get a list of locker groups › Responses

List of locker groups retrieved successfully.

locker_group[]

A locker group owned by the carrier.

locker_group

key

string · required

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

category

string · required

The category the locker group type belongs to.

name

string · required

The name of the locker group.

uid

string

The unique identifier of the locker group.

Create a locker group

POST

https://api.staging.glsnxt.com/ooh/carrier-connector/v1

/locker-groups

Creates a new locker group for the carrier.

Create a locker group › Request Body

Request to create a locker group.

locker_group_create_request

typeKey

string · required

The locker group type key from the global catalog.

name

string · required

The name of the locker group.

Create a locker group › Responses

Locker group created successfully.

A locker group owned by the carrier.

locker_group

key

string · required

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

category

string · required

The category the locker group type belongs to.

name

string · required

The name of the locker group.

uid

string

The unique identifier of the locker group.

Get a specific locker group

GET

https://api.staging.glsnxt.com/ooh/carrier-connector/v1

/locker-groups/{uid}

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

Get a specific locker group › path Parameters

uid

integer · int64 · required

The unique identifier of the locker group.

Get a specific locker group › Responses

Locker group retrieved successfully.

A locker group owned by the carrier.

locker_group

key

string · required

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

category

string · required

The category the locker group type belongs to.

name

string · required

The name of the locker group.

uid

string

The unique identifier of the locker group.

Update a locker group

PATCH

https://api.staging.glsnxt.com/ooh/carrier-connector/v1

/locker-groups/{uid}

Updates the name of an existing locker group.

Update a locker group › path Parameters

uid

integer · int64 · required

The unique identifier of the locker group.

Update a locker group › Request Body

Request to update a locker group.

locker_group_update_request

name

string · required

The new name of the locker group.

Update a locker group › Responses

Locker group updated successfully.

A locker group owned by the carrier.

locker_group

key

string · required

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

category

string · required

The category the locker group type belongs to.

name

string · required

The name of the locker group.

uid

string

The unique identifier of the locker group.

Delete a locker group

DELETE

https://api.staging.glsnxt.com/ooh/carrier-connector/v1

/locker-groups/{uid}

Deletes a locker group owned by the carrier.

Delete a locker group › path Parameters

uid

integer · int64 · required

The unique identifier of the locker group.

Delete a locker group › Responses

Locker group deleted successfully.

No data returned

Assign lockers to a locker group

POST

https://api.staging.glsnxt.com/ooh/carrier-connector/v1

/locker-groups/{uid}/lockers

Assigns the carrier's lockers to the locker group. A locker may belong to at most one group per type key.

Assign lockers to a locker group › path Parameters

uid

integer · int64 · required

The unique identifier of the locker group.

Assign lockers to a locker group › Request Body

Request to assign lockers to a locker group.

locker_group_add_request

lockerUids

string[] · required

The UIDs of the lockers to assign to the group.

Assign lockers to a locker group › Responses

Lockers assigned to the group successfully.

The lockers that were assigned to the locker group.

locker_group_add_response

lockersAdded

string[] · required

The UIDs of the lockers that were assigned to the group.

Remove lockers from a locker group

DELETE

https://api.staging.glsnxt.com/ooh/carrier-connector/v1

/locker-groups/{uid}/lockers

Removes the specified lockers from the locker group.

Remove lockers from a locker group › path Parameters

uid

integer · int64 · required

The unique identifier of the locker group.

Remove lockers from a locker group › Request Body

Request to remove lockers from a locker group.

locker_group_remove_request

lockerUids

string[] · required

The UIDs of the lockers to remove from the group.

Remove lockers from a locker group › Responses

Lockers removed from the group successfully.

The lockers that were removed from the locker group.

locker_group_removed_response

lockersRemoved

string[] · required

The UIDs of the lockers that were removed from the group.

Locker API Network API