Get locker unit status

Request

Retrieves the door status of a specific locker unit in the specified locker bank. Use this endpoint to check whether the locker unit door is open or closed after an open, deposit, pickup, return drop-off, or maintenance operation.
Note: This API returns a success response only when the locker hardware is configured.

Security

bearerAuth

Path

lockerBankIdstringrequired

The unique identifier of the locker bank where the locker unit is located.

Example:AOne

lockerUnitIdstringrequired

The unique identifier of the locker unit whose door status must be retrieved.

Example:2

curl -i -X GET \
  https://api-dev.sendpro360.pitneycloud.com/lockers/api/v1/lockerBanks/AOne/lockers/2/status \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Locker unit status retrieved successfully.

Bodyapplication/json

statusstring

The current door status of the specified locker unit. Expected values are 'open' or 'closed'.

Example:"closed"

Response

{
  "status": "closed"
}