POST
Update a Manifest

Authorizations

Authorization
string
header
required

sk_test_ / sk_live_ / rk_test_ / rk_live_ keys

Headers

Shipping-Version
string
Shipping-Account
string

Act on behalf of a connected account (acct_...)

Path Parameters

id
string
required

Body

application/json
user_metadata
object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

reference
string

Response

OK

id
string
required

Prefixed mfst_

Example:

"mfst_1Q2w3E4r"

object
enum<string>
required
Available options:
manifest
livemode
boolean
required
created
integer<unix-time>
required

Unix timestamp (seconds)

status
enum<string>
required
Available options:
pending,
submitted,
partially_submitted,
failed
mode
enum<string>
required
Available options:
explicit,
close_all
trigger
enum<string>
required
Available options:
api,
schedule,
carrier_auto
connection
string
required
updated
integer<unix-time>

Unix timestamp (seconds)

carrier
string
ship_date
string<date>
timezone
string
address
object | null
group
string | null
shipments
string[]
shipment_count
integer
handling_unit_count
integer
total_weight
object
carrier_manifests
object[]
documents
object[]
pickup

ID (pck_...). Expandable to Pickup.

errors
object[]
reference
string | null
submitted_at
integer<unix-time> | null

Unix timestamp (seconds)

messages
object[]
user_metadata
object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

carrier_metadata
object
read-only

Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.

system_metadata
object
read-only

Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.