{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-openapi/parcelpoint.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"openapi/parcelpoint.yaml","dynamicMarkdocComponents":[],"baseSlug":"/openapi/parcelpoint","seo":{"title":"Lockers APIs","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Lockers APIs","description":"\nThe 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. By integrating these APIs into your system, you can automate end-to-end locker workflows—from locating available lockers to reserving, opening, depositing, and freeing locker units after pickup.\n\n**Why Use Parcel-Point APIs**\n\n- Enable contactless, secure package deliveries\n\n- Automate locker assignment and release\n\n- Support delivery and pickup workflows without human intervention\n\n- Track which locker unit is assigned to which package\n\n- Simplify mailroom or internal delivery operations\n\n**How Parcel-Point APIs Work**\n\nThe Parcel-Point APIs are designed to manage smart locker workflows—from retrieving available locker banks to reserving, depositing parcels and freeing individual locker units. The user (typically a mailroom operator or system) uses these APIs t\n1.\tLook up locker banks\n2.\tCheck available locker unit sizes\n3.\tReserve locker units\n4.\tMark deposits\n5.\tFetch reservations\n6.\tFree locker units\n\n\n**Step-by-Step Workflow for Parcel-Point APIs**\n\n**Step 1: Retrieve Available Locker Banks**\n\nUse the [Get Locker Banks](/openapi/parcelpoint/locker-bank/getlockerbanks) or [Get Locker Bank by Locker Bank ID](/openapi/parcelpoint/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/parcelpoint/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/parcelpoint/locker-unit/createreservation) to create a reservation.\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**Step 4: Add or Update Deposit Information**\n\nAfter reserving the locker unit, deposit the parcel inside the locker using [Add/Update Deposit API](/openapi/parcelpoint/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 5: Retrieve Reservation Details** \n\nThese APIs help external systems, operators, or recipients retrieve reservation details.\n\n- [Get Reservations by Contact](/openapi/parcelpoint/locker-unit/getreservationlist): Retrieve all reservations linked to a specific recipient/contact.\n- [Get Reservation by Tracking Number](/openapi/parcelpoint/locker-unit/getreservation): Retrieve reservation details using the package tracking number.\n\n**Step 6: Update Reservation** \n\nIf reservation details need to be changed (e.g., expiry time, contact details, metadata), use the [Update Reservation API](/openapi/parcelpoint/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/parcelpoint/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"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.shipping360.pitneybowes.com","port":4000,"ipAddress":"216.73.217.63"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"master"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/openapi/parcelpoint","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}