Pitney Bowes Parcel-Point APIs Overview

The ParcelPoint (Locker) APIs help manage the reservation and release of smart locker units for package delivery and pickup. These APIs allow organizations to automate secure, contactless deliveries by integrating with Pitney Bowes smart lockers.

Why Use Parcel-Point APIs

  • Enable contactless, secure package deliveries
  • Automate locker assignment and release
  • Support delivery and pickup workflows without human intervention
  • Track which locker unit is assigned to which package
  • Simplify mailroom or internal delivery operations

How Parcel-Point APIs Work

The Parcel-Point APIs are designed to manage smart locker workflows—from retrieving available locker banks to reserving and freeing individual locker units. The user (typically a facility operator or system) performs actions such as locker lookup, reservation, and release.

Step-by-Step Workflow for Parcel-Point APIs

Step 1: Retrieve Available Locker Banks

Use the Get Locker Banks API 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. Required fields include:

  • lockerBankId (path parameter)
  • Package tracking number
  • Locker size preference (e.g., small)
  • Recipient identification (contact ID and type)

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

Step 4: Free the Reserved Locker Unit

Use the Free Reserved Locker Unit API when the package is picked up or the reservation is canceled. This makes the locker unit available for the next package.

You need to pass:

  • lockerBankId (path parameter)
  • unit to be freed - lockerUnitId (path parameter)