POST
Start a job

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
string
required
parameters
object
priority
enum<string>
Available options:
low,
normal,
high
user_metadata
object

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

Response

OK

id
string
required

Prefixed job_

Example:

"job_1Q2w3E4r"

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

Unix timestamp (seconds)

type
string
required
status
enum<string>
required
Available options:
queued,
running,
succeeded,
partially_succeeded,
failed,
cancelling,
cancelled
source
enum<string>
required
Available options:
api,
schedule,
system
progress
object
required
updated
integer<unix-time>

Unix timestamp (seconds)

schedule
string | null
subject
object | null
parameters
object
attempt
integer
max_attempts
integer
priority
enum<string>
Available options:
low,
normal,
high
queued_at
integer<unix-time>

Unix timestamp (seconds)

started_at
integer<unix-time> | null

Unix timestamp (seconds)

finished_at
integer<unix-time> | null

Unix timestamp (seconds)

result
object | null
errors
object[]
created_by
object | null
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_.