{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-openapi/batchshipping.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"openapi/batchshipping.yaml","dynamicMarkdocComponents":[],"baseSlug":"/openapi/batchshipping","seo":{"title":"Batch Shipment APIs","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Batch Shipment APIs","description":"The Batch Shipment APIs provide operations to create, import, process, track, and manage shipments in bulk. These APIs enable submission of multiple shipments in a single request or through file-based import, supporting high-volume shipping workflows.\n\nBatch shipment processing supports two modes:\n\n  - **Synchronous bulk** creation using API payloads\n  - **Asynchronous batch** processing using file import (CSV via S3 URL)\n\nThe APIs also support ERR (Electronic Return Receipt) shipments, allowing generation of compliant return receipt documents for USPS shipments.\n\n**Batch**\n\nA collection of shipments grouped under a single processing request, identified by batchId.\n\n**Root Level attributes (Default)**\n\nDefines common attributes (e.g., carrier, service, parcel type) applied to all shipments in the batch.\n\n**Shipment Level attributes**\n\nDefines attributes specific to individual shipments. Values provided at this level override root-level defaults.\n\n**Combination Rule**\n\n`carrierAccountId`, `parcelType`, and `serviceId` must be provided together at the shipment level. Partial values result in validation errors.\n\n**Batch ID (batchId)**\n\nA system-generated identifier used to process, track, and manage batch operations.\n\n- Bulk shipments can be created via API payload or imported using a CSV file hosted on S3\n- Batch import generates a batchId used for further processing and tracking\n- Batch processing is triggered explicitly using the `Process Batch API`\n- Batch status and shipment-level results can be retrieved using `batchId`\n- Shipments within a batch can be voided either partially (specific shipment IDs) or entire batch\n- ERR batch supports additional document formats such as **Shipping Label** and **Coversheet**\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/batchshipping","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}