Free a Reserved Locker Unit

Request

This API operation release a previously reserved locker unit or remove the reserved package based on the tracking number in the specified locker bank when the reservation needs to be released. Once the locker unit freed, the unit becomes available for new reservations.

Security

bearerAuth

Path

lockerBankIdstringrequired

The unique identifier of the locker bank where the locker unit is located. Retrieve this value using the Get Locker Banks API.

Example:AOne

lockerUnitIdstringrequired

The unique identifier of the locker unit to be freed within the specified locker bank.

Example:2

Bodyapplication/jsonrequired

Free a reserved locker number.

userIdstringrequired

The identifier of the user performing the locker unit free action.

Example:"ThirdParty"

parcelsArray of objects

The list of parcels associated with the locker being freed.

curl -i -X POST \
  https://api-dev.sendpro360.pitneycloud.com/lockers/api/v1/lockerBanks/AOne/lockers/2/free \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "ThirdParty",
    "parcels": [
      {
        "trackingNumber": "Dept03",
        "secondaryTrackingNumber": "TRACK-1234"
      }
    ]
  }'

Responses

The specified locker unit is freed successfully.

Bodyapplication/json

lockerBankIdstring

The unique identifier of the locker bank where the locker unit was freed.

Example:"AOne"

lockerUnitIdstring

The identifier of the locker unit that was freed.

Example:"2"

unitReservedboolean

Indicates whether the locker unit is reserved.

Example:true

contactIdstring

The identifier of the recipient associated with the locker reservation that was freed.

Example:"ThirdParty"

contactTypestring

The source type of the recipient identifier.

Enum:"recipient""department"

Example:"recipient"

parcelsReservedArray of objects

The list of parcels currently in reserved state for this locker unit. In case of no parcels in reserved state, no tracking number is returned.

Response

{
  "lockerBankId": "AOne",
  "lockerUnitId": "2",
  "unitReserved": true,
  "contactId": "ThirdParty",
  "contactType": "recipient",
  "parcelsReserved": [
    {
      "trackingNumber": "26112025_1",
      "secondaryTrackingNumber": "TRACK-1234"
    }
  ]
}