Manifests

Create a manifest

Create a manifest for one or many shipments with labels already purchased.

post/v1/manifests

Request body

carrier_namestring required

The manifest's carrier

optionsobject

<details> <summary>The options available for the manifest.</summary>

    {
        "shipments": [
            {
                "tracking_number": "123456789",
                ...
                "meta": {...}
            }
        ]
    }
    </details>

referencestring nullable

The manifest reference

shipment_idsstring[] required

The list of existing shipment object ids with label purchased.

Response

idstring

A unique manifest identifier

object_typestring

Specifies the object type

carrier_namestring required

The manifest carrier

carrier_idstring required

The manifest carrier configured name

metaobject nullable

provider specific metadata

test_modeboolean required

Specified whether it was created with a carrier in test mode

optionsobject

<details> <summary>The options available for the manifest.</summary>

    {
        "shipments": [
            {
                "tracking_number": "123456789",
                ...
                "meta": {...}
            }
        ]
    }
    </details>

referencestring nullable

The manifest reference

shipment_identifiersstring[] required

The list of shipment identifiers you want to add to your manifest.<br/> shipment_identifier is often a tracking_number or shipment_id returned when you purchase a label.

metadataobject

User metadata for the pickup

manifest_urlstring uri nullable

The Manifest file URL

Changes

No recorded changes to this endpoint across all 1 revision of this API.