Create a new order.

This endpoint creates an order. Call it once the user has confirmed its quote: send the body quoted with
POST api/v1/orders/quote, with a serviceLevelId of the account's schedule (GET api/v1/servicelevelschedules) and a callerInfo
(userId or email, not both) found with GET api/v1/accounts/{accountId}/users/search; the quote does not price hubs. Leave orderPayout,
extraFees unitPrice, internalNotes, webhookUrl, overriddenRoutePlanId and overriddenRouteName empty unless the user asks. A retry creates a second order: agree with the user on a unique referenceNumber1, which appears on
invoices; after an error or a timeout, search the orders with ReferenceNumber1 IsEqualTo that value and CreatedAt
IsGreaterOrEqualThan your first attempt, a few times, then ask the user rather than retry. Even though the order is created,
the response can return an array named "validationErrors" containing errors to address. When webhookUrl is set, order events
are posted to it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1
callerInfo
object
required
pickupAddress
object
required
pickupLocation
object
pickupContactInfo
object
pickupWindow
object
pickupLocalWindow
object
string | null
deliveryAddress
object
required
deliveryLocation
object
deliveryContactInfo
object
deliveryWindow
object
deliveryLocalWindow
object
string | null
string | null
string | null
string | null
metadata
object | null
int32 | null
double | null
date-time | null
date-time | null
string | null
orderPayout
object
int32
enum

[0 - 'NoValidation', 1 - 'PickupOnly', 2 - 'DeliveryOnly', 3 - 'PickupAndDelivery']

Allowed:
attributeIds
array of strings | null
attributeIds
extraFees
array of objects | null
extraFees
hubs
array of objects | null
hubs
string | null
string | null
int32 | null

We will select the specific route plan provided it is valid.

string | null

If the order matches a route plan, we will use this value to find a zone, if it matches no zone, we will add the order in a route with this name.

int32
0 to 480
int32
0 to 480
double | null
double | null
boolean
boolean
boolean
boolean
boolean | null
string | null
string | null
string | null
workflows
array of objects | null
workflows
userFields
array of objects | null
userFields
items
array of objects | null
items
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

500

An error occurred when trying to create the order

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