Create Manifest

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:

  • Only shipments with the addToManifest shipment option set to true are eligible for inclusion in the manifest or SCAN form.
  • Shipments can be added to the SCAN form by specifying the carrierAccountId.
  • 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 submissionDate field.
  • Any eligible shipment not included in a SCAN form by 6 a.m. UTC/GMT the following calendar day will be automatically manifested.
  • Shipments, once manifested, cannot be re-manifested.
  • To prevent a shipment from being auto-manifested, specify the shipment's dateOfShipment option during creation.
  • A single Create Manifest request can include up to 7,000 shipments.
  • USPS SCAN forms retrieved through URLs are available for 24 hours after creation.
SecuritybearerAuth
Request
header Parameters
X-PB-Developer-Partner-ID
string

This is the Developer Partner ID. When the developer is the only partner, this field is not required.

compactResponse
boolean

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.

Example: false
Request Body schema: application/json
carrierAccountId
required
string

A unique identifier associated with the specific carrier account, which is used in the Manifest process.

required
object
submissionDate
string

The date the shipments are to be tendered to the carrier, entered as YYYY-MM-DD.

Responses
200

The Manifest has been generated for the given carrier.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/manifests
Request samples
application/json
{
  • "carrierAccountId": "abcd12",
  • "fromAddress": {
    },
  • "submissionDate": "2023-05-25"
}
Response samples
application/json
{
  • "carrierAccountId": "JORx6bVG8mr",
  • "carrierName": "USPS",
  • "manifestDocuments": [],
  • "manifestID": "9475709898644001806609",
  • "manifestTrackingNumber": "9475709898644001806609",
  • "fromAddress": {
    },
  • "parcelTrackingNumbers": [ ],
  • "submissionDate": "2023-05-29"
}