Get list of all locker banks

Returns a list of all available locker banks where packages can be deposited for recipient pickup.

SecuritybearerAuth
Request
query Parameters
skip
integer

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

Example: skip=0
limit
integer

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

Example: limit=100
locationId
string

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

Example: locationId=locationId=loc_auto_sa5c8e6
lockerBankId
string

Filters the locker banks by the specific locker bank ID.

Example: lockerBankId=lockerBankId=000123
header Parameters
X-PB-Developer-Partner-ID
string

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.

Responses
200

Successfully retrieved the list of locker banks.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

get/api/v1/lockerBanks
Request samples 
Response samples 
application/json
[
  • {
    }
]