{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-openapi/lockers.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"openapi/lockers.yaml","dynamicMarkdocComponents":[],"baseSlug":"/openapi/lockers","seo":{"title":"Pitney Locker APIs","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Pitney Locker APIs","description":"\nThe 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.\n\nBy 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 . \n\n**Why Use Pitney Locker APIs**\n\n- Enable contactless, secure package deliveries\n\n- Automate locker assignment and release\n\n- Support forward delivery and return/drop-off workflows\n\n- Track which locker unit is assigned to which package\n\n- Simplify mailroom or internal delivery operations\n\n- Retrieve locker availability and locker status information\n\n\n**How Pitney Locker APIs Work**\n\nThe 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.\n\nThe APIs support two primary workflows:\n\n- Forward delivery workflow (transactionType: deliver)\n- Return or asset drop-off workflow (transactionType: return)\n\nA user (typically a mailroom operator or system) can use these APIs to:\n\n  1. Look up locker banks\n  2. Check available locker unit sizes\n  3. Reserve locker units\n  4. Open locker units remotely\n  5. Deposit packages into locker units\n  6. Retrieve reservation details\n  7. Free locker units after use\n  8. Monitor locker unit operational status\n\n\n**Step-by-Step Workflow for Pitney Locker APIs**\n\n**Step 1: Retrieve Available Locker Banks**\n\nUse the [Get Locker Banks](/openapi/lockers/locker-bank/getlockerbanks) or [Get Locker Bank by Locker Bank ID](/openapi/lockers/locker-bank/getlockerbankdetails) APIs to retrieve the list of available locker banks at a facility.\nFilter by:\n\n- `locationId`: To get lockers for a specific location\n\n- `lockerBankId`: To retrieve a specific locker bank by ID. One location can have multiple banks.\n\n- Each locker bank has a unique `lockerBankId`, used in subsequent API calls.\n\n**Step 2: Get Locker Sizes for a Locker Bank**\n\nUse the [Get Locker Sizes API](/openapi/lockers/locker-bank/lockersizes) to retrieve the available locker unit sizes in a locker bank (e.g., small, medium, large) along with their availability status.\n\n- You need to pass the `lockerBankId` retrieved in Step 1 as a path parameter.\n\n**Step 3: Reserve a Locker Unit**\n\nOnce you know a locker unit is available, use the [Reserve Locker Unit API](/openapi/lockers/locker-unit/createreservation) to create a reservation.\nThis workflow is typically used for forward delivery operations and internally uses `transactionType: deliver`\n\nRequired fields include:\n\n- `lockerBankId` (path parameter)\n\n- Package tracking number\n\n- Locker size preference (e.g., small)\n\n- Recipient identification (contact ID and type)\n\n- Reservation Expiry Time \n\nIf a locker is successfully reserved, a **locker unit ID** will be returned in the response.\n\n**Return and Asset Drop-off Reservations**\n\nFor return or asset drop-off workflows, use the Create Return Reservation API.\n\nThis workflow uses `transactionType: return`\n\nIn 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.\n\nThe reservation can include:\n\n- Receiving contact information\n- Depositor contact information\n- Tracking details\n- Reservation expiry information\n\n**Step 4: Open a Locker Unit**\n\nUse 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.\n\n**Step 5: Add or Update Deposit Information**\n\nAfter reserving the locker unit, deposit the parcel inside the locker using [Add/Update Deposit API](/openapi/lockers/locker-unit/updatedeposit). Using the same API, user can update the deposit information for example userId of the user.\n\nThis updates the locker reservation to reflect:\n\n- Parcel successfully deposited\n- Deposit timestamp\n- depositExpiryTime (Once expired, the parcel may be removed or handled according to facility policy.)\n- 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`)\n\nYou need to pass:\n\n- `lockerBankId` (path parameter)\n\n- `lockerUnitId` (path parameter)\n\n**Step 6: Retrieve Reservation Details** \n\nThese APIs help external systems, operators, or recipients retrieve reservation details.\n\n- [Get Reservations by Contact](/openapi/lockers/locker-unit/getreservationlist): Retrieve all reservations linked to a specific recipient/contact.\n- [Get Reservation by Tracking Number](/openapi/lockers/locker-unit/getreservation): Retrieve reservation details using the package tracking number.\n\n**Step 7: Update Reservation** \n\nIf reservation details need to be changed (e.g., expiry time, contact details, metadata), use the [Update Reservation API](/openapi/lockers/locker-unit/updatereservation).\n\nYou need to pass:\n\n- `lockerBankId` (path parameter)\n\n- `lockerUnitId` (path parameter)\n\n**Step 7: Free the Reserved Locker Unit**\n\nUse the [Free Reserved Locker Unit API](/openapi/lockers/locker-unit/freereservation) to cancel the existing reservation. This makes the locker unit available for the next package.\n\nYou need to pass:\n\n- `lockerBankId` (path parameter)\n\n- unit to be freed - `lockerUnitId` (path parameter)\n\n**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](/openapi/addressbook/contact/addcontact).\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.shipping360.pitneybowes.com","port":4000,"ipAddress":"216.73.216.138"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"master"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/openapi/lockers","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}