Create a return reservation

Pitney Locker APIs

Locker APIs

Create a return reservation

Request

Creates a locker reservation for a return or asset drop-off. Use this endpoint when the depositor needs to place a package or asset into a locker for pickup by a courier, or operations team. The reservation details include the intended receiving contact (e.g., store or department) and the depositor contact (e.g., customer or recipient) who will drop off the package or asset. Once the reservation is created, the depositor can use the provided locker unit information to complete the return drop-off, and the receiving contact can retrieve the item from the locker for processing.

Security

bearerAuth

Path

lockerBankIdstringrequired

The unique identifier of the locker bank where the return locker is reserved.

Example:AOne

Bodyapplication/jsonrequired

Return reservation details, including the intended receiving contact and the depositor contact who will drop off the package or asset.

userIdstringrequired

The identifier of the user performing the reservation action.

Example:"user@gmail.com"

sizestringrequired

The size of the locker unit required for the return or asset drop-off.

Example:"small"

accessibleboolean

Indicates whether an accessible locker unit is required.

Example:true

contactIdstringrequired

The identifier of the contact or department that will receive the returned package or asset.

Example:"684a6b7bbc85e1bce739xxxx"

contactTypestringrequired

The type of contact that will receive the returned package or asset.

Enum:"recipient""department"

depositorContactIdstringrequired

The identifier of the person or contact in the address book who will deposit the returned package or asset into the locker.

Example:"684a6b7bbc85e1bxxxxxxxxx"

depositorContactTypestringrequired

The type of contact who will deposit the returned package or asset.

Enum:"recipient""department"

trackingNumberstringrequired

The primary tracking number or identifier for the returned package or asset.

Example:"TrackigID137"

secondaryTrackingNumberstring

The secondary tracking number or additional identifier for the returned package or asset.

Example:"TRACK-1234"

reservationExpiryTimestring, (date-time)

The date and time when the reservation expires.

Example:"2027-12-01T00:00:00Z"

curl -i -X POST \
  https://api-sandbox.sendpro360.pitneybowes.com/parcelpoint/api/v1/lockerBanks/AOne/lockers/asset/reserve \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "user@gmail.com",
    "size": "small",
    "accessible": true,
    "contactId": "684a6b7bbc85e1bce739xxxx",
    "contactType": "recipient",
    "depositorContactId": "684a6b7bbc85e1bxxxxxxxxx",
    "depositorContactType": "recipient",
    "trackingNumber": "TrackigID137",
    "secondaryTrackingNumber": "TRACK-1234",
    "reservationExpiryTime": "2027-12-01T00:00:00Z"
  }'

Responses

Return reservation created successfully.

Bodyapplication/json

lockerBankIdstring

The unique identifier of the locker bank.

Example:"AOne"

lockerUnitIdstring

The locker unit reserved for the return or asset drop-off.

Example:"2"

sizestring

The size of the reserved locker unit.

Example:"small"

contactIdstring

The identifier of the contact or department that will receive the returned package or asset.

Example:"684a6b7bbc85e1bce739xxxx"

contactTypestring

The type of contact that will receive the returned package or asset.

Enum:"recipient""department"

depositorContactIdstring

The identifier of the person or contact in the address book who will deposit the returned package or asset .

Example:"684a6b7bbc85e1bxxxxxxxxx"

depositorContactTypestring

The type of contact who will deposit the returned package or asset.

Enum:"recipient""department"

depositorAccessCodestring

The access code given to the depositor to open the locker and drop off the package or asset.

Example:"NR8PBW"

trackingNumberstring

The primary tracking number or identifier for the returned package or asset.

Example:"TrackigID137"

reservationExpiryTimestring, (date-time)

The date and time when the reservation expires.

Example:"2027-12-01T00:00:00Z"

Response

{
  "lockerBankId": "AOne",
  "lockerUnitId": "2",
  "size": "small",
  "contactId": "684a6b7bbc85e1bce739xxxx",
  "contactType": "recipient",
  "depositorContactId": "684a6b7bbc85e1bxxxxxxxxx",
  "depositorContactType": "recipient",
  "depositorAccessCode": "NR8PBW",
  "trackingNumber": "TrackigID137",
  "reservationExpiryTime": "2027-12-01T00:00:00Z"
}