# Manifest APIs

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.
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.
The Manifest APIs also support generation and retrieval of USPS 3877 manifest documents for ERR shipments.
For US originated shipments, manifest is supported for carriers: USPS, FedEx and Speedee.
For CA originated shipments, manifest is supported for carriers: FedEx and CPC.

**Manifest**
A carrier submission record that groups eligible shipments into a single form or electronic record for acceptance.

**SCAN Form**
The USPS manifestation format that combines eligible trackable shipments under one or more barcodes.


**Carrier Account ID**
A unique identifier of the carrier account used to determine which shipments are included in manifest operations.


Version: 1.0.0

## Servers

```
https://api-dev.sendpro360.pitneycloud.com/shipping
```

```
https://api-qa.sendpro360.pitneycloud.com/shipping
```

Sandbox Server
```
https://api-sandbox.sendpro360.pitneybowes.com/shipping
```

Production Server (uses live data)
```
https://api.sendpro360.pitneybowes.com/shipping
```

## Security

### bearerAuth

Type: http
Scheme: bearer

## Download OpenAPI description

[Manifest APIs](https://docs.sendpro360.pitneycloud.com/_bundle/openapi/manifest.yaml)

## Manifest

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.

### Create Manifest

 - [POST /api/v1/manifests](https://docs.sendpro360.pitneycloud.com/openapi/manifest/manifest/createmanifest.md): 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.

### Reprint manifest

 - [POST /api/v1/manifests/reprint](https://docs.sendpro360.pitneycloud.com/openapi/manifest/manifest/reprintmanifest.md): 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.

### Create Manifest Document

 - [POST /api/v1/manifest/document](https://docs.sendpro360.pitneycloud.com/openapi/manifest/manifest/createusps3877document.md): This operation creates a USPS 3877 manifest document for ERR shipments.

### Get Manifest Document

 - [GET /api/v1/manifest/{manifestId}/document](https://docs.sendpro360.pitneycloud.com/openapi/manifest/manifest/get3877document.md): This operation retrieves the USPS 3877 manifest document by manifest ID.