Create Job

Creates a job from a quote.

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 job request

Request for creating a job

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
required
length ≥ 1
string
^[0-9]{3}$
date-time
date-time
date-time
date-time
string
enum
Defaults to return

Action for the courier when the customer is not available.

Allowed:
partner_metadata
object

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

string
enum

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

Allowed:
Responses

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