POST
Create an advance shipping notice

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_...)

Idempotency-Key
string
required
Maximum string length: 255

Body

application/json
facility
string
required
shipments
(string | object)[]
required
expected_at
string
transport
object
user_metadata
object

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

Response

OK

id
string
required

Prefixed asn_

Example:

"asn_1Q2w3E4r"

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

Unix timestamp (seconds)

partner
string
required
facility
string
required
status
enum<string>
required
Available options:
announced,
in_transit,
arrived,
receiving,
closed,
cancelled
updated
integer<unix-time>

Unix timestamp (seconds)

expected_at
string
arrived_at
integer<unix-time> | null

Unix timestamp (seconds)

transport
object
shipments
string[]
expected
object
received
object
discrepancies
object[]
closed_at
integer<unix-time> | null

Unix timestamp (seconds)

documents
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_.