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:
addToManifest
shipment option set to true are eligible for inclusion in the manifest or SCAN form.carrierAccountId
.submissionDate
field.dateOfShipment
option during creation.The Manifest has been generated for the given carrier.
Invalid request.
The request could not be authorized.
The request could not be completed due to an internal error.
{- "carrierAccountId": "abcd12",
- "fromAddress": {
- "addressLine1": "27 Watervw Dr",
- "addressLine2": "near abc street",
- "addressLine3": "near xyz street",
- "cityTown": "shelton",
- "company": "",
- "countryCode": "US",
- "email": "",
- "name": "",
- "phone": "",
- "postalCode": "06484",
- "stateProvince": "CT"
}, - "submissionDate": "2023-05-25"
}
{- "carrierAccountId": "JORx6bVG8mr",
- "carrierName": "USPS",
- "manifestDocuments": [
], - "manifestID": "9475709898644001806609",
- "manifestTrackingNumber": "9475709898644001806609",
- "fromAddress": {
- "name": "Paul Wright",
- "addressLine1": "27 Watervw Dr",
- "addressLine2": "near abc street",
- "addressLine3": "near xyz street",
- "cityTown": "Stamford",
- "company": "PB",
- "email": "testuser@gmail.com",
- "phone": "203-555-1213",
- "countryCode": "US",
- "postalCode": 6905,
- "residential": false,
- "stateProvince": "CT"
}, - "parcelTrackingNumbers": [ ],
- "submissionDate": "2023-05-29"
}