Manifests

Manifests are close-outs of shipping labels of a certain day. Daily manifests are required by some carriers, it’s meant is for proper billing and acceptance of shipments.

Create a new manifest

To create a manifest for your shipments, POST to the Manifest endpoint with an array of the Transaction object_ids you’re looking to create the Manifest for, along with your carrier_account, submission_date, and address_from (required for USPS).

curl https://api.goshippo.com/manifests/
    -H "Authorization: ShippoToken <API_TOKEN>" \
    -H "Content-Type: application/json"  \
    -d '{
          "carrier_account": "b741b99f95e841639b54272834bc478c",
          "submission_date": "2014-05-16T23:59:59Z",
          "address_from": "28828839a2b04e208ac2aa4945fbca9a",
          "transactions": [
            "64bba01845ef40d29374032599f22588", 
            "c169aa586a844cc49da00d0272b590e1"
            ],
          "async": false
        }'
manifest = Shippo::Manifest.create(
    :carrier_account => "b741b99f95e841639b54272834bc478c",
    :submission_date => "2014-05-16T23:59:59Z",
    :transactions => ["64bba01845ef40d29374032599f22588", "c169aa586a844cc49da00d0272b590e1"]
)
manifest = shippo.Manifest.create(
    carrier_account = "b741b99f95e841639b54272834bc478c",
    submission_date = "2014-05-16T23:59:59Z",
    transactions = ["64bba01845ef40d29374032599f22588", "c169aa586a844cc49da00d0272b590e1"]
)
$manifest = Shippo_Manifest::create(
    array(
        'carrier_account'=> 'b741b99f95e841639b54272834bc478c',
        'submission_date'=> '2014-05-16T23:59:59Z',
        'transactions'=> array('64bba01845ef40d29374032599f22588', 'c169aa586a844cc49da00d0272b590e1')
));
shippo.manifest.create({
    "carrier_account": "b741b99f95e841639b54272834bc478c",
    "submission_date": "2014-05-16T23:59:59Z",
    "transactions": [
        "64bba01845ef40d29374032599f22588",
        "c169aa586a844cc49da00d0272b590e1"
    ]
}, function(err, manifest) {
    // asynchronously called
});
resource.CreateManifest( new Hashtable(){
    { "carrier_account", "b741b99f95e841639b54272834bc478c"},
    { "submission_date", "2014-05-16T23:59:59Z"},
    { "transactions", new String[] { "64bba01845ef40d29374032599f22588", "c169aa586a844cc49da00d0272b590e1" }},
});

In the response, you will find an array of links to your manifests in the documents attribute. Depending on how many shipments you've manifested, you may generate multiple files.

Manifests are always generated in PDFs. For the USPS, one manifest (SCAN Form) can contain up to 500 shipment information, so if you've manifested more than 500 shipments you will recieve multiple PDFs.

{
    "object_created": "2014-05-16T03:43:52.765Z",
    "object_updated": "2014-05-16T03:43:55.445Z",
    "object_id": "0fadebf6f60c4aca95fa01bcc59c79ae",
    "object_owner": "mrhippo@goshippo.com",
    "object_status": "SUCCESS",
    "carrier_account": "b741b99f95e841639b54272834bc478c",
    "submission_date": "2014-05-16T23:59:59Z",
    "address_from": "28828839a2b04e208ac2aa4945fbca9a",
    "transactions": ["64bba01845ef40d29374032599f22588", "c169aa586a844cc49da00d0272b590e1"],
    "documents": [
        "https://shippo-delivery.s3.amazonaws.com/0fadebf6f60c4aca95fa01bcc59c79ae.pdf?Signature=tlQU3RECwdHUQJQadwqg5bAzGFQ%3D&Expires=1402803835&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA"
    ]
}

The following carriers require manifests:

The USPS manifest is also known as "SCAN Form".

A SCAN form is a PDF with a single barcode containing information about all your packages, so that the USPS doesn't need to scan each of your packages individually and all tracking codes are updated immediately.

If you have a Contract Account with Canada Post and are shipping more than 50 shipments a day you need to create a manifests to transmit the shipments for billing.

Customers that ship less than 50 daily can usually skip the manifest requirement, but are encouraged to verify with Canada Post.

All Newgistics customers are required to manifest their shipments, daily.

When a manifest is requested for Newgistics, Shippo will send a "Client Manifest Information" (CMI) file to Newgistics on your behalf. No physical document for scanning will be returned.

Manifests must be posted by 11pm PST the day before a shipment is picked up for processing. It is recommended that manifests contain full and accurate information for all shipments set to be pickup because it will be used as reference.

All Australia Post customers are required to manifest their shipments, daily.

All DHL eCommerce customers are required to manifest their shipments, daily.

Manifest capabilities are available for Purolator. It is not required by Purolator, however encouraged for record-keeping purposes.