Get Locker Bank by Locker Bank ID

Request

This API operation retrieves detailed information for the specified locker bank along with the list of locker units.

Security

bearerAuth

Path

lockerBankIdstringrequired

Filters the locker banks by the specific locker bank ID.

Example:AOne

curl -i -X GET \
  https://api-sandbox.sendpro360.pitneybowes.com/parcelpoint/api/v1/lockerBanks/AOne \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Specified locker bank details has been retrived successfully.

Bodyapplication/json

lockerBankIdstring

The unique identifier for the specified locker bank.

Example:"AOne"

bankNamestring

The given name to the locker bank to help identify the locker bank by users.

Example:"Locker One"

locationIdstring

The identifier of the location where the locker bank is installed.

Example:"loc_auto_sa5cxxx"

lockerBankDescriptionstring

A descriptive text about the specified locker bank.

Example:"Locker bank installed for parcel deliveries."

lastHeartbeatTimestring

The timestamp of the most recent heartbeat signal received from the locker bank, indicating its latest communication status.

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

rearLoadingEnabledboolean

Indicates if the locker bank is have rear loading enabled.

Example:true

deliveryEnabledboolean

Indicates whether the locker bank is currently in service and available for operations.

Example:true

assetEnabledboolean

Indicates whether asset support is enabled for the locker bank.

Example:true

lockerUnitsArray of objects(LockerUnit)

Response

{
  "lockerBankId": "AOne",
  "bankName": "Locker One",
  "locationId": "loc_auto_sa5cxxx",
  "lockerBankDescription": "Locker bank installed for parcel deliveries.",
  "lastHeartbeatTime": "2025-11-27T11:23:26Z",
  "rearLoadingEnabled": true,
  "deliveryEnabled": true,
  "assetEnabled": true,
  "lockerUnits": [
    {
      "lockerUnitId": "1",
      "size": "small",
      "accessible": false,
      "unitInService": true,
      "unitReserved": true,
      "unitOccupied": false,
      "depositTime": "2025-11-17T14:28:37Z",
      "depositExpiryTime": "2027-12-19T09:59:00Z",
      "reservationTime": "2025-11-26T10:34:30Z",
      "reservationExpiryTime": "2025-11-12T16:13:06Z",
      "transactionType": "deliver",
      "contactId": "684a6b7bbc85e1bce739xxxx",
      "contactType": "recipient",
      "contactName": "UserName",
      "depositorContactId": "684a6b7bbc85e1bxxxxxxxxx",
      "depositorContactType": "recipient",
      "parcelsReserved": [ … ],
      "parcelsDeposited": [ … ]
    }
  ]
}