Sign in

v1

latestOpenAPI 3.1.02026-07-2277219695.0 KB
Manifests

Create a new manifest

Creates a new manifest object.

post/manifests

Headers

SHIPPO-API-VERSIONstring
Example:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

Request body

carrier_accountstring required

ID of carrier account

shipment_datestring required

All shipments to be submitted on this day will be closed out. Must be in the format 2014-01-18T00:35:03.463Z (ISO 8601 date).

transactionsstring[]

IDs transactions to use. If you set this to null or not send this parameter, Shippo will automatically assign all applicable transactions.

asyncboolean

Example request

{
  "carrier_account": "adcfdddf8ec64b84ad22772bce3ea37a",
  "shipment_date": "2014-05-16T23:59:59Z",
  "transactions": [
    "adcfdddf8ec64b84ad22772bce3ea37a"
  ],
  "address_from": {
    "name": "Shwan Ippotle",
    "company": "Shippo",
    "street1": "215 Clayton St.",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94117",
    "country": "US",
    "phone": "+1 555 341 9393",
    "email": "shippotle@shippo.com",
    "is_residential": true,
    "metadata": "Customer ID 123456",
    "validate": true
  }
}

Response

Manifest

carrier_accountstring required

ID of carrier account

shipment_datestring required

All shipments to be submitted on this day will be closed out. Must be in the format 2014-01-18T00:35:03.463Z (ISO 8601 date).

transactionsstring[]

IDs transactions to use. If you set this to null or not send this parameter, Shippo will automatically assign all applicable transactions.

address_fromstring required

ID of the Address object that should be used as pickup address for the scan form. The USPS will validate this address before creating the scan form.

documentsstring[] required

An array containing the URLs to all returned manifest documents.

errorsstring[]

An array of codes and messages describing the error that occurred if any.

object_createdstring date-time required

Date and time of object creation.

object_idstring required

Unique identifier of the given object.

object_ownerstring required

Username of the user who created the object.

object_updatedstring date-time required

Date and time of last object update.

status'QUEUED' | 'SUCCESS' | 'ERROR' required

Indicates the status of the manifest.

Example response

{
  "carrier_account": "adcfdddf8ec64b84ad22772bce3ea37a",
  "shipment_date": "2014-05-16T23:59:59Z",
  "transactions": [
    "adcfdddf8ec64b84ad22772bce3ea37a"
  ],
  "address_from": "d799c2679e644279b59fe661ac8fa488",
  "documents": [
    "https://shippo-delivery.s3.amazonaws.com/0fadebf6f60c4aca95fa01bcc59c79ae.pdf?Signature=tlQU3RECwdHUQJQadwqg5bAzGFQ%3D&Expires=1402803835&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA"
  ],
  "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
  "object_owner": "shippotle@shippo.com",
  "status": "SUCCESS"
}