Skip to content
Pitney Locker APIs
/
/Locker Bank

Locker Bank

APIs for retrieving and managing locker bank information. Locker banks represent physical installations of smart lockers at specific locations. These APIs support operations such as listing available locker banks, retrieving locker bank details, and fetching available locker unit sizes within a bank. The returned lockerBankId is required for all subsequent locker unit operations.

Operations

Get List of all Locker Banks

Request

This API operation returns a list of all available locker banks where packages can be deposited for recipient pickup.

Security
bearerAuth
Query
skipinteger

The number of records to skip in the returned list. Default is 0.

Example:skip=0
limitinteger

The maximum number of locker banks to return in the response. Default is 100.

Example:limit=100
locationIdstring

Filters the locker banks by the specific location ID where the lockers are placed.

Example:locationId=loc_auto_sa5cxxx
lockerBankIdstring

Filters the locker banks by the specific locker bank ID.

Example:lockerBankId=AOne
Headers
X-PB-Developer-Partner-IDstring

The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required.

Example:PB123456
curl -i -X GET \
  'https://api-dev.sendpro360.pitneycloud.com/parcelpoint/api/v1/lockerBanks?skip=0&limit=100&locationId=loc_auto_sa5cxxx&lockerBankId=AOne' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-PB-Developer-Partner-ID: PB123456'

Responses

Successfully retrieved the list of locker banks.

Bodyapplication/json
Array [
lockerBankIdstring

The identifier for the locker bank used by the APIs.

Example:"AOne"
bankNamestring

The display name of the locker bank for user reference.

Example:"Locker One"
locationIdstring

The identifier of the location where the locker bank is placed

Example:"loc_auto_sa5cxxx"
lastHeartbeatTimestring, (date-time)

The timestamp of the most recent heartbeat signal received from the locker bank. This value helps determine if the locker bank is online and communicating with the system.

Example:"2025-11-27T11:23:26Z"
rearLoadingEnabledboolean

Indicates whether the locker bank supports rear-side loading, allowing mailroom operators to place parcels into the lockers from the back of the unit.

Example:true
deliveryEnabledboolean

Indicates whether the locker bank is currently active and available for delivery operations. If set to false, the locker bank is out of service.

Example:true
assetEnabledboolean

Indicates whether the locker bank supports return functionality.

Example:true
]
Response
[
  {
    "lockerBankId": "AOne",
    "bankName": "Locker One",
    "locationId": "loc_auto_sa5cxxx",
    "lastHeartbeatTime": "2025-11-27T11:23:26Z",
    "rearLoadingEnabled": true,
    "deliveryEnabled": true,
    "assetEnabled": true
  }
]