Get Reservation by Tracking Number

This API operation retrieves the reservation details for a specific parcel using its tracking number within the specified locker bank.

SecuritybearerAuth
Request
path Parameters
lockerBankId
required
string

The unique identifier of the locker bank from which the reservation information must be retrieved.

trackingNumber
required
string

The tracking number of the parcel whose reservation details are being requested.

query Parameters
isTrackNumUrlEncoded
boolean

Indicates whether the tracking number provided in the request is URL encoded.

includeAllParcels
boolean

When set to true, the response includes all tracking numbers currently assigned to the locker unit.

Responses
200

Reservation details for the specified tracking number has been fetched successfully.

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.

get/api/v1/lockerBanks/{lockerBankId}/lockers/reserved/{trackingNumber}
Request samples 
Response samples 
application/json
{
  • "lockerBankId": "AOne",
  • "lockerUnitId": "2",
  • "size": "small",
  • "accessible": true,
  • "unitInService": true,
  • "unitReserved": true,
  • "unitOccupied": true,
  • "parcelsReserved": [
    ],
  • "parcelsDeposited": [
    ],
  • "contactId": "684a6b7bbc85e1bce7392b9e",
  • "contactType": "recipient",
  • "contactName": "User Name",
  • "reservationTime": "2025-11-12T16:13:06Z",
  • "reservationExpiryTime": "2025-12-19T09:59:00Z",
  • "depositTime": "2025-11-17T14:28:37Z",
  • "depositExpiryTime": "2025-11-30T14:28:37Z"
}