Skip to content

Create an order

POST
/orders

Create a new order

object
external_id
string
customer_id
string
order_date
string format: date
ship_to_id
string
status
string
metadata
object
timewindow
string
taker
string
po_number
string
origin
string
job_name
string
loadsheet_id
string
source
string
instructions
string
organization_id
string
delivery_date
string format: date
time_window_start
string
time_window_end
string
note
string
unit_id
string
service_area_id
string
pickup_location_id
string
po_number
string
job_name
string
sales_rep_id
string
route_code
string
assignment_type
string
delivery_surcharge
string

Order created

object
id
string
company_id
string | null
external_id
string | null
customer_id
string | null
order_date
string | null format: date
ship_to_id
string | null
status
string | null
metadata
object
timewindow
string
taker
string
po_number
string
origin
string
job_name
string
result
object | null
loadsheet_id
string | null
source
string | null
date_last_modified
string | null format: date
instructions
string | null
organization_id
string | null
archived
boolean
validation_status
string | null
completed
boolean
date_created
string | null format: date-time
delivery_date
string | null format: date
errors
object | null
dispatched
boolean
time_window_start
string | null
time_window_end
string | null
note
string | null
unit_id
string | null
service_area_id
string | null
pickup_location_id
string | null
time_window_start_ts
string | null format: date-time
time_window_end_ts
string | null format: date-time
last_modified
string format: date-time
resource_shift_id
string | null
approved
boolean | null
printed
boolean | null
po_number
string | null
job_name
string | null
sales_rep_id
string | null
route_code
string | null
assignment_type
string | null
pinned
boolean
delivery_surcharge
string | null
activity
object | null
bill_of_lading_id
string | null
bol_photos
array | null
last_modified_date
string | null format: date-time

Invalid request

object
success
required
boolean
error
required
string
Example
An error occurred

Unauthorized