Skip to content

Network API

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.
Operations

Get a list of networks

Request

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

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

Responses

List of networks retrieved successfully.

Bodyapplication/json
Array [
uidinteger, (int64)required

The unique identifier of the network.

Example:8065713862
ownedBystringrequired

The carrier that owns the network.

Example:"GLS_NXT"
tenantstringrequired

The carrier that is the tenant of the network.

Example:"GLS_DE"
autoSharebooleanrequired

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

Example:false
]
Response
[
  {
    "uid": 8065713862,
    "ownedBy": "GLS_NXT",
    "tenant": "GLS_DE",
    "autoShare": false
  }
]