{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-openapi/shipping.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"openapi/shipping.yaml","dynamicMarkdocComponents":[],"baseSlug":"/openapi/shipping","seo":{"title":"Overview","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Overview","description":"The Shipping APIs provide a unified, multi-carrier platform to rate shipments, generate labels, manage pickups, and track parcel movement from creation through delivery. These APIs support a wide range of carriers and services, enabling developers to integrate shipping functionalities into their applications with ease. The Shipping APIs are designed to handle single-parcel, multi-parcel, and high-volume workflows. They also include features for managing carrier accounts, configuring defaults, and handling post-shipment operations like reprints, cancellations, and tracking updates. With comprehensive documentation, sample code, and a sandbox environment for testing. \n\nIf you are integrating for the first time, follow this path:\n\n1. Authenticate before calling Shipping APIs\n  - Start with the [Auth API](/openapi/auth/other/getaccesstoken) to generate an OAuth access token.\n  - Send the token in the Authorization header for every request: `Authorization: Bearer <access_token>`.\n\n2. Start with account and carrier setup\n  - Use Get Carrier Accounts to identify available carrierAccountId values.\n  - Use Get Carriers, Get Services, Get Parcel Types, and Get Special Services to discover what is valid for your scenario.\n\n3. Validate shipment inputs before creating labels\n  - Confirm address quality with the Address APIs.\n  - For international shipments, prepare customs data and upload Electronic Trade Documents when required.\n\n4. Rate first, then ship\n  - Use Rate Shipment to compare options by carrier, rate group, rule set, Ship Via Code, or external system code.\n  - Use Create Shipment to generate the label once the preferred option is selected.\n\n5. Manage post-shipment operations\n  - Reprint or cancel labels when needed.\n  - Retrieve shipment details and tracking updates.\n  - Schedule pickups, check pickup availability, and generate pickup documents.\n\n6. Use Batch Shipments for high-volume processing\n  - Use Batch Shipment APIs when creating large shipment volumes.\n  - Choose synchronous bulk creation or asynchronous CSV import, then process and monitor using batchId.\n  - Use batch status, shipment-level details, and batch void operations to manage exceptions at scale.\n\n7. Optimize for production scale\n  - Use Defaults to reduce repeated request fields.\n  - Use Multipiece Shipment for multi-parcel workflows.\n  - Use metadata, references, manifests, and reports for operational control and reconciliation.\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.sendpro360.pitneycloud.com","port":4000,"ipAddress":"216.73.217.121"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"sp360comm/dev"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/openapi/shipping","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}