{"items":[{"type":"link","label":"Receiving APIs","link":"/openapi/receiving","routeSlug":"/openapi/receiving","content":{"contentType":"overview","meta":{"name":"Receiving APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"receiving.json","url":"/_bundle/openapi/receiving.json?download"},{"kind":"download","label":"receiving.yaml","url":"/_bundle/openapi/receiving.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Receiving APIs (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pitney Bowes Receiving APIs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" help manage packages from the moment they arrive at a facility until they are delivered to the final recipient. These APIs allow organizations to track, update, and store package details, helping to manage internal package handling efficiently."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Why Receiving APIs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track every package from arrival to final delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maintain a complete history of package status and movements."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the current package details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quickly find packages within the system using tracking numbers or other search criteria."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How Receiving APIs Work"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a package arrives at a facility, it may have a barcode that either includes a tracking number or does not."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"barcode contains a tracking number"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system searches for an existing package with the same tracking number."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no package exists, a new package entry is created."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":2,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package does not have a tracking number"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new tracking number is generated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new package entry is created."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":3,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once package added to the system, It can be tracked, and its details can be updated to reflect its current status, location, or latest activity."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the package is delivered to its destination, it can be archived for record-keeping."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step-by-Step Workflow for Receiving APIs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section provides a structured process for handling packages using the Pitney Bowes Receiving APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 1: Decode the Barcode on a Package"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Packages with barcodes must be scanned first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the barcode contains a tracking number, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/receiving/decode/decodetrackingnumber"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decode Tracking Number"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API to extract key details, such as:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Package type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier service"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender and receiver information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current location"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":3,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Decode API supports 2D barcodes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 2: Generate a Unique Tracking Number (If Required)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a package does not have a tracking number, the user first needs to assign a unique tracking number to the package."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/receiving/packages/createtrackingnumber"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate Tracking Number"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API creates a unique tracking number, which serves as an identifier throughout the package lifecycle."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 3: Add Package to the System"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every package must be added to the system using its tracking number."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system verifies that no duplicate tracking number exists. If a duplicate is found, an error is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upon successful addition, the package is assigned a unique Package ID for tracking."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The package is linked to relevant sender and receiver information."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Information to add a Package:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Number:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Each package must have a unique tracking number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact ID:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts can be of three types: Sender, Receiver, and Given To."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts must be created first using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/addressbook/contact/addcontact"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add Contact"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API (Address Book APIs)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once added, the system generates a unique Contact ID for each contact, which is used when adding a package."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Fields:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Additional custom details can be associated with the package. Fetch the Custom fields using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/customfields/custom-fields/getcustomfield"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Custom Field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inbound Site ID:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If the package needs to be linked to an inbound site location, fetch the associated Inbound Site ID using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/receiving/inbound-sites/getinboundsite"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Inbound Sites"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 4: Search for a Package in the System"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Users can find specific packages using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/receiving/packages/searchpackage"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search Package"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API by entering tracking numbers, statuses, or metadata. This API locates packages that are in transit, waiting for pickup, or already delivered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 5: Retrieve Package Details"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/receiving/packages/getpackagepackageid"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Package"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API to fetch detailed information about a package."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The package can be retrieved using either its unique package ID or tracking number."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes the package's history, current status, current location, and latest activity."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 6: Update Package Information"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Packages undergo several status changes as they move through the system. The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/receiving/packages/updatepackage"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Package"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API allows to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update package details such as status, location, sender, receiver, and confirmation methods."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mark packages as DAMAGED, ARCHIVED, RECEIVED, or DELIVERED."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Record location changes, damage reports, or special handling requirements."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attach images for proof of receipt."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assign a package to a specific recipient within an organization."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 7: Archive a Package"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once a package has reached its final recipient, it can be archived for record keeping using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/receiving/packages/archivepackage"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Archive Package"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Archive Package API removes the package from active workflows while maintaining its record for future reference."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve Carrier List"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a list of carriers associated with specific locations using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/receiving/carrier/getcarrierlist"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Carrier List"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This helps in knowing which carriers are responsible for incoming shipments at different facilities"},"children":[]}]}]}]}]}]}],"sectionId":"/openapi/receiving"}],"sectionId":"/openapi/receiving"}]}]}},{"type":"group","label":"Decode","link":"/openapi/receiving/decode","routeSlug":"/openapi/receiving/decode","items":[{"label":"Decode Tracking Number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/decode/decodetrackingnumber","routeSlug":"/openapi/receiving/decode/decodetrackingnumber","metadata":{"seo":{"title":"Decode Tracking Number","description":"This operation decodes a tracking number from a barcode, extracting package details like carrier information, receiver Id, and package type. It supports 2D barcodes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"decodeTrackingNumber","name":"Decode Tracking Number","isWebhook":false,"pointer":"/paths/~1api~1v1~1packages~1tracking~1decode/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Decode Tracking Number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation decodes a tracking number from a barcode, extracting package details like carrier information, receiver Id, and package type. It supports 2D barcodes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"trackingNumber","in":"query","schemaId":"schema_322","required":true,"example":"PB4OZAWWNPBG"},{"name":"expectedPackage","in":"query","schemaId":"schema_323","example":"true"},{"name":"editflow","in":"query","schemaId":"schema_324","example":false}],"pointer":"/paths/~1api~1v1~1packages~1tracking~1decode/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/packages/tracking/decode","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[{"name":"trackingNumber","in":"query","required":true,"example":"PB4OZAWWNPBG","schemaId":"schema_322"},{"name":"expectedPackage","in":"query","required":false,"example":"true","schemaId":"schema_323"},{"name":"editflow","in":"query","required":false,"example":false,"schemaId":"schema_324"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/packages/tracking/decode","href":"decode/decodetrackingnumber","openApiOperationId":"decodeTrackingNumber","summary":"Decode Tracking Number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing decoded tracking details and package information.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetResponseDTO"}},"schemaId":"components/schemas/GetResponseDTO"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1packages~1tracking~1decode/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetResponseDTO"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/decode/decodetrackingnumber"}],"panels":[]}]},"httpPath":"/api/v1/packages/tracking/decode"}],"content":{"contentType":"group","meta":{"name":"Decode"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Decode","showPageActions":true},{"nodeType":"markdoc","content":"APIs for decoding package tracking numbers from supported barcode formats. These APIs extract package-related details such as carrier information, receiver identifiers, and package type."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/packages/tracking/decode","summary":"Decode Tracking Number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/decode/decodetrackingnumber","deprecated":false}]}]}]}]}},{"type":"group","label":"Packages","link":"/openapi/receiving/packages","routeSlug":"/openapi/receiving/packages","items":[{"label":"Generate Tracking Number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/createtrackingnumber","routeSlug":"/openapi/receiving/packages/createtrackingnumber","metadata":{"seo":{"title":"Generate Tracking Number","description":"This API generates a unique tracking number required to add a package.These numbers serve as identifiers for packages throughout their lifecycle.  Use this API when a package does not already have a tracking number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTrackingNumber","name":"Generate Tracking Number","isWebhook":false,"pointer":"/paths/~1api~1v1~1trackingNumbers/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate Tracking Number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API generates a unique tracking number required to add a package.These numbers serve as identifiers for packages throughout their lifecycle. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use this API when a package does not already have a tracking number."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/trackingNumbers","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/trackingNumbers","href":"packages/createtrackingnumber","openApiOperationId":"createTrackingNumber","summary":"Generate Tracking Number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A unique tracking number has been generated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_325"}},"schemaId":"schema_325"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1trackingNumbers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_325","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_325"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/createtrackingnumber"}],"panels":[]}]},"httpPath":"/api/v1/trackingNumbers"},{"label":"Create Image","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/createimage","routeSlug":"/openapi/receiving/packages/createimage","metadata":{"seo":{"title":"Create Image","description":"This operation creates an image and provides details about the created image. The image data must be provided in Base64 format in the request body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createImage","name":"Create Image","isWebhook":false,"pointer":"/paths/~1api~1v1~1packages~1images/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation creates an image and provides details about the created image. The image data must be provided in Base64 format in the request body."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_326","example":"application/json"}],"pointer":"/paths/~1api~1v1~1packages~1images/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_327"}},"schemaId":"schema_327","pointer":"/paths/~1api~1v1~1packages~1images/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/packages/images","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":false,"example":"application/json","schemaId":"schema_326"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_327"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/packages/images","href":"packages/createimage","openApiOperationId":"createImage","summary":"Create Image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"schemaId":"schema_327","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_327"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Image has been created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1packages~1images/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/createimage"}],"panels":[]}]},"httpPath":"/api/v1/packages/images"},{"label":"Search Package","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/searchpackage","routeSlug":"/openapi/receiving/packages/searchpackage","metadata":{"seo":{"title":"Search Package","description":"This operation retrieves a list of packages based on the specified search criteria, such as tracking numbers, status, or associated metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchPackage","name":"Search Package","isWebhook":false,"pointer":"/paths/~1api~1v1~1packages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Package","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation retrieves a list of packages based on the specified search criteria, such as tracking numbers, status, or associated metadata. "},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_326","description":"Filter package created or updated on or after this date.","example":"2024-11-27T18:30:00.000Z"},{"name":"endDate","in":"query","schemaId":"schema_326","description":"Filter assets created or updated on or before this date.","example":"2024-11-28T18:30:00.000Z"},{"name":"page","in":"query","schemaId":"schema_329","description":"The page number of the results to retrieve. Pagination starts from 1.","example":"1"},{"name":"size","in":"query","schemaId":"schema_329","description":"The number of assets to retrieve per page.","example":"25"},{"name":"search","in":"query","schemaId":"schema_326","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search criteria for asset fields such as tracking number. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName:fieldValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"required":true,"example":"trackingNumber:PBKWJAMJYW9ND"},{"name":"searchPosition","in":"query","schemaId":"schema_326","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the position of the search match in the field. Values can include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ends"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ends"},{"name":"status","in":"query","schemaId":"schema_326","description":"Filter assets by status.","example":"UNDELIVERED"},{"name":"location","in":"query","schemaId":"schema_326","description":"Filter packages by location ID. Use the unique identifier of the location.","example":"bzxgKm861vv"},{"name":"sort","in":"query","schemaId":"schema_326","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the sorting order of the results. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName,DIRECTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". DIRECTION can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"insertTimestamp,DESC"},{"name":"secondTierSearchSelected","in":"query","schemaId":"schema_330","description":"Include secondary search criteria for the assets. Defaults to false.","example":"false"},{"name":"includeEmptyPackageLocation","in":"query","schemaId":"schema_330","description":"Add assets without a specified package location in the results. Defaults to true.","example":"true"}],"pointer":"/paths/~1api~1v1~1packages/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_326","example":"application/json"}],"pointer":"/paths/~1api~1v1~1packages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/packages","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[{"name":"startDate","in":"query","required":false,"example":"2024-11-27T18:30:00.000Z","schemaId":"schema_326"},{"name":"endDate","in":"query","required":false,"example":"2024-11-28T18:30:00.000Z","schemaId":"schema_326"},{"name":"page","in":"query","required":false,"example":"1","schemaId":"schema_329"},{"name":"size","in":"query","required":false,"example":"25","schemaId":"schema_329"},{"name":"search","in":"query","required":true,"example":"trackingNumber:PBKWJAMJYW9ND","schemaId":"schema_326"},{"name":"searchPosition","in":"query","required":false,"example":"ends","schemaId":"schema_326"},{"name":"status","in":"query","required":false,"example":"UNDELIVERED","schemaId":"schema_326"},{"name":"location","in":"query","required":false,"example":"bzxgKm861vv","schemaId":"schema_326"},{"name":"sort","in":"query","required":false,"example":"insertTimestamp,DESC","schemaId":"schema_326"},{"name":"secondTierSearchSelected","in":"query","required":false,"example":"false","schemaId":"schema_330"},{"name":"includeEmptyPackageLocation","in":"query","required":false,"example":"true","schemaId":"schema_330"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":false,"example":"application/json","schemaId":"schema_326"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/packages","href":"packages/searchpackage","openApiOperationId":"searchPackage","summary":"Search Package"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Requested assets has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchAssetResponseBody"}},"schemaId":"components/schemas/SearchAssetResponseBody"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1packages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchAssetResponseBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchAssetResponseBody"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/searchpackage"}],"panels":[]}]},"httpPath":"/api/v1/packages"},{"label":"Add Package","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/createpackage","routeSlug":"/openapi/receiving/packages/createpackage","metadata":{"seo":{"title":"Add Package","description":"This API operation creates a new package in the system and records its associated activity.Each package requires a unique tracking number to be added successfully. If an attempt is made to add multiple packages using the same tracking number, the API will return an error.When to use Add Package API?"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPackage","name":"Add Package","isWebhook":false,"pointer":"/paths/~1api~1v1~1packages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Package","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API operation creates a new package in the system and records its associated activity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each package requires a unique tracking number to be added successfully. If an attempt is made to add multiple packages using the same tracking number, the API will return an error."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use Add Package API?"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For packages with a barcode"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers scan the barcode label on the package and decode the tracking number using the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decode Tracking Number"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Package by Tracking Number"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API to check if the package already exists in the system:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the package is not found, use "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add Package"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API to add the package in the system."},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For packages without a barcode or tracking number, generate a unique tracking number using the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate Tracking Number"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API and then add the package using "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add Package"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddPackageRequestBody"}},"schemaId":"components/schemas/AddPackageRequestBody","pointer":"/paths/~1api~1v1~1packages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/packages","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddPackageRequestBody"}},"responseCodes":["201","400","401","500"],"pointer":"/api/v1/packages","href":"packages/createpackage","openApiOperationId":"createPackage","summary":"Add Package"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"schemaId":"components/schemas/AddPackageRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddPackageRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Package has been created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddPackageResponseBody"}},"schemaId":"components/schemas/AddPackageResponseBody"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1packages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AddPackageResponseBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddPackageResponseBody"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/createpackage"}],"panels":[]}]},"httpPath":"/api/v1/packages"},{"label":"Search Packages with Custom Header Mapping","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/searchpackages","routeSlug":"/openapi/receiving/packages/searchpackages","metadata":{"seo":{"title":"Search Packages with Custom Header Mapping","description":"This operation returns package records based on the requested custom header mapping. The request body contains package field names as keys and custom header labels as values. These header labels can be used to display the returned package data with user-defined column names."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchPackages","name":"Search Packages with Custom Header Mapping","isWebhook":false,"pointer":"/paths/~1api~1v1~1packages~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Packages with Custom Header Mapping","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation returns package records based on the requested custom header mapping. The request body contains package field names as keys and custom header labels as values. These header labels can be used to display the returned package data with user-defined column names."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_326","description":"Filter package updated on or after this date.","example":"2024-11-27T18:30:00.000Z"},{"name":"endDate","in":"query","schemaId":"schema_326","description":"Filter package updated on or before this date.","example":"2024-11-28T18:30:00.000Z"},{"name":"page","in":"query","schemaId":"schema_329","description":"The page number of the results to retrieve. Pagination starts from 1.","example":"1"},{"name":"size","in":"query","schemaId":"schema_329","description":"The number of assets to retrieve per page.","example":"25"},{"name":"status","in":"query","schemaId":"schema_326","description":"Filter assets by status.","example":"UNDELIVERED"},{"name":"sort","in":"query","schemaId":"schema_326","description":"Specify the sorting order of the results.","example":"insertTimestamp"},{"name":"inboundSiteId","in":"query","schemaId":"schema_326","description":"This is the identifier of the Inbound Site to be searched.","example":"bzxgKm861vv"}],"pointer":"/paths/~1api~1v1~1packages~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_331"}},"schemaId":"schema_331","pointer":"/paths/~1api~1v1~1packages~1search/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines custom header mappings for package search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each key represents a package response field, and each value represents the custom header label to be used for that field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body is a key-value mapping used to define custom headers for the package search response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key (Field Name):"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the actual package field from the system."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This can include nested fields using dot notation (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packageId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currentLocation.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"givenTo.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currentRoute.routeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value (Header Label):"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the custom header name for the corresponding field in the response output."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This mapping allows users to control how package data fields are labeled when returned in response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"packageId\": \"Package Identifier\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → Returns the packageId field as \"Package Identifier\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"currentLocation.name\": \"Site Name\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → Returns current location name as \"Site Name\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryClerk: \"Delivered By\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → Returns delivery clerk name as \"Delivered By\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An empty object can be passed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no mappings are provided, the API returns all package fields using their default field names."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/packages/search","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[{"name":"startDate","in":"query","required":false,"example":"2024-11-27T18:30:00.000Z","schemaId":"schema_326"},{"name":"endDate","in":"query","required":false,"example":"2024-11-28T18:30:00.000Z","schemaId":"schema_326"},{"name":"page","in":"query","required":false,"example":"1","schemaId":"schema_329"},{"name":"size","in":"query","required":false,"example":"25","schemaId":"schema_329"},{"name":"status","in":"query","required":false,"example":"UNDELIVERED","schemaId":"schema_326"},{"name":"sort","in":"query","required":false,"example":"insertTimestamp","schemaId":"schema_326"},{"name":"inboundSiteId","in":"query","required":false,"example":"bzxgKm861vv","schemaId":"schema_326"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_331"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/packages/search","href":"packages/searchpackages","openApiOperationId":"searchPackages","summary":"Search Packages with Custom Header Mapping"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"schemaId":"schema_331","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_331"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Package details have been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchPackagesResponse"}},"schemaId":"components/schemas/SearchPackagesResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1packages~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchPackagesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchPackagesResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/searchpackages"}],"panels":[]}]},"httpPath":"/api/v1/packages/search"},{"label":"Get Package","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/getpackagepackageid","routeSlug":"/openapi/receiving/packages/getpackagepackageid","metadata":{"seo":{"title":"Get Package","description":"This operation retrive detailed information or activities of a specific package using its unique packageId.  The packageId is generated when a package is added to the system"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPackagepackageID","name":"Get Package","isWebhook":false,"pointer":"/paths/~1api~1v1~1packages~1{packageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Package","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation retrive detailed information or activities of a specific package using its unique packageId. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The packageId is generated when a package is added to the system"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"packageId","in":"path","schemaId":"schema_326","description":"The unique identifier of the package to retrieve.","required":true,"example":"d86w9YdE3e1JPm01NxaeP"}],"pointer":"/paths/~1api~1v1~1packages~1{packageId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_332","description":"The type of the package details to retrive.","required":true}],"pointer":"/paths/~1api~1v1~1packages~1{packageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/packages/{packageId}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"packageId","in":"path","required":true,"example":"d86w9YdE3e1JPm01NxaeP","schemaId":"schema_326"}],"query":[{"name":"type","in":"query","required":true,"schemaId":"schema_332"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/packages/{packageId}","href":"packages/getpackagepackageid","openApiOperationId":"getPackagepackageID","summary":"Get Package"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Requested package has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_333"}},"schemaId":"schema_333"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1packages~1{packageId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_333","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_333"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/getpackagepackageid"}],"panels":[]}]},"httpPath":"/api/v1/packages/{packageId}"},{"label":"Update Package","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/updatepackage","routeSlug":"/openapi/receiving/packages/updatepackage","metadata":{"seo":{"title":"Update Package","description":"This operation updates the details of an existing package using its unique packageId. Updates include the latest activity performen on the package or current status of the package such as RECEIVED or DELIVERED as well as recording additional information like damage reports, location changes, or other relevant package events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePackage","name":"Update Package","isWebhook":false,"pointer":"/paths/~1api~1v1~1packages~1{packageId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Package","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation updates the details of an existing package using its unique packageId. Updates include the latest activity performen on the package or current status of the package such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELIVERED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as well as recording additional information like damage reports, location changes, or other relevant package events."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"packageId","in":"path","schemaId":"schema_326","required":true}],"pointer":"/paths/~1api~1v1~1packages~1{packageId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddUpdateRequestDTO"}},"schemaId":"components/schemas/AddUpdateRequestDTO","pointer":"/paths/~1api~1v1~1packages~1{packageId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/packages/{packageId}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"packageId","in":"path","required":true,"schemaId":"schema_326"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddUpdateRequestDTO"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/packages/{packageId}","href":"packages/updatepackage","openApiOperationId":"updatePackage","summary":"Update Package"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"schemaId":"components/schemas/AddUpdateRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddUpdateRequestDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Package has been updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddUpdateResponseDTO"}},"schemaId":"components/schemas/AddUpdateResponseDTO"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1packages~1{packageId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddUpdateResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddUpdateResponseDTO"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/updatepackage"}],"panels":[]}]},"httpPath":"/api/v1/packages/{packageId}"},{"label":"Archive Package","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/archivepackage","routeSlug":"/openapi/receiving/packages/archivepackage","metadata":{"seo":{"title":"Archive Package","description":"This operation marks the specified package as archived by updating its archived status to true. Archiving a package indicates that its lifecycle is complete, and it is no longer actively tracked. While archived packages are removed from active workflows, their records remain accessible for future reference"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archivePackage","name":"Archive Package","isWebhook":false,"pointer":"/paths/~1api~1v1~1packages~1{packageId}~1archive/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive Package","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation marks the specified package as archived by updating its archived status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Archiving a package indicates that its lifecycle is complete, and it is no longer actively tracked. While archived packages are removed from active workflows, their records remain accessible for future reference"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"packageId","in":"path","schemaId":"schema_326","required":true,"example":"NeLnz9LZ1j4KK5WlEOlyW"}],"pointer":"/paths/~1api~1v1~1packages~1{packageId}~1archive/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PackageArchiveRequest"}},"schemaId":"components/schemas/PackageArchiveRequest","pointer":"/paths/~1api~1v1~1packages~1{packageId}~1archive/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/packages/{packageId}/archive","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"packageId","in":"path","required":true,"example":"NeLnz9LZ1j4KK5WlEOlyW","schemaId":"schema_326"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PackageArchiveRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/packages/{packageId}/archive","href":"packages/archivepackage","openApiOperationId":"archivePackage","summary":"Archive Package"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"schemaId":"components/schemas/PackageArchiveRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PackageArchiveRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Requested package has been marked archived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_334"}},"schemaId":"schema_334"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1packages~1{packageId}~1archive/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_334","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_334"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/archivepackage"}],"panels":[]}]},"httpPath":"/api/v1/packages/{packageId}/archive"},{"label":"Get Package By Tracking","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/packages/getpackagebytracking","routeSlug":"/openapi/receiving/packages/getpackagebytracking","metadata":{"seo":{"title":"Get Package By Tracking","description":"This operation retrives a package using its unique tracking number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPackageByTracking","name":"Get Package By Tracking","isWebhook":false,"pointer":"/paths/~1api~1v1~1packages~1tracking~1{trackingNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Package By Tracking","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation retrives a package using its unique tracking number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"trackingNumber","in":"path","schemaId":"schema_326","required":true,"example":"PB7QBQPNBJRDLQ"}],"pointer":"/paths/~1api~1v1~1packages~1tracking~1{trackingNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/packages/tracking/{trackingNumber}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"trackingNumber","in":"path","required":true,"example":"PB7QBQPNBJRDLQ","schemaId":"schema_326"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/packages/tracking/{trackingNumber}","href":"packages/getpackagebytracking","openApiOperationId":"getPackageByTracking","summary":"Get Package By Tracking"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Requested assets has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DetailedPackage"}},"schemaId":"components/schemas/DetailedPackage"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1packages~1tracking~1{trackingNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DetailedPackage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DetailedPackage"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/getpackagebytracking"}],"panels":[]}]},"httpPath":"/api/v1/packages/tracking/{trackingNumber}"}],"content":{"contentType":"group","meta":{"name":"Packages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Packages","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing package records throughout their lifecycle. These APIs support operations such as generating tracking numbers, creating package records, uploading package images, retrieving package details, searching packages, updating package information, archiving packages, and retrieving packages by tracking number."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/trackingNumbers","summary":"Generate Tracking Number","prefix":{"name":"post","color":"post"},"badges":[],"link":"/packages/createtrackingnumber","deprecated":false},{"title":"/api/v1/packages/images","summary":"Create Image","prefix":{"name":"post","color":"post"},"badges":[],"link":"/packages/createimage","deprecated":false},{"title":"/api/v1/packages","summary":"Search Package","prefix":{"name":"get","color":"get"},"badges":[],"link":"/packages/searchpackage","deprecated":false},{"title":"/api/v1/packages","summary":"Add Package","prefix":{"name":"post","color":"post"},"badges":[],"link":"/packages/createpackage","deprecated":false},{"title":"/api/v1/packages/search","summary":"Search Packages with Custom Header Mapping","prefix":{"name":"post","color":"post"},"badges":[],"link":"/packages/searchpackages","deprecated":false},{"title":"/api/v1/packages/{packageId}","summary":"Get Package","prefix":{"name":"get","color":"get"},"badges":[],"link":"/packages/getpackagepackageid","deprecated":false},{"title":"/api/v1/packages/{packageId}","summary":"Update Package","prefix":{"name":"put","color":"put"},"badges":[],"link":"/packages/updatepackage","deprecated":false},{"title":"/api/v1/packages/{packageId}/archive","summary":"Archive Package","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/packages/archivepackage","deprecated":false},{"title":"/api/v1/packages/tracking/{trackingNumber}","summary":"Get Package By Tracking","prefix":{"name":"get","color":"get"},"badges":[],"link":"/packages/getpackagebytracking","deprecated":false}]}]}]}]}},{"type":"group","label":"Carrier","link":"/openapi/receiving/carrier","routeSlug":"/openapi/receiving/carrier","items":[{"label":"Retrive Carrier List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/carrier/getcarrierlist","routeSlug":"/openapi/receiving/carrier/getcarrierlist","metadata":{"seo":{"title":"Retrive Carrier List","description":"This operation retrieves a list of carriers associated with the specific location/s."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCarrierList","name":"Retrive Carrier List","isWebhook":false,"pointer":"/paths/~1api~1v1~1carriers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrive Carrier List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation retrieves a list of carriers associated with the specific location/s."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","schemaId":"schema_329","description":"The number of results to return in a single page of the carrier list.","example":"50"},{"name":"page","in":"query","schemaId":"schema_329","description":"The page number to retrieve.","example":"1"},{"name":"barcodeAware","in":"query","schemaId":"schema_330","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether to retrieve carriers that are barcode-aware. When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response includes only those carriers capable of processing barcodes."},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1api~1v1~1carriers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1api~1v1~1carriers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/carriers","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[{"name":"size","in":"query","required":false,"example":"50","schemaId":"schema_329"},{"name":"page","in":"query","required":false,"example":"1","schemaId":"schema_329"},{"name":"barcodeAware","in":"query","required":false,"example":"true","schemaId":"schema_330"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["201","400","401","500"],"pointer":"/api/v1/carriers","href":"carrier/getcarrierlist","openApiOperationId":"getCarrierList","summary":"Retrive Carrier List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Carrier list has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CarrierLookupResponseDTO"}},"schemaId":"components/schemas/CarrierLookupResponseDTO"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1carriers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CarrierLookupResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CarrierLookupResponseDTO"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/carrier/getcarrierlist"}],"panels":[]}]},"httpPath":"/api/v1/carriers"}],"content":{"contentType":"group","meta":{"name":"Carrier"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Carrier","showPageActions":true},{"nodeType":"markdoc","content":"APIs for retrieving carrier information associated with one or more locations. These APIs help identify the carriers available for package processing and support location."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/carriers","summary":"Retrive Carrier List","prefix":{"name":"post","color":"post"},"badges":[],"link":"/carrier/getcarrierlist","deprecated":false}]}]}]}]}},{"type":"group","label":"Inbound sites","link":"/openapi/receiving/inbound-sites","routeSlug":"/openapi/receiving/inbound-sites","items":[{"label":"Add Inbound Site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/inbound-sites/addinboundsite","routeSlug":"/openapi/receiving/inbound-sites/addinboundsite","metadata":{"seo":{"title":"Add Inbound Site","description":"This operation used for generating Inbound Site Id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addInboundSite","name":"Add Inbound Site","isWebhook":false,"pointer":"/paths/~1api~1v1~1inboundsites/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Inbound Site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation used for generating Inbound Site Id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_336"}},"schemaId":"schema_336","pointer":"/paths/~1api~1v1~1inboundsites/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/inboundsites","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_336"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/inboundsites","href":"inbound-sites/addinboundsite","openApiOperationId":"addInboundSite","summary":"Add Inbound Site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"schemaId":"schema_336","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_336"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Requested Inbound Site Id has been generated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_337"}},"schemaId":"schema_337"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1inboundsites/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_337","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_337"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound-sites/addinboundsite"}],"panels":[]}]},"httpPath":"/api/v1/inboundsites"},{"label":"Get Inbound Site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/inbound-sites/getinboundsite","routeSlug":"/openapi/receiving/inbound-sites/getinboundsite","metadata":{"seo":{"title":"Get Inbound Site","description":"This operation is used to retrived the Inbound Sites."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInboundSite","name":"Get Inbound Site","isWebhook":false,"pointer":"/paths/~1api~1v1~1inboundsites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Inbound Site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation is used to retrived the Inbound Sites."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"skip","in":"query","schemaId":"schema_338","example":"0"},{"name":"limit","in":"query","schemaId":"schema_339","example":"20"},{"name":"sort","in":"query","schemaId":"schema_340","example":"name,ASC"},{"name":"query","in":"query","schemaId":"schema_326","description":"Searches for inbound sites using a keyword.","example":"site"},{"name":"searchBy","in":"query","schemaId":"schema_341","examples":{"example1":{"summary":"For getting inbound sites which belongs to particaular site","value":"parent:X7okeWJyx5zz"},"example2":{"summary":"For searching inside the inbound sites hierarchy","value":"ancestorlist:X7okeWJyx5zz"}}},{"name":"fetchPrimarySite","in":"query","schemaId":"schema_330","description":"Only get default site in response, if set true. ","example":true},{"name":"timestamp","in":"query","schemaId":"schema_326","description":"Get inbound site which are created before or after the provided timestamp.","example":"2024-11-19T07:54:46.807"},{"name":"status","in":"query","schemaId":"schema_342","description":"Only get default site in response, if set true.","example":"active"}],"pointer":"/paths/~1api~1v1~1inboundsites/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/inboundsites","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[{"name":"skip","in":"query","example":"0","schemaId":"schema_338"},{"name":"limit","in":"query","example":"20","schemaId":"schema_339"},{"name":"sort","in":"query","example":"name,ASC","schemaId":"schema_340"},{"name":"query","in":"query","example":"site","schemaId":"schema_326"},{"name":"searchBy","in":"query","example":"parent:X7okeWJyx5zz","schemaId":"schema_341"},{"name":"fetchPrimarySite","in":"query","example":true,"schemaId":"schema_330"},{"name":"timestamp","in":"query","example":"2024-11-19T07:54:46.807","schemaId":"schema_326"},{"name":"status","in":"query","example":"active","schemaId":"schema_342"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/inboundsites","href":"inbound-sites/getinboundsite","openApiOperationId":"getInboundSite","summary":"Get Inbound Site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Requested Inbound Sites list has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAllInboundSitesResponse"}},"schemaId":"components/schemas/GetAllInboundSitesResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1inboundsites/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAllInboundSitesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAllInboundSitesResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound-sites/getinboundsite"}],"panels":[]}]},"httpPath":"/api/v1/inboundsites"},{"label":"Update Inbound Site","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/inbound-sites/updateinboundsite","routeSlug":"/openapi/receiving/inbound-sites/updateinboundsite","metadata":{"seo":{"title":"Update Inbound Site","description":"This operation used to update Inbound Site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInboundSite","name":"Update Inbound Site","isWebhook":false,"pointer":"/paths/~1api~1v1~1inboundsites~1{inboundSiteId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Inbound Site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation used to update Inbound Site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inboundSiteId","in":"path","schemaId":"schema_326","required":true,"example":"gJVQ5bQW2OVd"}],"pointer":"/paths/~1api~1v1~1inboundsites~1{inboundSiteId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateInboundSiteDTO"}},"schemaId":"components/schemas/UpdateInboundSiteDTO","pointer":"/paths/~1api~1v1~1inboundsites~1{inboundSiteId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/inboundsites/{inboundSiteId}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"inboundSiteId","in":"path","required":true,"example":"gJVQ5bQW2OVd","schemaId":"schema_326"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateInboundSiteDTO"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/inboundsites/{inboundSiteId}","href":"inbound-sites/updateinboundsite","openApiOperationId":"updateInboundSite","summary":"Update Inbound Site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"schemaId":"components/schemas/UpdateInboundSiteDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateInboundSiteDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Requested Inbound Site has been updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1inboundsites~1{inboundSiteId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound-sites/updateinboundsite"}],"panels":[]}]},"httpPath":"/api/v1/inboundsites/{inboundSiteId}"},{"label":"Delete Inbound Site","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/inbound-sites/deleteinboundsite","routeSlug":"/openapi/receiving/inbound-sites/deleteinboundsite","metadata":{"seo":{"title":"Delete Inbound Site","description":"This operation is used to delete Inbound Site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteInboundSite","name":"Delete Inbound Site","isWebhook":false,"pointer":"/paths/~1api~1v1~1inboundsites~1{inboundSiteId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Inbound Site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation is used to delete Inbound Site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inboundSiteId","in":"path","schemaId":"schema_343","required":true,"example":"gJVQ5bQW2OVd"}],"pointer":"/paths/~1api~1v1~1inboundsites~1{inboundSiteId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/inboundsites/{inboundSiteId}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"inboundSiteId","in":"path","required":true,"example":"gJVQ5bQW2OVd","schemaId":"schema_343"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/inboundsites/{inboundSiteId}","href":"inbound-sites/deleteinboundsite","openApiOperationId":"deleteInboundSite","summary":"Delete Inbound Site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Requested Inbound Site has been deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1inboundsites~1{inboundSiteId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound-sites/deleteinboundsite"}],"panels":[]}]},"httpPath":"/api/v1/inboundsites/{inboundSiteId}"},{"label":"Get against locationId","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/receiving/inbound-sites/getlocationinboundsite","routeSlug":"/openapi/receiving/inbound-sites/getlocationinboundsite","metadata":{"seo":{"title":"Get against locationId","description":"This operation is used to retrived Inbound Site against the location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLocationInboundSite","name":"Get against locationId","isWebhook":false,"pointer":"/paths/~1api~1v1~1location~1inboundsites/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get against locationId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation is used to retrived Inbound Site against the location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_344"}},"schemaId":"schema_344","pointer":"/paths/~1api~1v1~1location~1inboundsites/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/location/inboundsites","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_344"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/location/inboundsites","href":"inbound-sites/getlocationinboundsite","openApiOperationId":"getLocationInboundSite","summary":"Get against locationId"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}],"schemaId":"schema_344","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_344"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAllInboundSiteAgainstLocationResponse"}},"schemaId":"components/schemas/GetAllInboundSiteAgainstLocationResponse"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1location~1inboundsites/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAllInboundSiteAgainstLocationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAllInboundSiteAgainstLocationResponse"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound-sites/getlocationinboundsite"}],"panels":[]}]},"httpPath":"/api/v1/location/inboundsites"}],"content":{"contentType":"group","meta":{"name":"Inbound sites"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inbound sites","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing inbound site records and their association with locations. Inbound sites represent physical or logical intake points where packages are received and processed. These APIs support operations such as Creating and managing inbound site hierarchy, retrieving inbound sites by filters (location, hierarchy, status), deleting inbound sites, and retrieving inbound sites mapped to specific locations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/inboundsites","summary":"Add Inbound Site","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inbound-sites/addinboundsite","deprecated":false},{"title":"/api/v1/inboundsites","summary":"Get Inbound Site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbound-sites/getinboundsite","deprecated":false},{"title":"/api/v1/inboundsites/{inboundSiteId}","summary":"Update Inbound Site","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inbound-sites/updateinboundsite","deprecated":false},{"title":"/api/v1/inboundsites/{inboundSiteId}","summary":"Delete Inbound Site","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/inbound-sites/deleteinboundsite","deprecated":false},{"title":"/api/v1/location/inboundsites","summary":"Get against locationId","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inbound-sites/getlocationinboundsite","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"type":"object","properties":{"message":{"type":"string","description":"This is HTTP 401 Unauthorized response status code, that indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource."}},"required":["message"]}},"components/schemas/Errors":{"id":"components/schemas/Errors","kind":"json-schema","title":"Errors","data":{"type":"object","properties":{"errors":{"type":"array","description":"List of errors.","items":{"type":"object","properties":{"errorCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This error can be validation_error or internal_error or not_found or already_exists"},"children":[]}]}]}],"example":"validation_error"},"errorDescription":{"type":"string","description":"The HTTP 400 Bad Request response status code indicates that the server cannot process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","example":"Asset not found."},"additionalCode":{"type":"string","description":"A unique identifier for the error","example":"020005"},"additionalInfo":{"type":"string","description":" additional information of the error.","example":"additional information"},"additionalParameters":{"type":"string","description":"The field(s) that might be incorrect in the request.","example":"additional parameters"},"correlationID":{"type":"string","description":"","example":"correlationId"}}}}}}},"components/schemas/Image":{"id":"components/schemas/Image","kind":"json-schema","title":"Image","data":{"type":"object","properties":{"imageId":{"type":"string","description":"Unique identifier for the uploaded image.","example":"img12345"},"tempURL":{"type":"string","description":"Temporary URL to access the uploaded image.","example":"temp/images/a5qk9gR1X85v"},"imageType":{"type":"string","description":"Type or format of the uploaded image.","example":"PHOTO"}}}},"components/schemas/PackageArchiveRequest":{"id":"components/schemas/PackageArchiveRequest","kind":"json-schema","title":"PackageArchiveRequest","data":{"type":"object","properties":{"archived":{"type":"boolean","description":"set to true to archive the package.","example":true}}}},"components/schemas/AddUpdateRequestDTO":{"id":"components/schemas/AddUpdateRequestDTO","kind":"json-schema","title":"AddUpdateRequestDTO","data":{"type":"object","required":["package"],"properties":{"package":{"type":"object","properties":{"trackingNumber":{"type":"string","description":"The tracking number associated with the asset to be updated.","example":"TB123456789ABCE"},"assetType":{"type":"string","description":"The type of the asset.","example":"PACKAGE","enum":["PACKAGE","POUCH"]},"damaged":{"type":"boolean","description":"Indicates whether the package is marked as damaged.","example":false},"timezone":{"type":"integer","description":"The timezone offset of the asset's current location in minutes.","example":-330},"sender":{"type":"object","description":"Details of the sender for the package.","properties":{"contactId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact ID for the sender selected for the package. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" corresponds to the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the address book for a contact with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType: SENDER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType: ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"5f508e6baa797f3c3d092307"}}},"receiver":{"type":"object","description":"Details of the receiver for the package.","properties":{"contactId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact ID for the recipient selected for the package. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" corresponds to the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the address book for a contact with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType: RECEIVER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType: ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"5f508e6baa797f3c3d092307"}}},"givenTo":{"type":"object","description":"Details of the person or entity the last activity is assigned to.","properties":{"contactId":{"type":"string","description":"The Contact ID of the person or entity the last activity is assigned to.","example":"5f508e6baa797f3c3d092307"}}},"comment":{"type":"string","description":"Optional comments or notes related to the package.","example":"User comments"},"confirmationType":{"type":"string","description":"Confirmation type","example":"PHONE"},"additionalConfirmationType":{"type":"string","description":"Additional confirmation type","example":"SIGNATURE"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of custom fields associated with the package."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields are additional package fields that can be added to display on PitneyTrack workflow pages."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These fields can be defined from the 'My Settings' page in platform settings."},"children":[]}]}]}]}}},"lastActivity":{"type":"object","properties":{"status":{"type":"string","description":"The updated status of the last activity performed on the package.","example":"RECEIVED"},"location":{"type":"object","description":"Details of the location where the last activity occurred.","properties":{"inboundSiteId":{"type":"string","description":"The unique identifier of the inbound site where the package was last processed.","example":"zy0a23Bo4Gn0"}}}}},"images":{"description":"List of images related to the packages.","type":"array","items":{"type":"object","properties":{"imageLevel":{"type":"string","description":"Level of the image to be added with the package.","example":"ASSET"},"imageType":{"type":"string","description":"Type of the image to be added with the package.","example":"PHOTO"},"tempURL":{"type":"string","description":"Temporary URL for accessing the image to be added with the packae.","example":"temp/images/vvrbWY3rRBz"},"contentType":{"type":"string","description":"Content type of the image to be added with the package.","example":"image/png"}}}}}}},"components/schemas/AddUpdateResponseDTO":{"id":"components/schemas/AddUpdateResponseDTO","kind":"json-schema","title":"AddUpdateResponseDTO","data":{"type":"object","properties":{"packageId":{"type":"string","description":"Unique identifier generated for the package","example":"NeLnz9LZ1j4KK5WlEOlyW"},"trackingNumber":{"type":"string","description":"Tracking number associated with the package","example":"PB4OZAWWNPBGB"},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"}}}}},"components/schemas/CarrierLookupResponseDTO":{"id":"components/schemas/CarrierLookupResponseDTO","kind":"json-schema","title":"CarrierLookupResponseDTO","data":{"type":"object","properties":{"carriers":{"type":"array","description":"List of carriers.","items":{"type":"object","properties":{"carrierId":{"type":"string","description":"The unique identifier for the carrier.","example":"XXXX"},"name":{"type":"string","description":"The name of the carrier.","example":"Amazon"},"barcodeAware":{"type":"boolean","description":"If the carrier is barcode-aware.","example":true},"isCustom":{"type":"boolean","description":"If the carrier is a custom carrier.","example":false}}}},"recentCarriers":{"type":"array","items":{"$ref":"#/components/schemas/CarrierTrans"},"description":"List of recent carriers"},"totalCount":{"type":"integer","description":"Total count of carriers."}},"description":"Response object for carrier lookup."}},"components/schemas/CarrierTrans":{"id":"components/schemas/CarrierTrans","kind":"json-schema","title":"CarrierTrans","data":{"type":"object","properties":{"name":{"type":"string","description":"Carrier name"},"carrierId":{"type":"string","description":"Carrier ID"}}}},"components/schemas/LocationTrans":{"id":"components/schemas/LocationTrans","kind":"json-schema","title":"LocationTrans","data":{"type":"object","properties":{"inboundSiteId":{"type":"string","description":"Unique identifier of the inbound site where the package is currently located.","example":"zy0a23Bo4Gn0"},"name":{"type":"string","description":"Name of the current location of the package.","example":"Site 1CD1001RMF"},"parent":{"type":"string","description":"The parent location, indicating the immediate hierarchical parent.","example":"Site"},"type":{"type":"string","description":"Type of the current location (e.g., site, building, floor, mailstop).","example":"site"},"locationHierarchy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy path of the current location of the package in standard format, e.g., Site > Building > Floor > Mailstop."},"children":[]}]}]}],"example":"Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS"},"ancestorlist":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of ancestors in the location hierarchy, providing a traceable path to the current location.For example, [Site, Building, Floor]."},"children":[]}]}]}],"example":["k5OrZWe0ly6dg1v","gKP4RNbMzrPO","XbyR9zpPDneY"]},"topTier":{"type":"object","description":"Details of the top-tier location in the hierarchy.","properties":{"inboundSiteId":{"type":"string","description":"The unique Inbound Site ID of the top-tier location.","example":"EMPTY_SITE"},"name":{"type":"string","description":"The name of the top-tier location.","example":"EMPTY_SITE"}}}}}},"components/schemas/ContactTrans":{"id":"components/schemas/ContactTrans","kind":"json-schema","title":"ContactTrans","data":{"type":"object","properties":{"personalId":{"type":"string","description":"The unique personal identifier of the contact.","example":"jy32"},"contactId":{"type":"string","description":"The unique contact ID.","example":"5f508e6baa797f3c3d092307"},"name":{"type":"string","description":"The name of the contact.","example":"contact_name"},"company":{"type":"string","description":"The company name associated with the contact.","example":"company_name"},"phone":{"type":"string","description":"The phone number of the contact.","example":"1234567890"},"email":{"type":"string","description":"Email address of the contact.","example":"user@email.com"},"additionalEmailIds":{"type":"array","description":"Additional email addresses associated with the contact.","items":{"type":"string","example":"user@email.com"}},"location":{"$ref":"#/components/schemas/LocationTrans"},"mailStopLocation":{"$ref":"#/components/schemas/LocationTrans"}}}},"components/schemas/CustomField":{"id":"components/schemas/CustomField","kind":"json-schema","title":"CustomField","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the custom field as defined by the user in the 'My Settings' page of platform settings.","example":"End User"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the custom field. Supported values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE: The custom field is currently in use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE: The custom field is not in use."},"children":[]}]}]}]}],"example":"ACTIVE"},"customFieldId":{"type":"string","description":"Unique identifier for the custom field.","example":"o1axRY2NKxq"},"value":{"type":"string","description":"Value associated with the custom field, as set by the user.","example":"end user"}}}},"components/schemas/DetailedPackage":{"id":"components/schemas/DetailedPackage","kind":"json-schema","title":"DetailedPackage","data":{"type":"object","properties":{"package":{"$ref":"#/components/schemas/PackageResponse","description":"Details of the package."},"activities":{"type":"array","description":"List of activities with details of each activity.","items":{"type":"object","properties":{"activityId":{"type":"string","description":"The unique identifier for the activity.","example":"NWZ7lnJgOMLl"},"status":{"type":"string","description":"The current status of the activity.","example":"CREATED"},"location":{"type":"object","description":"","properties":{"inboundSiteId":{"type":"string","description":"Unique identifier of the inbound site where the package is currently located.","example":"zy0a23Bo4Gn0"},"name":{"type":"string","description":"Name of the current location of the package.","example":"Site 1CD1001RMF"},"type":{"type":"string","description":"Type of the current location (e.g., site, building, floor, mailstop).","example":"site"},"locationHierarchy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy path of the current location of the package, e.g., Site > Building > Floor > Mailstop."},"children":[]}]}]}],"example":"Site 1CD1001RMF"}}},"route":{"type":"object","description":"Details of the route associated with the activity.","example":{}},"username":{"type":"string","description":"The username associated with the activity.","example":"API-SP360-8BZWymklRPj5-DEV"},"currentState":{"type":"object","description":"Current state details of the asset associated with the activity.","example":{}}}}},"images":{"type":"array","description":"List of images related to the package.","items":{"type":"object","properties":{"imageId":{"type":"string","description":"The unique identifier for the image.","example":"7NNO1R3e1455"},"url":{"type":"string","description":"The signed URL to access the image. The URL is valid for a limited time.","example":"https://225934331380-receiving-service-artifacts-qa.s3.amazonaws.com/images/sac11be/Vlyx3zyQNr8omx6VzoR8Q/7NNO1R3e1455?X-Amz-Algorithm=AWS4-HMAC-SHA256&.........."},"contentType":{"type":"string","description":"The MIME type of the image.","example":"image/gif"}}}}}}},"components/schemas/ExpectedPackageResponse":{"id":"components/schemas/ExpectedPackageResponse","kind":"json-schema","title":"ExpectedPackageResponse","data":{"type":"object","properties":{"trackingNumber":{"type":"string","description":"Tracking number of the package"},"recipientName":{"type":"string","description":"Name of the recipient"},"senderName":{"type":"string","description":"Name of the sender"},"carrierId":{"type":"string","description":"ID of the carrier"},"carrierService":{"type":"string","description":"Carrier service used for the package"}},"description":"Details of an expected package response"}},"components/schemas/GetResponseDTO":{"id":"components/schemas/GetResponseDTO","kind":"json-schema","title":"GetResponseDTO","data":{"type":"object","properties":{"package":{"$ref":"#/components/schemas/PackageResponse","description":"Details of the package"},"decodedCarriers":{"type":"array","description":"A list of decoded carriers associated with the request.","items":{"type":"object","properties":{"trackingNum":{"type":"string","description":"The tracking number decoded for the carrier.","example":"PBLZQ93PMANYPO"}}}}}}},"components/schemas/PackageBase":{"id":"components/schemas/PackageBase","kind":"json-schema","title":"PackageBase","data":{"type":"object","properties":{"trackingNumber":{"type":"string","description":"Tracking number of the package.","example":"PBYV4PVRBYLAAW"},"carrier":{"type":"object","properties":{"carrierId":{"type":"string","description":"The unique identifier of the carrier being used.","example":"FedEx"},"name":{"type":"string","description":"Name of the carrier used.","example":"FedEx"}}},"damaged":{"type":"boolean","description":"Whether the package is damaged","example":false},"comment":{"type":"string","description":"Comment on the package","example":"user_comment"},"currentLocation":{"$ref":"#/components/schemas/LocationTrans","description":"Current location of the asset"},"currentStatus":{"type":"string","description":"Current status of the package.","example":"RECEIVED"},"confirmationType":{"type":"string","description":"The type of confirmation captured during the delivery of the package. Indicates proof of delivery, such as PHONE.","example":"PHONE"},"additionalConfirmationType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An additional type of confirmation captured during the delivery.          Like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmationType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it can include values like SIGNATURE."},"children":[]}]}]}],"example":"SIGNATURE"},"timezone":{"type":"integer","description":"Timezone offset of the package location in minutes.","example":-330},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of custom fields associated with the package."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields are additional package fields that can be added to display on PitneyTrack workflow pages."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These fields can be defined from the 'My Settings' page in platform settings."},"children":[]}]}]}]}}}},"components/schemas/PackageResponse":{"id":"components/schemas/PackageResponse","kind":"json-schema","title":"PackageResponse","data":{"allOf":[{"$ref":"#/components/schemas/PackageBase"}],"properties":{"packageId":{"type":"string","description":" Unique identifier of the Package","example":"LMQmVaVXXxyQyZv1l2EkO"},"sender":{"$ref":"#/components/schemas/ContactTrans"},"receiver":{"$ref":"#/components/schemas/ContactTrans"},"givenTo":{"$ref":"#/components/schemas/ContactTrans"}}}},"components/schemas/AddPackageRequestBody":{"id":"components/schemas/AddPackageRequestBody","kind":"json-schema","title":"AddPackageRequestBody","data":{"type":"object","required":["package"],"properties":{"package":{"description":"Details of the package to be added.","type":"object","properties":{"trackingNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a unique tracking number to be associated with the package. This tracking number can be generated using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Generate Unique Tracking Number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]}],"example":"PB7WMALJAWRMJW"},"assetType":{"type":"string","description":"Type of the package to be added.","example":"PACKAGE","enum":["PACKAGE","POUCH"]},"damaged":{"type":"boolean","description":"If the package is damaged or not.","example":false},"timezone":{"type":"integer","description":"Timezone offset of the package location in minutes.","example":-330},"carrier":{"type":"object","properties":{"carrierId":{"type":"string","description":"The unique identifier of the carrier being used.","example":"FedEx"}}},"currentStatus":{"type":"string","description":"Current status of the package.","example":"RECEIVED"},"customFields":{"type":"array","description":"List of custom fields associated with the package. \nCustom fields are additional package fields that can be added to display on PitneyTrack workflow pages.\nThese fields can be defined from the 'My Settings' page in platform settings.\"\n","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the custom field as defined by the user in the 'My Settings' page of platform settings.","example":"End User"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the custom field. Supported values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE: The custom field is currently in use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE: The custom field is not in use."},"children":[]}]}]}]}],"example":"ACTIVE","enum":["ACTIVE","INACTIVE"]},"customFieldId":{"type":"string","description":"Unique identifier for the custom field.\n","example":"o1axRY2NKxq"},"value":{"type":"string","description":"Value associated with the custom field, as set by the user.\nexample: \"user name\"\n"}}}},"sender":{"type":"object","description":"Details of the sender for the package.","properties":{"contactId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact ID for the sender selected for the package. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" corresponds to the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the address book for a contact with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType: SENDER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType: ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"5f508e6baa797f3c3d092307"}}},"receiver":{"type":"object","description":"Details of the receiver for the package.","properties":{"contactId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact ID for the recipient selected for the package. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" corresponds to the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the address book for a contact with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType: RECEIVER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactType: ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"5f508e6baa797f3c3d092307"}}},"givenTo":{"type":"object","description":"Details of the person or entity the last activity is assigned to.","properties":{"contactId":{"type":"string","description":"The Contact ID of the person or entity the last activity is assigned to.","example":"5f508e6baa797f3c3d092307"}}},"comment":{"type":"string","description":"Optional comments or additional information about the package.","example":"User comments"},"confirmationType":{"type":"string","description":"The type of confirmation captured during the delivery of the package. \nIndicates proof of delivery, such as PHONE.\n","example":"PHONE"},"additionalConfirmationType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An additional type of confirmation captured during the delivery."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmationType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it can include values like SIGNATURE."},"children":[]}]}]}],"example":"SIGNATURE"}}},"lastActivity":{"type":"object","properties":{"status":{"type":"string","description":"The updated status of the last activity performed on the package.","example":"RECEIVED"},"location":{"type":"object","properties":{"inboundSiteId":{"type":"string","description":"Unique identifier of the inbound site where the package is currently located.","example":"zy0a23Bo4Gn0"}}}}},"images":{"description":"List of images related to the packages.","type":"array","items":{"type":"object","properties":{"imageLevel":{"type":"string","description":"Level of the image to be added with the package.","example":"ASSET"},"imageType":{"type":"string","description":"Type of the image to be added with the package.","example":"PHOTO"},"tempURL":{"type":"string","description":"Temporary URL for accessing the image to be added with the packae.","example":"temp/images/vvrbWY3rRBz"},"contentType":{"type":"string","description":"Content type of the image to be added with the package.","example":"image/png"}}}}}}},"components/schemas/AddPackageResponseBody":{"id":"components/schemas/AddPackageResponseBody","kind":"json-schema","title":"AddPackageResponseBody","data":{"type":"object","properties":{"packageId":{"type":"string","description":"Unique identifier generated for the package","example":"NeLnz9LZ1j4KK5WlEOlyW"},"trackingNumber":{"type":"string","description":"Tracking number associated with the package","example":"PB4OZAWWNPBGB"},"images":{"type":"array","items":{"type":"object","description":"List of images associated with the package","properties":{"contentType":{"type":"string","description":"The MIME type of the image.","example":"image/gif"},"imageId":{"type":"string","description":"The unique identifier for the image associated with the package.","example":"7NNO1R3e1455"},"url":{"type":"string","description":"The URL where the image stored.","example":"https://225934331380-receiving-service-artifacts-qa.s3.amazonaws.com/images/sac11be/Vlyx3zyQNr8omx6VzoR8Q/7NNO1R3e1455"}}}}}}},"components/schemas/SearchAssetResponseBody":{"id":"components/schemas/SearchAssetResponseBody","kind":"json-schema","title":"SearchAssetResponseBody","data":{"type":"object","properties":{"packages":{"type":"array","description":"List of packages associated with the request.","items":{"type":"object","properties":{"packageId":{"type":"string","description":"Unique identifier for the package.","example":"X0vYqQp3obMPEM2DAlPwz"},"insertTimestamp":{"type":"string","format":"date-time","description":"The timestamp when the package was added.","example":"2025-02-13T07:12:28.302Z"},"updateTimestamp":{"type":"string","format":"date-time","description":"The timestamp when the package was last updated.","example":"2025-02-13T07:12:28.302Z"},"trackingNumber":{"type":"string","description":"Tracking number assigned to the package.","example":"XYZ123456"},"carrier":{"type":"object","properties":{"carrierId":{"type":"string","description":"The unique identifier of the carrier being used.","example":"FedEx"},"name":{"type":"string","description":"Name of the carrier used.","example":"FedEx"}}},"assetType":{"type":"string","description":"Type of the asset (e.g., PACKAGE or POUCH)","example":"PACKAGE"},"damaged":{"type":"boolean","description":"If the package is marked damaged.","example":false},"sender":{"$ref":"#/components/schemas/ContactTrans","description":"The contact details of the individual or organization that sent the package."},"receiver":{"$ref":"#/components/schemas/ContactTrans","description":"The contact details of the individual or organization designated to receive the package."},"givenTo":{"$ref":"#/components/schemas/ContactTrans","description":"The contact details of the person or entity to whom the package was handed over during the last activity or status update."},"comment":{"type":"string","description":"User comments on the package.","example":"User comments"},"currentLocation":{"type":"object","description":"Current location details of the package.","properties":{"inboundSiteId":{"type":"string","description":"Unique identifier of the inbound site where the package is currently located.","example":"zy0a23Bo4Gn0"},"name":{"type":"string","description":"Name of the current location of the package.","example":"Noida, Office of CG"},"type":{"type":"string","description":"Type of the current location (e.g., site, building, floor, mailstop).","example":"site"},"locationHierarchy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy path of the current location of the package  e.g., Site > Building > Floor > Mailstop"},"children":[]}]}]}],"example":"Noida, Office of CG"}}},"currentStatus":{"type":"string","description":"Current status of the package.","example":"RECEIVED"},"confirmationType":{"type":"string","description":"The type of confirmation captured during the delivery of the package. \nIndicates proof of delivery, such as PHONE.\n","example":"PHONE"},"additionalConfirmationType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An additional type of confirmation captured during the delivery."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmationType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it can include values like SIGNATURE."},"children":[]}]}]}]},"timezone":{"type":"integer","description":"The timezone offset of the package in minutes.","example":-330},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of custom fields associated with the package."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields are additional package fields that can be added to display on PitneyTrack workflow pages."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These fields can be defined from the 'My Settings' page in platform settings."},"children":[]}]}]}]}}}},"totalCount":{"type":"integer","description":"Total count of packages returned in the response.","example":1}}}},"components/schemas/AddInboundSiteDTOForSite":{"id":"components/schemas/AddInboundSiteDTOForSite","kind":"json-schema","title":"AddInboundSiteDTOForSite","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the inbound site to be added.","example":"Site A"},"type":{"type":"string","description":"The type of the inbound site","example":"site"},"locationId":{"type":"string","description":"The location ID associated with the inbound site.","example":"M0K9QbNMgob"},"defaultSite":{"type":"boolean","description":"Indicates if this is the default site.","example":true}},"required":["name","type","status","locationId"],"additionalProperties":false}},"components/schemas/AddInboundSiteDTOForOtherType":{"id":"components/schemas/AddInboundSiteDTOForOtherType","kind":"json-schema","title":"AddInboundSiteDTOForOtherType","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the inbound site type to be added.","example":"Building-A"},"type":{"type":"string","enum":["building","mailstop","floor","office"],"description":"The type of the inbound site","example":"building"},"parent":{"type":"string","description":"This is the inboundSiteId of parent to which this type should belongs to, for example in case of type building, Site is the parent. User first need to generate Parent Inbound Site ID.","example":"5g6gg9DYO3WN"},"defaultSite":{"type":"boolean","description":"Indicates if this is the default site.","example":true}},"required":["name","type","status","parent"],"additionalProperties":false}},"components/schemas/GetAllInboundSitesResponse":{"id":"components/schemas/GetAllInboundSitesResponse","kind":"json-schema","title":"GetAllInboundSitesResponse","data":{"type":"object","properties":{"inboundsites":{"type":"array","items":{"$ref":"#/components/schemas/InboundSiteResponse"},"description":"List of inbound sites"},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}}}},"components/schemas/InboundSiteResponse":{"id":"components/schemas/InboundSiteResponse","kind":"json-schema","title":"InboundSiteResponse","data":{"type":"object","properties":{"inboundSiteId":{"type":"string","description":"A unique identifier assigned to the inbound site.","example":"xy277mD9Plbl"},"name":{"type":"string","description":"The name of the inbound site.","example":"Gandhi Nagar"},"type":{"type":"string","description":"The type of the inbound site that is Site, Building, Floor, Mailstop.","example":"site"},"locationId":{"type":"string","description":"The unique identifier of the location associated with the inbound site.","example":"M0K9QbNMgob"},"locationHierarchy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hierarchical structure of the inbound site's location (e.g., Site > Building > Floor > Mailstop)."},"children":[]}]}]}],"example":"Gandhi Nagar"},"status":{"type":"string","description":"The current status of the inbound site, such as ACTIVE or INACTIVE.","example":"ACTIVE"},"defaultSite":{"type":"boolean","description":"Indicates whether this inbound site is the default site in the system.","example":false}},"additionalProperties":false}},"components/schemas/PageInfo":{"id":"components/schemas/PageInfo","kind":"json-schema","title":"PageInfo","data":{"type":"object","properties":{"totalCount":{"type":"integer","description":"The total number of items available across all pages.","example":9},"startCount":{"type":"integer","description":"The starting position of the first item on the current page.","example":1},"limit":{"type":"integer","description":"The maximum number of items that can be displayed on a single page.","example":10}}}},"components/schemas/UpdateInboundSiteDTO":{"id":"components/schemas/UpdateInboundSiteDTO","kind":"json-schema","title":"UpdateInboundSiteDTO","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the inbound site to be updated.","example":"Site A"},"type":{"type":"string","description":"The type of the inbound site, such as Site, Building etc.","example":"site"},"locationId":{"type":"string","description":"The unique identifier of the location associated with the inbound site.","example":"loc123"},"inboundSiteId":{"type":"string","description":"The unique identifier of the inbound site to be updated.","example":"INB123"},"status":{"type":"string","description":"The current status of the inbound site, such as Active or Inactive.","example":"Active"},"defaultSite":{"type":"boolean","description":"Indicates whether this is the default inbound site.","example":true},"parent":{"type":"string","description":"This is the inboundSiteId of parent to which this type should belongs to, for example in case of type building, Site is the parent. In case of updating Building, Floor, floor or Mailstop, user must pass its parent inbound site serviceID.","example":"GNgzzLNQ9zBb"}},"required":["name","type","status","defaultSite","locationId"],"additionalProperties":false}},"components/schemas/GetAllInboundSiteAgainstLocationResponse":{"id":"components/schemas/GetAllInboundSiteAgainstLocationResponse","kind":"json-schema","title":"GetAllInboundSiteAgainstLocationResponse","data":{"type":"array","items":{"$ref":"#/components/schemas/InboundSiteResponse"},"description":"List of inbound sites."}},"components/schemas/SearchPackagesRequest":{"id":"components/schemas/SearchPackagesRequest","kind":"json-schema","title":"SearchPackagesRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines custom header mappings for package search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each key represents a package response field, and each value represents the custom header label to be used for that field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body is a key-value mapping used to define custom headers for the package search response."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key (Field Name):"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the actual package field from the system."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This can include nested fields using dot notation (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currentLocation.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"givenTo.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currentRoute.routeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value (Header Label):"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the custom header name for the corresponding field in the response output."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This mapping allows users to control how package data fields are labeled when returned in response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"packageId\": \"Package Identifier\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → Returns the packageId field as \"Package Identifier\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"currentLocation.name\": \"Site Name\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → Returns current location name as \"Site Name\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryClerk: \"Delivered By\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → Returns delivery clerk name as \"Delivered By\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An empty object can be passed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no mappings are provided, the API returns all package fields using their default field names."},"children":[]}]}]}]}],"additionalProperties":{"type":"string"},"example":{"subId":"subID","userName":"Operator","insertTimestamp":"ReceivedDate","packageId":"Package ID","currentLocation.name":"Site Name","currentStatus":"Status","locationZip":"Location ZIP","lockerBank":"Locker Bank","deliveryClerk":"Delivered By","receiveClerk":"Received By","givenTo.name":"Given To","currentRoute.routeName":"Route","deliveryTime":"Delivery Time"}}},"components/schemas/SearchPackagesResponse":{"id":"components/schemas/SearchPackagesResponse","kind":"json-schema","title":"SearchPackagesResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns package records with fields labeled based on the provided custom header mappings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each package object contains dynamic key-value pairs where:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Custom header label defined in the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Corresponding package field value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no mappings are provided in the request, the response returns package fields using their default field names."},"children":[]}]}]}],"properties":{"packages":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns package records with fields labeled based on the provided custom header mappings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each package object contains dynamic key-value pairs where:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Custom header label defined in the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Corresponding package field value"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no mappings are provided in the request, the response returns package fields using their default field names."},"children":[]}]}]}],"items":{"type":"object","description":"Represents a package record with dynamic fields.\n\nThe keys in this object correspond to the custom header labels defined in the request body.\n","additionalProperties":{"type":"string","description":"Value of the corresponding package field."}}},"totalCount":{"type":"integer","description":"Total number of package records returned.","example":20}},"example":{"packages":[{"Bank":"Sector 142 LockerBank","DT":"","Delivered By":"","Given To":"","JvoZmPNeYGWlKR0w7gKlR":"lkgP5Xb0r32AMKK6w2z6E","Operator":"pse US Sanity","ReceivedDate":"2026-04-09T13:58:17.394Z","Route":"Delhi Route","SiteName":"API_Site_Update","Status":"RECEIVED","locZip":"06810","subID":"sac11be"}],"totalCount":1}}},"schema_322":{"kind":"json-schema","data":{"type":"number","description":"The tracking numebr to be decoded."},"id":"schema_322"},"schema_323":{"kind":"json-schema","data":{"type":"boolean","description":"Indicates if the decoded asset is part of an expected package. Set to 'true' for expected packages."},"id":"schema_323"},"schema_324":{"kind":"json-schema","data":{"type":"boolean","description":""},"id":"schema_324"},"schema_325":{"kind":"json-schema","data":{"type":"object","properties":{"trackingNumber":{"type":"string","description":"This is the generated tracking number.","example":"PBGWPV69YBKNY"}}},"id":"schema_325"},"schema_326":{"kind":"json-schema","data":{"type":"string"},"id":"schema_326"},"schema_327":{"kind":"json-schema","data":{"type":"object","properties":{"base64":{"type":"string","description":"This is the image data must be provided in Base64 format.","example":"data:image/gif;base64,R0lGODlhPQBEAPeoAJosM//AwO/AwHVYZ/z595kzAP/s7P+goOXMv8+fhw/v739/f+8PD98fH/8mJl+fn/9ZWb8/PzWlwv///6wWGbImAPgTEMImIN9gUFCEm/gDALULDN8PAD6atYdCTX9gUNKlj8wZAKUsAOzZz+UMAOsJAP/Z2ccMDA8PD/95eX5NWvsJCOVNQPtfX/8zM8+QePLl38MGBr8JCP+zs9myn/8GBqwpAP/GxgwJCPny78lzYLgjAJ8vAP9fX/+MjMUcAN8zM/9wcM8ZGcATEL+QePdZWf/29uc/P9cmJu9MTDImIN+/r7+/vz8/P8VNQGNugV8AAF9fX8swMNgTAFlDOICAgPNSUnNWSMQ5MBAQEJE3QPIGAM9AQMqGcG9vb6MhJsEdGM8vLx8fH98AANIWAMuQeL8fABkTEPPQ0OM5OSYdGFl5jo+Pj/+pqcsTE78wMFNGQLYmID4dGPvd3UBAQJmTkP+8vH9QUK+vr8ZWSHpzcJMmILdwcLOGcHRQUHxwcK9PT9DQ0O/v70w5MLypoG8wKOuwsP/g4P/Q0IcwKEswKMl8aJ9fX2xjdOtGRs/Pz+Dg4GImIP8gIH0sKEAwKKmTiKZ8aB/f39Wsl+LFt8dgUE9PT5x5aHBwcP+AgP+WltdgYMyZfyywz78AAAAAAAD///8AAP9mZv///wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAEAAKgALAAAAAA9AEQAAAj/AFEJHEiwoMGDCBMqXMiwocAbBww4nEhxoYkUpzJGrMixogkfGUNqlNixJEIDB0SqHGmyJSojM1bKZOmyop0gM3Oe2liTISKMOoPy7GnwY9CjIYcSRYm0aVKSLmE6nfq05QycVLPuhDrxBlCtYJUqNAq2bNWEBj6ZXRuyxZyDRtqwnXvkhACDV+euTeJm1Ki7A73qNWtFiF+/gA95Gly2CJLDhwEHMOUAAuOpLYDEgBxZ4GRTlC1fDnpkM+fOqD6DDj1aZpITp0dtGCDhr+fVuCu3zlg49ijaokTZTo27uG7Gjn2P+hI8+PDPERoUB318bWbfAJ5sUNFcuGRTYUqV/3ogfXp1rWlMc6awJjiAAd2fm4ogXjz56aypOoIde4OE5u/F9x199dlXnnGiHZWEYbGpsAEA3QXYnHwEFliKAgswgJ8LPeiUXGwedCAKABACCN+EA1pYIIYaFlcDhytd51sGAJbo3onOpajiihlO92KHGaUXGwWjUBChjSPiWJuOO/LYIm4v1tXfE6J4gCSJEZ7YgRYUNrkji9P55sF/ogxw5ZkSqIDaZBV6aSGYq/lGZplndkckZ98xoICbTcIJGQAZcNmdmUc210hs35nCyJ58fgmIKX5RQGOZowxaZwYA+JaoKQwswGijBV4C6SiTUmpphMspJx9unX4KaimjDv9aaXOEBteBqmuuxgEHoLX6Kqx+yXqqBANsgCtit4FWQAEkrNbpq7HSOmtwag5w57GrmlJBASEU18ADjUYb3ADTinIttsgSB1oJFfA63bduimuqKB1keqwUhoCSK374wbujvOSu4QG6UvxBRydcpKsav++Ca6G8A6Pr1x2kVMyHwsVxUALDq/krnrhPSOzXG1lUTIoffqGR7Goi2MAxbv6O2kEG56I7CSlRsEFKFVyovDJoIRTg7sugNRDGqCJzJgcKE0ywc0ELm6KBCCJo8DIPFeCWNGcyqNFE06ToAfV0HBRgxsvLThHn1oddQMrXj5DyAQgjEHSAJMWZwS3HPxT/QMbabI/iBCliMLEJKX2EEkomBAUCxRi42VDADxyTYDVogV+wSChqmKxEKCDAYFDFj4OmwbY7bDGdBhtrnTQYOigeChUmc1K3QTnAUfEgGFgAWt88hKA6aCRIXhxnQ1yg3BCayK44EWdkUQcBByEQChFXfCB776aQsG0BIlQgQgE8qO26X1h8cEUep8ngRBnOy74E9QgRgEAC8SvOfQkh7FDBDmS43PmGoIiKUUEGkMEC/PJHgxw0xH74yx/3XnaYRJgMB8obxQW6kL9QYEJ0FIFgByfIL7/IQAlvQwEpnAC7DtLNJCKUoO/w45c44GwCXiAFB/OXAATQryUxdN4LfFiwgjCNYg+kYMIEFkCKDs6PKAIJouyGWMS1FSKJOMRB/BoIxYJIUXFUxNwoIkEKPAgCBZSQHQ1A2EWDfDEUVLyADj5AChSIQW6gu10bE/JG2VnCZGfo4R4d0sdQoBAHhPjhIB94v/wRoRKQWGRHgrhGSQJxCS+0pCZbEhAAOw=="}}},"id":"schema_327"},"schema_328":{"kind":"json-schema","data":{"type":"object","properties":{"imageId":{"type":"string","description":"Unique identifier for the created image.","example":"img12345"},"tempURL":{"type":"string","description":"Temporary URL to access the created image.","example":"temp/images/dvRyaqpDBJ0m"},"contentType":{"type":"string","description":"The content type of the created image.","example":"image/gif"}}},"id":"schema_328"},"schema_329":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_329"},"schema_330":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_330"},"schema_331":{"kind":"json-schema","data":{"type":"object","example":{"subId":"subID","userName":"Operator","insertTimestamp":"ReceivedDate","packageId":"Package ID","currentLocation.name":"Site Name","currentStatus":"Status","locationZip":"Location ZIP","lockerBank":"Locker Bank","deliveryClerk":"Delivered By","receiveClerk":"Received By","givenTo.name":"Given To","currentRoute.routeName":"Route","deliveryTime":"Delivery Time"}},"id":"schema_331"},"schema_332":{"kind":"json-schema","data":{"type":"string","enum":["IMAGES","ACTIVITIES","DETAILED"]},"id":"schema_332"},"schema_333":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/DetailedPackage"}]},"id":"schema_333"},"schema_334":{"kind":"json-schema","data":{"type":"object","properties":{"packageId":{"type":"string","description":"The unique identifier for the package.","example":"ma39N30J6YgdxndDpXyOj"}}},"id":"schema_334"},"schema_335":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","description":"An array containing locations. Each element is a string representing one or more locations. If multiple locations are provided, they should be comma-separated.","example":"B9Ol8nDqpq1"}},"id":"schema_335"},"schema_336":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/AddInboundSiteDTOForSite"},{"$ref":"#/components/schemas/AddInboundSiteDTOForOtherType"}]},"id":"schema_336"},"schema_337":{"kind":"json-schema","data":{"type":"object","properties":{"inboundSiteId":{"type":"string","example":"zADZNQ1VWvvA"}}},"id":"schema_337"},"schema_338":{"kind":"json-schema","data":{"type":"integer","description":"Number of records to skip from the beginning."},"id":"schema_338"},"schema_339":{"kind":"json-schema","data":{"type":"integer","description":"Maximum number of records to return in one response."},"id":"schema_339"},"schema_340":{"kind":"json-schema","data":{"type":"string","description":"Sorts the results by a specific field in ascending (ASC) or descending (DESC) order."},"id":"schema_340"},"schema_341":{"kind":"json-schema","data":{"type":"string","description":"Finds inbound sites based on a relationship with another site."},"id":"schema_341"},"schema_342":{"kind":"json-schema","data":{"type":"string","enum":["active","inactive"]},"id":"schema_342"},"schema_343":{"kind":"json-schema","data":{"type":"string","description":"This is the identifier of the Inbound Site to be deleted."},"id":"schema_343"},"schema_344":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"},"example":["location1","location2"]},"id":"schema_344"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/pitneytrack","description":"Production Server (uses live data)"}]},"options":{"hideDownloadButtons":false,"hideInfoMetadata":true,"jsonSamplesExpandLevel":3,"layout":"three-panel","schemasExpansionLevel":2,"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Go"},{"lang":"Java"},{"lang":"C#"}]},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/receiving.json?download"},{"url":"/_bundle/openapi/receiving.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Receiving APIs","description":"\nThe **Pitney Bowes Receiving APIs** help manage packages from the moment they arrive at a facility until they are delivered to the final recipient. These APIs allow organizations to track, update, and store package details, helping to manage internal package handling efficiently.\n\n**Why Receiving APIs**\n\n  1. Track every package from arrival to final delivery.\n  2. Maintain a complete history of package status and movements.\n  3. Update the current package details.\n  4. Quickly find packages within the system using tracking numbers or other search criteria.\n\n**How Receiving APIs Work**\n\n  When a package arrives at a facility, it may have a barcode that either includes a tracking number or does not.\n\n  1.\tIf the **barcode contains a tracking number**:\n\n      - The system searches for an existing package with the same tracking number.\n\n      - If no package exists, a new package entry is created.\n\n  2.\tIf the **package does not have a tracking number**:\n\n      - A new tracking number is generated.\n\n      - A new package entry is created.\n\n  3.\tOnce package added to the system, It can be tracked, and its details can be updated to reflect its current status, location, or latest activity.\n\n  4.\tWhen the package is delivered to its destination, it can be archived for record-keeping.\n\n**Step-by-Step Workflow for Receiving APIs**\n\n  This section provides a structured process for handling packages using the Pitney Bowes Receiving APIs.\n\n**Step 1: Decode the Barcode on a Package**\n\n  1.\tPackages with barcodes must be scanned first. \n  2.\tIf the barcode contains a tracking number, use the [Decode Tracking Number](/openapi/receiving/decode/decodetrackingnumber) API to extract key details, such as:\n      - Tracking number\n      - Package type\n      - Carrier service\n      - Sender and receiver information\n      - Current location\n  3.\tThe Decode API supports 2D barcodes.\n\n**Step 2: Generate a Unique Tracking Number (If Required)**\n\n  1. If a package does not have a tracking number, the user first needs to assign a unique tracking number to the package.\n  2. The [Generate Tracking Number](/openapi/receiving/packages/createtrackingnumber) API creates a unique tracking number, which serves as an identifier throughout the package lifecycle.\n\n**Step 3: Add Package to the System**\n\n  1. Every package must be added to the system using its tracking number.\n  2. The system verifies that no duplicate tracking number exists. If a duplicate is found, an error is returned.\n  3. Upon successful addition, the package is assigned a unique Package ID for tracking.\n  4. The package is linked to relevant sender and receiver information.\n\n**Additional Information to add a Package:**\n\n  **Tracking Number:** Each package must have a unique tracking number.\n\n  **Contact ID:**\n\n  - Contacts can be of three types: Sender, Receiver, and Given To.\n  - Contacts must be created first using the [Add Contact](/openapi/addressbook/contact/addcontact) API (Address Book APIs).\n  - Once added, the system generates a unique Contact ID for each contact, which is used when adding a package.\n\n  **Custom Fields:** Additional custom details can be associated with the package. Fetch the Custom fields using the [Get Custom Field](/openapi/customfields/custom-fields/getcustomfield) API.\n\n  **Inbound Site ID:** If the package needs to be linked to an inbound site location, fetch the associated Inbound Site ID using the [Get Inbound Sites](/openapi/receiving/inbound-sites/getinboundsite) APIs.\n\n**Step 4: Search for a Package in the System**\n\n  Users can find specific packages using the [Search Package](/openapi/receiving/packages/searchpackage) API by entering tracking numbers, statuses, or metadata. This API locates packages that are in transit, waiting for pickup, or already delivered.\n\n**Step 5: Retrieve Package Details**\n\n  Use the [Get Package](/openapi/receiving/packages/getpackagepackageid) API to fetch detailed information about a package.\n\n  1. The package can be retrieved using either its unique package ID or tracking number.\n\n  2. The response includes the package's history, current status, current location, and latest activity.\n\n**Step 6: Update Package Information**\n\n  Packages undergo several status changes as they move through the system. The [Update Package](/openapi/receiving/packages/updatepackage) API allows to:\n\n  1. Update package details such as status, location, sender, receiver, and confirmation methods.\n\n  2. Mark packages as DAMAGED, ARCHIVED, RECEIVED, or DELIVERED.\n\n  3. Record location changes, damage reports, or special handling requirements.\n\n  4. Attach images for proof of receipt.\n\n  5.\tAssign a package to a specific recipient within an organization.\n\n**Step 7: Archive a Package**\n\n  1. Once a package has reached its final recipient, it can be archived for record keeping using the [Archive Package](/openapi/receiving/packages/archivepackage) API. \n\n  2. The Archive Package API removes the package from active workflows while maintaining its record for future reference.\n\n**Retrieve Carrier List**\n\n  1. Get a list of carriers associated with specific locations using [Carrier List](/openapi/receiving/carrier/getcarrierlist) API.\n\n  2. This helps in knowing which carriers are responsible for incoming shipments at different facilities\n"}},"baseSlug":"/openapi/receiving","routesMapping":{}}