GetManifest

This method retrieves the end-of-day manifest created by an earlier create manifest call. The CreateManifestRequestId returned in the CreateManifest, is used to find the manifest.

Request
Request Body schema: application/json

An object containing information about the manifest request that is in progress to.

manifest_request_id
integer or null <int64>

Manifest request identifier.

return_immediately
boolean

Return immediately after checking status. Full manifest creation can take up to 2 minutes. Set to false to allow additional checks before timeout.

object or null

Carrier specific data needed to retrieve Manifest results

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.

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/GetManifest
Request samples
application/json
{
  • "manifest_request_id": 0,
  • "return_immediately": true,
  • "manifest_identifiers": {
    },
  • "included_labels": [
    ],
  • "excluded_labels": [
    ],
  • "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": {
    }
}