Get a quote for an order.

Prices the order without creating it; the body is the one of POST api/v1/orders. serviceLevelId is required: use a
service level of the account's schedule, whose id is the serviceLevelScheduleId returned by GET api/v1/accounts/{accountId}
and whose service levels are listed by GET api/v1/servicelevelschedules; an account without a schedule cannot be quoted.
Leave vehicleTypeId empty to use the default vehicle of the service level. A service level that is not open to API orders
gives an invalid service level and vehicle combination: try another one. Set callerInfo.userId or callerInfo.email, not both,
to a user of the account, found with GET api/v1/accounts/{accountId}/users/search. The quote response can return an array named
"validationErrors" containing errors that will need to be addressed should you choose to create the order.

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 add the hubs to 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