POST
Create a credentials-based connection

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
carrier
string
required
credentials
object
required
write-only
display_name
string
config
object
default
boolean
verify
boolean
default:true
user_metadata
object

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

Response

OK

id
string
required

Prefixed conn_

Example:

"conn_1Q2w3E4r"

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

Unix timestamp (seconds)

carrier
string
required

Alias of integration for lsp connections

method
enum<string>
required
Available options:
credentials,
oauth
status
enum<string>
required
Available options:
active,
inactive,
error,
reauthorization_required,
pending
updated
integer<unix-time>

Unix timestamp (seconds)

integration
string
interfaces
string[]
display_name
string
account_number
string | null
default
boolean
capabilities
string[]
config
object
credentials
null

Write-only; always null in responses

credentials_preview
object | null
oauth
object | null
ownership
enum<string>
Available options:
account,
platform,
system
inbound
object | null
verification
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_.