HomeSupport
API Reference
Start typing to search…

Get a quote for an order

post
https://example.com/integration/api/v1/orders/quote

Get a quote for an order. The quote response can return an array named "validationErrors" containing errors that will need to be addressed should you choose to create the order. Note that Basic Authentication is required for all requests as such, make sure to provide the Authorization header with a valid value.

Body Params
pickupAddress
object
required
pickupLocation
object
pickupContactInfo
object
pickupWindow
object
pickupLocalWindow
object
string | null
dropoffAddress
object
required
dropoffLocation
object
dropoffContactInfo
object
dropoffWindow
object
dropoffLocalWindow
object
string | null
string | null
string | null
string | null
metadata
object | null
int32 | null
double | null
date-time | null
date-time | null
string | null
attributeIds
array of strings | null
attributeIds
extraFees
array of objects | null
extraFees
int32
0 to 120
int32
0 to 120
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:
Responses
200

Quote was successfully returned

403

User does not have access to that resource

500

An error occurred when trying to create the quote

Updated 7 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json
Updated 7 months ago