Open a locker unit

Request

Opens a specific locker unit remotely in the specified locker bank. Use this endpoint when an authorized user needs to unlock a locker unit for package deposit or return drop-off. 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 to open.

Example:2

Bodyapplication/jsonrequired

Open locker request details, including the user performing the action.

userIdstringrequired

The identifier of the person or system user in the address book performing the open locker action.

Example:"user@gmail.com"

curl -i -X POST \
  https://api-sandbox.sendpro360.pitneybowes.com/parcelpoint/api/v1/lockerBanks/AOne/lockers/2/open \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "user@gmail.com"
  }'

Responses

Locker unit opened successfully.

Bodyapplication/json

lockerBankIdstring

The unique identifier of the locker bank.

Example:"AOne"

lockerUnitIdstring

The unique identifier of the locker unit that was opened.

Example:"2"

contactIdstring

The identifier of the contact associated with the locker reservation, if available.

Example:"684a6b7bbc85e1bce739xxxx"

contactTypestring

The type of contact associated with the locker reservation.

Enum:"recipient""department"

activityTypestring

The activity for which the locker unit was opened.

Enum:"deposit""pickup""maintenance"

parcelsReservedArray of objects(Parcel)

The list of parcels reserved in the locker unit, if any.

parcelsDepositedArray of objects(Parcel)

The list of parcels deposited in the locker unit, if any.

Response

{
  "lockerBankId": "AOne",
  "lockerUnitId": "2",
  "contactId": "684a6b7bbc85e1bce739xxxx",
  "contactType": "recipient",
  "activityType": "deposit",
  "parcelsReserved": [
    {
      "trackingNumber": "26112025_6",
      "secondaryTrackingNumber": "TRACK-1234"
    }
  ],
  "parcelsDeposited": [
    {
      "trackingNumber": "26112025_6",
      "secondaryTrackingNumber": "TRACK-1234"
    }
  ]
}