Free a Reserved Locker Unit

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.

SecuritybearerAuth
Request
path Parameters
lockerBankId
required
string

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

lockerUnitId
required
string

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

Request Body schema: application/json

Free a reserved locker number.

userId
required
string

Identifier of the user performing the locker unit free action.

Array of objects

List of parcels associated with the locker being freed.

Responses
200

The specified locker unit is freed successfully.

400

Invalid request.

401

The request could not be authorized.

404

The requested resource was not found.

500

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

post/api/v1/lockerBanks/{lockerBankId}/lockers/{lockerUnitId}/free
Request samples
application/json
{
  • "userId": "ThirdParty",
  • "parcels": [
    ]
}
Response samples
application/json
{
  • "lockerBankId": "Axxx",
  • "lockerUnitId": "2",
  • "unitReserved": true,
  • "contactId": "ThirdParty",
  • "contactType": "recipient",
  • "parcelsReserved": [
    ]
}