{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-openapi/tracking.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"openapi/tracking.yaml","dynamicMarkdocComponents":[],"baseSlug":"/openapi/tracking","seo":{"title":"Tracking APIs","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Tracking APIs","description":"The Tracking APIs provide operations to retrieve shipment tracking details and manage tracking subscriptions across supported carriers. These APIs enable access to shipment status and event history using a tracking number, supporting visibility into shipment progress and delivery.\n\nThey support both on-demand tracking retrieval and subscription-based tracking, allowing systems to monitor shipment progress and receive updates as tracking events occur.\n\n**Tracking Number**\n\nA unique identifier assigned to a shipment, used to retrieve tracking details.\n\n**Carrier**\n\nIdentifies the shipping carrier associated with the tracking number. Supported values include USPS, UPS, FEDEX, and DHLEXP.\n\n\n**Tracking Events**\n\nA collection of shipment status updates representing the lifecycle of a shipment (e.g., accepted, in transit, out for delivery, delivered).\n\n- Tracking details are retrieved using the `trackingNumber` and `carrier` parameter\n- The response includes a list of tracking events representing shipment progress\n- Subscription API allows enabling or disabling tracking updates using the subscribe parameter:\n  - true: Subscribes to tracking updates\n  - false: Unsubscribes from tracking updates\n- Subscribed tracking provides updated tracking event information in the response\n- Each request includes a unique `X-PB-TransactionId` for tracking and auditing\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.shipping360.pitneybowes.com","port":4000,"ipAddress":"216.73.217.63"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"master"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/openapi/tracking","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}