Pitney Locker APIs (1.0.0)

The Pitney Locker APIs help manage smart locker operations for package delivery, returns, and asset drop-off workflows. These APIs allow external organizations to automate secure, contactless locker operations by integrating with Pitney Bowes smart lockers.

By integrating these APIs into your system, you can automate end-to-end locker workflows—from retrieving available locker banks and reserving locker units to remotely opening lockers, depositing packages, retrieving reservation details and releasing locker units after use .

Why Use Pitney Locker APIs

• Enable contactless, secure package deliveries

• Automate locker assignment and release

• Support forward delivery and return/drop-off workflows

• Track which locker unit is assigned to which package

• Simplify mailroom or internal delivery operations

• Retrieve locker availability and locker status information

How Pitney Locker APIs Work

The Pitney Locker APIs are designed to manage smart locker workflows—from retrieving available locker banks and reserving locker units to depositing packages and freeing locker units after completion.

The APIs support two primary workflows:

• Forward delivery workflow (transactionType: deliver)
• Return or asset drop-off workflow (transactionType: return)

A user (typically a mailroom operator or system) can use these APIs to:

1. Look up locker banks
2. Check available locker unit sizes
3. Reserve locker units
4. Open locker units remotely
5. Deposit packages into locker units
6. Retrieve reservation details
7. Free locker units after use
8. Monitor locker unit operational status

Step-by-Step Workflow for Pitney Locker APIs

Step 1: Retrieve Available Locker Banks

Use the Get Locker Banks or Get Locker Bank by Locker Bank ID APIs to retrieve the list of available locker banks at a facility. Filter by:

• locationId: To get lockers for a specific location

• lockerBankId: To retrieve a specific locker bank by ID. One location can have multiple banks.

• Each locker bank has a unique lockerBankId, used in subsequent API calls.

Step 2: Get Locker Sizes for a Locker Bank

Use the Get Locker Sizes API to retrieve the available locker unit sizes in a locker bank (e.g., small, medium, large) along with their availability status.

• You need to pass the lockerBankId retrieved in Step 1 as a path parameter.

Step 3: Reserve a Locker Unit

Once you know a locker unit is available, use the Reserve Locker Unit API to create a reservation. This workflow is typically used for forward delivery operations and internally uses transactionType: deliver

Required fields include:

• lockerBankId (path parameter)

• Package tracking number

• Locker size preference (e.g., small)

• Recipient identification (contact ID and type)

• Reservation Expiry Time

If a locker is successfully reserved, a locker unit ID will be returned in the response.

Return and Asset Drop-off Reservations

For return or asset drop-off workflows, use the Create Return Reservation API.

This workflow uses transactionType: return

In this workflow a depositor places a package or asset into a locker. 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.

The reservation can include:

• Receiving contact information
• Depositor contact information
• Tracking details
• Reservation expiry information

Step 4: Open a Locker Unit

Use the Open Locker Unit API to remotely unlock a locker unit before package deposit or return drop-off operations. This API is used by mailroom operators or authorized users to open the locker unit door for secure, contactless package handling.

Step 5: Add or Update Deposit Information

After reserving the locker unit, deposit the parcel inside the locker using Add/Update Deposit API. Using the same API, user can update the deposit information for example userId of the user.

This updates the locker reservation to reflect:

• Parcel successfully deposited
• Deposit timestamp
• depositExpiryTime (Once expired, the parcel may be removed or handled according to facility policy.)
• Parcel pickup code (Pickup Code will only be provided to the contactType: recipient. For contactType: department the recipients will pick the parcel by providing their personalId)

You need to pass:

• lockerBankId (path parameter)

• lockerUnitId (path parameter)

Step 6: Retrieve Reservation Details

These APIs help external systems, operators, or recipients retrieve reservation details.

• Get Reservations by Contact: Retrieve all reservations linked to a specific recipient/contact.
• Get Reservation by Tracking Number: Retrieve reservation details using the package tracking number.

Step 7: Update Reservation

If reservation details need to be changed (e.g., expiry time, contact details, metadata), use the Update Reservation API.

You need to pass:

• lockerBankId (path parameter)

• lockerUnitId (path parameter)

Step 7: Free the Reserved Locker Unit

Use the Free Reserved Locker Unit API to cancel the existing reservation. This makes the locker unit available for the next package.

You need to pass:

• lockerBankId (path parameter)

• unit to be freed - lockerUnitId (path parameter)

Note: Some Pitney Locker workflows require recipient, department, or depositor contact details. These contacts are managed through the Address Book APIs. For more information, see Address Book APIs.