POST
Inject canonical events

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
type
enum<string>
required
Available options:
tracking,
shipment_charge
tracker
string
carrier
string
tracking_number
string
create_tracker
boolean
events
object[]
Maximum array length: 100
shipment
string
charges
object[]

Response

OK

id
string
required

Prefixed ibe_

Example:

"ibe_1Q2w3E4r"

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

Unix timestamp (seconds)

type
enum<string>
required
Available options:
tracking,
shipment_charge
status
enum<string>
required
Available options:
processed,
partially_processed,
failed
updated
integer<unix-time>

Unix timestamp (seconds)

source
enum<string>
Available options:
api,
carrier_push
connection
string | null
tracker
string | null
shipment
string | null
accepted
integer
rejected
integer
errors
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_.