Create Job From New Quote

Quotes and creates a job in a single call, for partners that always commit to
whatever quote they receive.

The body is a POST /jobs body without quote_id or undeliverable_action
a quote is created internally and consumed immediately, and undeliverable
items are always disposed. The response is either the quote rejection that a
POST /quotes call would have returned, or the created job.

Supply an Idempotency-Key header to make retries safe. A repeat of the same
key replays the original response — including a rejection — rather than
returning a conflict, so a partner wanting a genuine retry after a transient
rejection such as couriers_busy must send a new key. Reusing a key with a
different body returns 422 idempotency_key_reused.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

Partner ID

Body Params

Create instant job request

Request for quoting and creating a job in a single call

pickup
object
required

Waypoint details for a job

dropoff
object
required

Waypoint details for a job

delivery_items
array of objects
required
delivery_items*
string
required
length ≥ 1
string

Reference recorded on the underlying quote.

string
^[0-9]{3}$
date-time
date-time
date-time
date-time
partner_metadata
object

Arbitrary key-value data attached to a job (up to 50 keys, 500 char values).

string
enum

Sandbox-only. When set, matching is short-circuited and the request returns the corresponding rejection response. Rejected with 400 if the partner is not in sandbox mode.

Headers
string
length ≥ 1

Optional client-supplied key. Repeating a request with the same key returns the original response verbatim instead of creating a second job. Keys are retained for 30 minutes.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json