POST
Export duty collections

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
Maximum string length: 255

Body

application/json
filters
object

Response

OK

id
string
required

Prefixed file_

Example:

"file_1Q2w3E4r"

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

Unix timestamp (seconds)

purpose
enum<string>
required
Available options:
customs_document,
dangerous_goods_declaration,
label,
manifest,
signature_image,
proof_of_delivery,
logo,
export,
other
size
integer
required
updated
integer<unix-time>

Unix timestamp (seconds)

filename
string
content_type
string
sha256
string
url
string<uri>
url_expires_at
integer<unix-time>

Unix timestamp (seconds)

expires_at
integer<unix-time> | null

Unix timestamp (seconds)

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