CreateManifest

This method creates an end-of-day manifest and should be implemented by carrier apps that support end-of-day manifesting.

Request
Request Body schema: application/json

An object containing information about the labels to manifest.

object (ShipFrom)

The shipment sender's address. It may or may not have been validated.

Array of objects or null (ManifestRequestShipment)

The shipments to include in the manifest. There should be at least one shipment included in a manifest.

Array of objects or null (ManifestRequestShipment)

The shipments to exclude from the manifest.

open_datetime
string or null <date-time>

The date and time of the earliest shipment being manifested. Formatted per the https://tools.ietf.org/html/rfc3339 spec

close_datetime
string <date-time>

The date and time of the last shipment being manifested. Formatted per the https://tools.ietf.org/html/rfc3339 spec

object (AdvancedOptions)

This is a schemaless object. It is for open ended customizations unique to particular carriers. The documented keys are some common options shared by many carriers, but are not definitive. Advanced options you support will be defined in ShipEngine. If the field is absent it should be interpreted as the default value for any applicable options, e.g. false for booleans.

transaction_id
required
string <uuid>

The transaction ID uniquely represents this request. If the request is retried then this transaction ID will be the same. You should only perform the requested action once per given transaction ID.

object (Authorization)
object or null
connection_name
string or null

The name of the connection to use, if this app has connection names defined

Responses
200

This object model represents the response from a successful create manifest request.

post/CreateManifest
Request samples
application/json
{
  • "ship_from": {
    },
  • "included_labels": [
    ],
  • "excluded_labels": [
    ],
  • "open_datetime": "2019-08-24T14:15:22Z",
  • "close_datetime": "2019-08-24T14:15:22Z",
  • "advanced_options": {
    },
  • "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  • "authorization": {
    },
  • "metadata": {
    },
  • "connection_name": "string"
}
Response samples
application/json
{
  • "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  • "manifests": [
    ],
  • "errors": [
    ],
  • "manifest_status": "unknown",
  • "manifest_request_id": 0,
  • "total_shipments": 0,
  • "total_invalid": 0,
  • "manifest_identifiers": {
    },
  • "metadata": {
    }
}