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.

X-PB-LocationId
string

The X-PB-LocationId header identifies the enterprise, division, or partner location under which a shipment is processed and billed. 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.

Selection Rules

  • If X-PB-LocationId is provided and the location has one carrier with one account:

    • carrier is optional
    • carrierAccountId is optional
    • The available carrier account is selected and the manifest is created.

  • If X-PB-LocationId is not provided and the default location has one carrier with one account:

    • carrier is optional
    • carrierAccountId is optional
    • The available carrier account is selected and the manifest is created.

  • If X-PB-LocationId is provided and the location has one carrier with multiple accounts:

    • carrier is optional
    • carrierAccountId is required
    • The specified carrierAccountId is selected and the manifest is created.

  • If X-PB-LocationId is not provided and the default location has one carrier with multiple accounts:

    • carrier is optional
    • carrierAccountId is required
    • The specified carrierAccountId is selected and the manifest is created.

  • If X-PB-LocationId is provided and the location has multiple carriers with one account each:

    • carrier is required
    • carrierAccountId is optional
    • The specified carrier and its associated account are selected and the manifest is created.

  • If X-PB-LocationId is not provided and the default location has multiple carriers with one account each:

    • carrier is required
    • carrierAccountId is optional
    • The specified carrier and its associated account are selected and the manifest is created.

  • If X-PB-LocationId is provided and the location has multiple carriers with multiple accounts:

    • carrier is optional
    • carrierAccountId is required
    • The specified carrierAccountId is selected and the manifest is created.

  • If X-PB-LocationId is not provided and the default location has multiple carriers with multiple accounts:

    • carrier is optional
    • carrierAccountId is required
    • The specified carrierAccountId is selected and the manifest is created.
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
string

Unique identifier of the carrier account used for manifest processing.

When to provide

  • Required if multiple accounts exist for the selected carrier.
  • Optional if only one account exists.
carrier
string

Name of the carrier for the manifest.

When to provide

  • Required if multiple carriers are configured for the resolved location.
  • Optional if only one carrier exists.
object

The complete address of the Sender. The fromAddress is selected using the following order of precedence:

Request Body → Location ID

  • fromAddress provided in the request payload is used if available.
  • If not provided in the request, the fromAddress associated with the resolved location is used.
  • If fromAddress cannot be resolved from any source, the request fails with a validation error.

Note: fromAddress is required.

submissionDate
string

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

parcelTrackingNumbers
Array of strings

List of parcel tracking numbers used to generate manifest form for selected shipments. This option is subject to carriers supported individual parcel tracking number.

object

Additional manifest options.

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": "string",
  • "carrier": "USPS",
  • "fromAddress": {
    },
  • "submissionDate": "2023-05-25",
  • "parcelTrackingNumbers": [
    ],
  • "options": {
    }
}
Response samples
application/json
{
  • "carrierAccountId": "JORx6bVG8mr",
  • "carrierName": "USPS",
  • "manifestDocuments": [],
  • "manifestID": "9475709898644001806609",
  • "manifestTrackingNumber": "9475709898644001806609",
  • "fromAddress": {
    },
  • "parcelTrackingNumbers": [
    ],
  • "options": {
    },
  • "submissionDate": "2023-05-25"
}