GLS/NXT OOH Platform Integration REST API

Network API

Server

The Network API endpoints provide management of locker networks, enabling carriers to share lockers between network owners and tenants. These endpoints support:

Network Listing: View all networks where the carrier is the owner or tenant.
Network Locker Management: Add, remove, and update lockers within a network.
Paginated Locker Retrieval: Retrieve lockers in a network with filtering and pagination.

Key Features:

Locker Sharing: Share lockers between carriers through networks.
Status Management: Track and update locker status within networks (e.g., PENDING, ACCEPTED, DECLINED).
Carrier Details: Optionally update carrier-specific details when managing network lockers.

Get a list of networks

GET

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

/networks

Returns all networks where the carrier is the owner or tenant.

Get a list of networks › Responses

List of networks retrieved successfully.

network[]

A network connecting a locker owner carrier with a tenant carrier.

network

uid

integer · int64 · required

The unique identifier of the network.

ownedBy

string · required

The carrier that owns the network.

tenant

string · required

The carrier that is the tenant of the network.

autoShare

boolean · required

When true, new lockers owned by this carrier are automatically added to the network.

Get a specific network

GET

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

/networks/{uid}

Retrieve details of a specific network by its unique identifier.

Get a specific network › path Parameters

uid

integer · int64 · required

The unique identifier of the network.

Get a specific network › Responses

Network retrieved successfully.

A network connecting a locker owner carrier with a tenant carrier.

network

uid

integer · int64 · required

The unique identifier of the network.

ownedBy

string · required

The carrier that owns the network.

tenant

string · required

The carrier that is the tenant of the network.

autoShare

boolean · required

When true, new lockers owned by this carrier are automatically added to the network.

Delete a network

DELETE

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

/networks/{uid}

Deletes a network. Fails if any lockers are still in ACCEPTED status.

Delete a network › path Parameters

uid

integer · int64 · required

The unique identifier of the network.

Delete a network › Responses

Network deleted successfully. The response has no body.

No data returned

Get lockers in a network

GET

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

/networks/{uid}/lockers

Retrieve a paginated list of lockers within a network with optional filtering and sorting.

Get lockers in a network › path Parameters

uid

integer · int64 · required

The unique identifier of the network.

Get lockers in a network › query Parameters

networkLockerStatus

string

Filter lockers by their network status.

page

integer · int32

The page number to retrieve (1-based).

Default: 1

pageSize

integer · int32

The number of items per page.

Default: 100

sortBy

string

The field to sort results by.

sortDirection

string

The sort direction.

Default: ASC

Get lockers in a network › Responses

Paginated list of network lockers retrieved successfully.

A paginated list of network lockers.

network_locker_page

network_locker[] · required

The list of network lockers for the current page.

pageNumber

integer · int32 · required

The current page number (1-based).

pageSize

integer · int32 · required

The number of items per page.

totalElements

integer · int64 · required

The total number of lockers across all pages.

isLast

boolean · required

Whether this is the last page.

Add lockers to a network

POST

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

/networks/{uid}/lockers

Adds lockers owned by the carrier to the network. Lockers not owned by the carrier are silently skipped.

Add lockers to a network › path Parameters

uid

integer · int64 · required

The unique identifier of the network.

Add lockers to a network › Request Body

Request to add lockers to a network.

network_locker_add_request

lockerUids

integer[] · required

The list of locker UIDs to add to the network.

Add lockers to a network › Responses

List of newly added network lockers.

network_locker[]

A locker within a network, including its status from the provider, carrier, and network perspectives.

network_locker

lockerUid

integer · int64 · required

The unique identifier of the locker.

providerName

string · required

The name of the locker provider.

providerLockerStatus

string · required

The current status of the locker on the provider's side.

lockerName

string | null

The carrier-assigned name for the locker.

carrierLockerStatus

string | null

The status of the locker for the carrier.

networkLockerStatus

string | null

The status of the locker within the network.

carrierLockerId

string | null

The carrier-specific locker identifier.

providerLockerId

string | null

The provider-specific locker identifier.

Remove lockers from a network

DELETE

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

/networks/{uid}/lockers

Removes the specified lockers from the network.

Remove lockers from a network › path Parameters

uid

integer · int64 · required

The unique identifier of the network.

Remove lockers from a network › Request Body

Request to remove lockers from a network.

network_locker_remove_request

lockerUids

integer[] · required

The list of locker UIDs to remove from the network.

Remove lockers from a network › Responses

List of removed network lockers.

network_locker[]

A locker within a network, including its status from the provider, carrier, and network perspectives.

network_locker

lockerUid

integer · int64 · required

The unique identifier of the locker.

providerName

string · required

The name of the locker provider.

providerLockerStatus

string · required

The current status of the locker on the provider's side.

lockerName

string | null

The carrier-assigned name for the locker.

carrierLockerStatus

string | null

The status of the locker for the carrier.

networkLockerStatus

string | null

The status of the locker within the network.

carrierLockerId

string | null

The carrier-specific locker identifier.

providerLockerId

string | null

The provider-specific locker identifier.

Update a network locker

PATCH

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

/networks/{uid}/lockers/{lockerUid}

Updates the status of a locker within a network, optionally including carrier details.

Update a network locker › path Parameters

uid

integer · int64 · required

The unique identifier of the network.

lockerUid

integer · int64 · required

The unique identifier of the locker within the network.

Update a network locker › Request Body

Request to update the status of a locker within a network, optionally including carrier details.

network_locker_patch

networkLockerStatus

string · required

The new status for the network locker.

carrier_update

Optional carrier details to update for a network locker.

Update a network locker › Responses

Network locker updated successfully.

A locker within a network, including its status from the provider, carrier, and network perspectives.

network_locker

lockerUid

integer · int64 · required

The unique identifier of the locker.

providerName

string · required

The name of the locker provider.

providerLockerStatus

string · required

The current status of the locker on the provider's side.

lockerName

string | null

The carrier-assigned name for the locker.

carrierLockerStatus

string | null

The status of the locker for the carrier.

networkLockerStatus

string | null

The status of the locker within the network.

carrierLockerId

string | null

The carrier-specific locker identifier.

providerLockerId

string | null

The provider-specific locker identifier.

PATCH/networks/{uid}/lockers/{lockerUid}

curl https://api.staging.glsnxt.com/ooh/carrier-connector/v1/networks/:uid/lockers/:lockerUid \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "networkLockerStatus": "ACCEPTED",
  "carrier": {
    "lockerName": "Berlin Locker 01",
    "lockerId": "XR1003",
    "activationDate": "2025-08-20T00:00:00Z"
  }
}'

Example Request Body

{
  "networkLockerStatus": "ACCEPTED",
  "carrier": {
    "lockerName": "Berlin Locker 01",
    "lockerId": "XR1003",
    "activationDate": "2025-08-20T00:00:00Z"
  }
}

json

Example Responses

{
  "lockerUid": 10000019,
  "providerName": "MYFLEXBOX_DE",
  "lockerName": "Berlin Hauptbahnhof",
  "providerLockerStatus": "ACTIVE",
  "carrierLockerStatus": "ACTIVE",
  "networkLockerStatus": "PENDING",
  "carrierLockerId": "3001",
  "providerLockerId": "68958"
}

json

application/json

Locker Group API Parcel API