{"items":[{"type":"link","label":"Manifest APIs","link":"/openapi/manifest","routeSlug":"/openapi/manifest","content":{"contentType":"overview","meta":{"name":"Manifest APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"manifest.json","url":"/_bundle/openapi/manifest.json?download"},{"kind":"download","label":"manifest.yaml","url":"/_bundle/openapi/manifest.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/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Manifest 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":"A manifest is an end-of-day summary submitted to the carrier that groups multiple shipments into a single form or electronic record for acceptance and processing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For USPS, the manifest is generated as a SCAN form (Shipment Confirmation Acceptance Notice). A SCAN form consolidates eligible trackable shipments into a form containing one or more barcodes. When the barcode is scanned by USPS, the included shipments receive an acceptance event."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Manifest APIs also support generation and retrieval of USPS 3877 manifest documents for ERR shipments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For US originated shipments, manifest is supported for carriers: USPS, FedEx and Speedee."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For CA originated shipments, manifest is supported for carriers: FedEx and CPC."},"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":"Manifest"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A carrier submission record that groups eligible shipments into a single form or electronic record for acceptance."},"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":"SCAN Form"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The USPS manifestation format that combines eligible trackable shipments under one or more 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":"Carrier Account ID"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier of the carrier account used to determine which shipments are included in manifest operations."},"children":[]}]}]}]}],"sectionId":"/openapi/manifest"}],"sectionId":"/openapi/manifest"}]}]}},{"type":"group","label":"Manifest","link":"/openapi/manifest/manifest","routeSlug":"/openapi/manifest/manifest","items":[{"label":"Create Manifest","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/manifest/manifest/createmanifest","routeSlug":"/openapi/manifest/manifest/createmanifest","metadata":{"seo":{"title":"Create Manifest","description":"This operation creates an end-of-day manifest (a compilation of information about all shipments) that combines all shipments of the day into a single form or electronic record, depending on the carrier. For USPS®, this manifest is called a SCAN form (Shipment Confirmation Acceptance Notice), which combines all trackable shipments into a single form with a single barcode. When the carrier scans the barcode, all shipments for that barcode receive an Acceptance event from USPS. If the SCAN form includes shipments from multiple different induction postal codes, this operation generates a multi-page form with one bar code per page.Key Considerations: "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createManifest","name":"Create Manifest","isWebhook":false,"pointer":"/paths/~1api~1v1~1manifests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Manifest","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 creates an end-of-day manifest (a compilation of information about all shipments) that combines all shipments of the day into a single form or electronic record, depending on the carrier. For USPS®, this manifest is called a SCAN form (Shipment Confirmation Acceptance Notice), which combines all trackable shipments into a single form with a single barcode. When the carrier scans the barcode, all shipments for that barcode receive an Acceptance event from USPS. If the SCAN form includes shipments from multiple different induction postal codes, this operation generates a multi-page form with one bar code per page."},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Considerations:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"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":"Only shipments with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addToManifest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" shipment option set to true are eligible for inclusion in the manifest or SCAN form."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipments can be added to the SCAN form by specifying the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To generate a SCAN form for the current day, the Create Manifest request must be issued before 8 p.m. local time. Requests made after 8 p.m. require the next day's date to be specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submissionDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any eligible shipment not included in a SCAN form by 6 a.m. UTC/GMT the following calendar day will be automatically manifested."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipments, once manifested, cannot be re-manifested."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To prevent a shipment from being auto-manifested, specify the shipment's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfShipment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option during creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single Create Manifest request can include up to 7,000 shipments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USPS SCAN forms retrieved through URLs are available for 24 hours after creation."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_281","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."},{"name":"X-PB-LocationId","in":"header","schemaId":"schema_281","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The X-PB-LocationId header identifies the enterprise, division, or partner location under which a shipment is processed and billed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this header is not provided, the system automatically uses the enterprise-level location that was created during developer account onboarding. This default location is then used for shipment processing, carrier selection, and billing."},"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":"Selection Rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided and the location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one carrier with one account"},"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":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The available carrier account is selected and the manifest is created."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided and the default location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one carrier with one account"},"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":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The available carrier account is selected and the manifest is created."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided and the location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one carrier with multiple accounts"},"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":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected and the manifest is created."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided and the default location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one carrier with multiple accounts"},"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":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected and the manifest is created."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided and the location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple carriers with one account each"},"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":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and its associated account are selected and the manifest is created."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided and the default location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple carriers with one account each"},"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":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and its associated account are selected and the manifest is created."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided and the location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple carriers with multiple accounts"},"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":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected and the manifest is created."},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-PB-LocationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided and the default location has "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple carriers with multiple accounts"},"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":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected and the manifest is created."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]},{"name":"compactResponse","in":"header","schemaId":"schema_282","description":"This header defines if the response required is detailed or compact. When value is set to true, it will only return manifest details in response. "}],"pointer":"/paths/~1api~1v1~1manifests/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_283"}},"schemaId":"schema_283","pointer":"/paths/~1api~1v1~1manifests/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/manifests","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_281"},{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_281"},{"name":"compactResponse","in":"header","example":"false","schemaId":"schema_282"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_283"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/manifests","href":"manifest/createmanifest","openApiOperationId":"createManifest","summary":"Create Manifest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}],"schemaId":"schema_283","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_283"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Manifest has been generated for the given carrier.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284"}},"schemaId":"schema_284"},{"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~1manifests/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_284","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284"}}},{"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":"/manifest/createmanifest"}],"panels":[]}]},"httpPath":"/api/v1/manifests"},{"label":"Reprint manifest","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/manifest/manifest/reprintmanifest","routeSlug":"/openapi/manifest/manifest/reprintmanifest","metadata":{"seo":{"title":"Reprint manifest","description":"This operation reprints a manifest for which the initial created manifest request was successful. For USPS, up to 10 reprints of a manifest label are allowed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reprintManifest","name":"Reprint manifest","isWebhook":false,"pointer":"/paths/~1api~1v1~1manifests~1reprint/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reprint manifest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation reprints a manifest for which the initial created manifest request was successful. For USPS, up to 10 reprints of a manifest label are allowed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_281","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."},{"name":"compactResponse","in":"header","schemaId":"schema_282","description":"This header defines if the response required is detailed or compact. When value is set to true, it will only return manifest details in response."}],"pointer":"/paths/~1api~1v1~1manifests~1reprint/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_285","exampleIds":["paths/~1api~1v1~1manifests~1reprint/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_285","exampleIds":["paths/~1api~1v1~1manifests~1reprint/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1manifests~1reprint/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/manifests/reprint","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_281"},{"name":"compactResponse","in":"header","example":"false","schemaId":"schema_282"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_285","exampleIds":["paths/~1api~1v1~1manifests~1reprint/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/api/v1/manifests/reprint","href":"manifest/reprintmanifest","openApiOperationId":"reprintManifest","summary":"Reprint manifest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}],"schemaId":"schema_285","exampleIds":["paths/~1api~1v1~1manifests~1reprint/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_285","exampleIds":["paths/~1api~1v1~1manifests~1reprint/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Manifest has been printed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284"}},"schemaId":"schema_284"},{"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":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundErrors"}},"schemaId":"components/schemas/NotFoundErrors"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1manifests~1reprint/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_284","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284"}}},{"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":"404","schemaId":"components/schemas/NotFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundErrors"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manifest/reprintmanifest"}],"panels":[]}]},"httpPath":"/api/v1/manifests/reprint"},{"label":"Create Manifest Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/manifest/manifest/createusps3877document","routeSlug":"/openapi/manifest/manifest/createusps3877document","metadata":{"seo":{"title":"Create Manifest Document","description":"This operation creates a USPS 3877 manifest document for ERR shipments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUSPS3877document","name":"Create Manifest Document","isWebhook":false,"pointer":"/paths/~1api~1v1~1manifest~1document/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Manifest Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation creates a USPS 3877 manifest document for ERR shipments.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"docType","in":"query","schemaId":"schema_286","description":"The type of document to generate set to 'form3877'.","required":true}],"pointer":"/paths/~1api~1v1~1manifest~1document/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_287"}},"schemaId":"schema_287","pointer":"/paths/~1api~1v1~1manifest~1document/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/manifest/document","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[{"name":"docType","in":"query","required":true,"example":"form3877","schemaId":"schema_286"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_287"}},"responseCodes":["201","400","401","500"],"pointer":"/api/v1/manifest/document","href":"manifest/createusps3877document","openApiOperationId":"createUSPS3877document","summary":"Create Manifest Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}],"schemaId":"schema_287","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_287"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"USPS 3877 manifest document has been created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_288"}},"schemaId":"schema_288"},{"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~1manifest~1document/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_288","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_288"}}},{"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":"/manifest/createusps3877document"}],"panels":[]}]},"httpPath":"/api/v1/manifest/document"},{"label":"Get Manifest Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/manifest/manifest/get3877document","routeSlug":"/openapi/manifest/manifest/get3877document","metadata":{"seo":{"title":"Get Manifest Document","description":"This operation retrieves the USPS 3877 manifest document by manifest ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get3877document","name":"Get Manifest Document","isWebhook":false,"pointer":"/paths/~1api~1v1~1manifest~1{manifestId}~1document/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Manifest Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation retrieves the USPS 3877 manifest document by manifest ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"manifestId","in":"path","schemaId":"schema_281","description":"The unique ID of the manifest to retrieve.","required":true}],"pointer":"/paths/~1api~1v1~1manifest~1{manifestId}~1document/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"docType","in":"query","schemaId":"schema_286","description":"The type of document to retrieve. For this endpoint, set to 'form3877'.","required":true}],"pointer":"/paths/~1api~1v1~1manifest~1{manifestId}~1document/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/manifest/{manifestId}/document","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"manifestId","in":"path","required":true,"schemaId":"schema_281"}],"query":[{"name":"docType","in":"query","required":true,"example":"form3877","schemaId":"schema_286"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["201","400","401","500"],"pointer":"/api/v1/manifest/{manifestId}/document","href":"manifest/get3877document","openApiOperationId":"get3877document","summary":"Get Manifest Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","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":"201","description":"Manifest document status has been retrived successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_289"}},"schemaId":"schema_289"},{"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~1manifest~1{manifestId}~1document/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_289","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_289"}}},{"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":"/manifest/get3877document"}],"panels":[]}]},"httpPath":"/api/v1/manifest/{manifestId}/document"}],"content":{"contentType":"group","meta":{"name":"Manifest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manifest","showPageActions":true},{"nodeType":"markdoc","content":"These APIs support operations such as creating end-of-day carrier manifests, generating USPS SCAN forms, reprinting previously created manifests, creating USPS 3877 documents for ERR shipments, and retrieving manifest document status and URLs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/manifests","summary":"Create Manifest","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manifest/createmanifest","deprecated":false},{"title":"/api/v1/manifests/reprint","summary":"Reprint manifest","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manifest/reprintmanifest","deprecated":false},{"title":"/api/v1/manifest/document","summary":"Create Manifest Document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manifest/createusps3877document","deprecated":false},{"title":"/api/v1/manifest/{manifestId}/document","summary":"Get Manifest Document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manifest/get3877document","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ManifestDetailedResponse":{"id":"components/schemas/ManifestDetailedResponse","kind":"json-schema","title":"ManifestDetailedResponse","data":{"type":"object","properties":{"carrierAccountId":{"type":"string","description":"A unique identifier associated with the Carrier account which is used while creating Manifest.","example":"JORx6bVG8mr"},"carrierName":{"type":"string","description":"Name of the Carrier.","example":"USPS"},"manifestDocuments":{"type":"array","description":"The electronically generated document that has manifest (end-of-day) records of all shipments of the day.","items":{"type":"object","properties":{"contentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines whether the API returns the document as a URL or a Base64-encoded string. This field is required for PB Expedited (USPS), PB Standard, PB Presort, and PMOD. For PMOD, this field is optional if fileFormat is set to PDF. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For the valid values for your API operation, see the Labels section of the carrier’s reference page. The field’s possible values are: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- URL: The response returns a link to the label or manifest. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- BASE64: Available for shipping labels only (both delivery and return labels). The response returns the shipping label as one or more Base64-encoded strings. If you use an APAC URL, the field instead returns raw ZPL, as described in Label Settings for APAC Services."},"children":[]}]}]}],"example":"URL"},"contents":{"type":"string","description":"When contentType is URL, this is the URL to access the label or manifest. Note: The document is available for 24 hours after it is created.","example":"https://example.com/manifest.pdf"},"type":{"type":"string","description":"Specifies the type of manifest.","example":"MANIFEST"}}},"example":[{"contentType":"URL","contents":"https://example.com/manifest.pdf","type":"MANIFEST"}]},"manifestID":{"type":"string","description":"The unique manifest ID. This field is not returned for APAC Services.","example":"9475709898644001806609"},"manifestTrackingNumber":{"type":"string","description":"The manifest tracking number. This is returned only if the carrier has a pre-defined valid value, e.g., UPS, FedEX, or USPS.","example":"9475709898644001806609"},"fromAddress":{"type":"object","properties":{"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Watervw Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O.Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the sender address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits. ","example":"203-555-1213"},"countryCode":{"type":"string","description":"This indicates the two-character ISO code of the source country from the ISO country list.","example":"US"},"postalCode":{"type":"string","description":"The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":6905},"residential":{"type":"boolean","description":"The specified adress can be Residential or Official. In case if the adress is Residential, the boolean value will be 'true', else it will take 'false'.","example":false},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"}}},"parcelTrackingNumbers":{"type":"array","description":"List of parcel tracking numbers used to generate the 3877 manifest for selected shipments.","items":{"type":"string","example":"9414809898643518916081"},"example":["9405509105156006650803","9405509105156006650810"]},"options":{"type":"object","description":"Additional manifest options.","properties":{"shipperID":{"type":"string","description":"Unique identifier assigned to the shipper by the carrier. This option is subject to carrier-supported shipper identifiers. Currently, the shipper identifier is supported only by USPS.","example":"2000094635"}}},"submissionDate":{"type":"string","description":"The date the shipments are to be tendered to the carrier, entered as YYYY-MM-DD.","example":"2023-05-25"}}}},"components/schemas/ManifestCompactResponse":{"id":"components/schemas/ManifestCompactResponse","kind":"json-schema","title":"ManifestCompactResponse","data":{"type":"object","properties":{"manifestDocuments":{"type":"array","items":{"type":"object","properties":{"contentType":{"type":"string","description":"The media type of the request entity.","example":"URL"},"contents":{"type":"string","description":"The defines the contents, e.g. URL.","example":"https://example.com/manifest.pdf"},"type":{"type":"string","description":"The defines the type of contents, e.g. Manifest.","example":"MANIFEST"}}},"example":[{"contentType":"URL","contents":"https://example.com/manifest.pdf","type":"MANIFEST"}]},"manifestID":{"type":"string","example":"9475709898644001806609"},"manifestTrackingNumber":{"type":"string","example":"9475709898644001806609"}}}},"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":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code(s) that appear due to HTTP  400- Invalid or Bad Request, e.g. validation-error.","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":"Error while geting rates for carrier with carrierAccount eRMnRx4mzPP."},"additionalCode":{"type":"string","description":"A unique identifier for the error, for example 1101055, 0100008, or 1021126."},"additionalInfo":{"type":"string","description":"This is an additional information about the error. This error 'Invalid Request' might appear due to invalid dimension, weight, or serviceid, or if the information is missing."},"additionalParameters":{"type":"array","items":{"type":"string","description":"The field(s) that might be incorrect in the request."}}}}}},"components/schemas/NotFoundErrors":{"id":"components/schemas/NotFoundErrors","kind":"json-schema","title":"NotFoundErrors","data":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","example":"not_found","description":"Error code(s) that appear due HTTP 404 Page or File not found."},"errorDescription":{"type":"string","example":"resource not found","description":"The HTTP 404 Not Found response status code indicates that the server cannot find the requested resource."},"additionalCode":{"type":"string","description":"A unique identifier for the error, for example 0100025, 1110017, or 1090001."},"additionalInfo":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information about the error. This error 'Not Found' might appear due to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shipment Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No Shipments to close"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Original Transaction not found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"additionalParameters":{"type":"array","items":{"type":"string","description":"The field(s) that might be incorrect in the request."}}}}}},"schema_281":{"kind":"json-schema","data":{"type":"string"},"id":"schema_281"},"schema_282":{"kind":"json-schema","data":{"type":"boolean","example":"false"},"id":"schema_282"},"schema_283":{"kind":"json-schema","data":{"type":"object","required":["carrierAccountId","fromAddress"],"properties":{"carrier":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the carrier for the manifest."},"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":"When to provide"},"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":"Required if multiple carriers are configured for the resolved location."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional if only one carrier exists."},"children":[]}]}]}]}],"example":"USPS","type":"string"},"carrierAccountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the carrier account used for manifest processing."},"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":"When to provide"},"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":"Required if multiple accounts exist for the selected carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional if only one account exists"},"children":[]}]}]}]}]},"fromAddress":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The complete address of the Sender."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is selected using the following order of precedence:"},"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":"Request Body → Location 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":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request payload is used if available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided in the request, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the resolved location is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be resolved from any source, the request fails with a validation error."},"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":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}]}],"required":["addressLine1","postalCode","countryCode"],"properties":{"name":{"type":"string","description":"Name of the sender to which this address points.","example":"Paul Wright"},"addressLine1":{"type":"string","description":"The addressLine1 can contain the Flat number, Building or Apartment Name/number (if any) or company name (if not residential).","example":"27 Watervw Dr"},"addressLine2":{"type":"string","description":"The addressLine2 contains Street address or Landmark (if any).","example":"near abc street"},"addressLine3":{"type":"string","description":"The addressLine3 contains P.O.Box (if any) near the address.","example":"near xyz street"},"cityTown":{"type":"string","description":"The name of the city or town to where the address belongs.","example":"Stamford"},"company":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company, in case if the sender address is not residential. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PB"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This must be sender's valid email. Email is required if the customer is using GoFor Carrier. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max length = 30"},"children":[]}]}]}],"example":"testuser@gmail.com"},"phone":{"type":"string","description":"This is sender's phone number. Enter the digits with or without spaces or hyphens. The maximum limit of characters for Phone number are 10 digits. ","example":"203-555-1213"},"countryCode":{"type":"string","description":"This indicates the two-character ISO code of the source country from the ISO country list.","example":"US"},"postalCode":{"type":"string","description":"The postal code or ZIP code of the address. For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats: '12345' or '12345-6789'. If you use a different format, such as 12345- or 123451234, will receive an error.","example":6905},"residential":{"type":"boolean","description":"The specified adress can be Residential or Official. In case if the adress is Residential, the boolean value will be 'true', else it will take 'false'.","example":false},"stateProvince":{"type":"string","description":"The State or Province of the address. For a US or Canadian address, it is the 2-letter state or province code. ","example":"CT"}}},"submissionDate":{"type":"string","description":"The date the shipments are to be tendered to the carrier, entered as YYYY-MM-DD.","example":"2023-05-25"},"parcelTrackingNumbers":{"type":"array","description":"List of parcel tracking numbers used to generate manifest form for selected shipments. This option is subject to carriers supported individual parcel tracking number.","items":{"type":"string","example":"9414809898643518916081"},"example":["9405509105156006650803","9405509105156006650810"]},"options":{"type":"object","description":"Additional manifest options.","properties":{"shipperID":{"type":"string","description":"Unique identifier assigned to the shipper by the carrier. This option is subject to carrier-supported shipper identifiers. Currently, the shipper identifier is supported only by USPS.","example":"2000094635"}}}}},"id":"schema_283"},"schema_284":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ManifestDetailedResponse"},{"$ref":"#/components/schemas/ManifestCompactResponse"}]},"id":"schema_284"},"schema_285":{"kind":"json-schema","data":{"type":"object","required":["carrierAccountId","manifestID"],"properties":{"carrierAccountId":{"description":"The unique identifier associated with the Carrier account which is used while Manifest process.","type":"string","example":"JORx6bVG8mr"},"manifestID":{"type":"string","description":"A unique identifier associated to the created Manifest for a particular Carrier.","example":"1234567890"}}},"id":"schema_285"},"schema_286":{"kind":"json-schema","data":{"type":"string","example":"form3877"},"id":"schema_286"},"schema_287":{"kind":"json-schema","data":{"type":"object","required":["formAddress","shipmentType","carrierAccountId","dateOfShipment"],"properties":{"formAddress":{"type":"object","description":"The address details for the form.","properties":{"addressLine1":{"type":"string","description":"The first line of the address, such as a PO Box or street address.","example":"PO Box 8"},"countryCode":{"type":"string","description":"The two letter ISO country code.","example":"US"},"cityTown":{"type":"string","description":"The city or town name.","example":"Pago Pago"},"company":{"type":"string","description":"The name of the country if the address is not residential.","example":"PB Samoa"},"name":{"type":"string","description":"The recipient or organization name.","example":"American Samoa"},"postalCode":{"type":"string","description":"The postal or ZIP code for the pickup address. For US addresses, use either the 5-digit or 9-digit ZIP Code in one of the following formats: '12345' or '12345-6789'.","example":"96799-0018"},"stateProvince":{"type":"string","description":"The 2-letter state or province code.","example":"AS"}}},"shipmentType":{"type":"string","description":"The type of shipment. Set to 'ERR' for ERR-type shipments.","example":"ERR"},"carrierAccountId":{"type":"string","description":"The carrier account ID for the shipment.","example":"45R4zA7QAaWsiusuhu"},"dateOfShipment":{"type":"string","format":"date-time","description":"The date and time of the shipment in ISO 8601 format.","example":"2024-09-26T18:29:59.999Z"},"parcelTrackingNumbers":{"type":"array","description":"List of USPS parcel tracking numbers used to generate the 3877 manifest for selected shipments.","items":{"type":"string","example":"9414809898643518916081"},"example":["9414809898643518916081","9414809898643518916104"]}}},"id":"schema_287"},"schema_288":{"kind":"json-schema","data":{"type":"object","properties":{"manifestId":{"type":"string","description":"A unique identifier for the generated manifest.","example":"L1DRMbV5aLeMYva15jogwl"}}},"id":"schema_288"},"schema_289":{"kind":"json-schema","data":{"type":"object","properties":{"manifestId":{"type":"string","description":"The unique identifier for the manifest.","example":"ashdguyqsu12"},"status":{"type":"string","description":"Status of the manifest document retrieval.","enum":["Completed","Failed"],"example":"Completed"},"url":{"type":"string","description":"URL of the manifest document if retrieval is successful; empty if failed.","example":"https://......./....."},"error":{"type":"string","description":"Error message if the document retrieval failed.","example":"Tracking numbers not available for specified date."}}},"id":"schema_289"}},"exampleStore":{"paths/~1api~1v1~1manifests~1reprint/post/requestBody/content/application~1json/example":{"value":{"carrierAccountId":"JORx6bVG8mr","manifestID":"1234567890"},"id":"paths/~1api~1v1~1manifests~1reprint/post/requestBody/content/application~1json/example"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/shipping","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/shipping","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/manifest.json?download"},{"url":"/_bundle/openapi/manifest.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Manifest APIs","description":"A manifest is an end-of-day summary submitted to the carrier that groups multiple shipments into a single form or electronic record for acceptance and processing.\nFor USPS, the manifest is generated as a SCAN form (Shipment Confirmation Acceptance Notice). A SCAN form consolidates eligible trackable shipments into a form containing one or more barcodes. When the barcode is scanned by USPS, the included shipments receive an acceptance event.\nThe Manifest APIs also support generation and retrieval of USPS 3877 manifest documents for ERR shipments.\nFor US originated shipments, manifest is supported for carriers: USPS, FedEx and Speedee.\nFor CA originated shipments, manifest is supported for carriers: FedEx and CPC.\n\n**Manifest**\nA carrier submission record that groups eligible shipments into a single form or electronic record for acceptance.\n\n**SCAN Form**\nThe USPS manifestation format that combines eligible trackable shipments under one or more barcodes.\n\n\n**Carrier Account ID**\nA unique identifier of the carrier account used to determine which shipments are included in manifest operations.\n"}},"baseSlug":"/openapi/manifest","routesMapping":{}}