Skip to content

Add lockers to a network

Request

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

Security
ApiKeyAuth
Path
uidinteger, (int64)required

The unique identifier of the network.

Example:8065713862
Bodyapplication/jsonrequired
lockerUidsArray of integers, (int64)required

The list of locker UIDs to add to the network.

Example:
[
  10000019,
  10000020,
  10000021
]
curl -i -X POST \
  https://docs.glsnxt.com/_mock/openapi-carrier-integration-api/networks/8065713862/lockers \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "lockerUids": [
      10000019,
      10000020,
      10000021
    ]
  }'

Responses

List of newly added network lockers.

Bodyapplication/json
Array [
lockerUidinteger, (int64)required

The unique identifier of the locker.

Example:10000019
providerNamestringrequired

The name of the locker provider.

Example:"MYFLEXBOX_DE"
lockerNamestring

The carrier-assigned name for the locker.

Example:"Berlin Hauptbahnhof"
providerLockerStatusstringrequired

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

Example:"ACTIVE"
carrierLockerStatusstring

The status of the locker for the carrier.

Example:"ACTIVE"
networkLockerStatusstring

The status of the locker within the network.

Example:"PENDING"
carrierLockerIdstring

The carrier-specific locker identifier.

Example:"3001"
providerLockerIdstring

The provider-specific locker identifier.

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