Create a booked order

post

https://platform.roserocket.com/api/v1/customers/{customerID}/create_booked_order

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerID

uuid

required

ID of the customer that creates the order. It could also be the external ID of the customer, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the customer's external ID is test123 then the value of customerID should be ext:test1234 or external_id:test1234.

Body Params

Order object

Customer's order

external_id

string

External ID for mapping the order to an external system. This field value can be null

origin

object

required

Order address

destination

object

required

Order address

billing

object

required

Order address

billing_option

string

enum

Defaults to prepaid

Billing Option

Allowed:

notes

string

Notes that will appear on BOL

po_num

string

Purchase order numbers (if multiple use comma separated values)

tender_num

string

Tender number

ref_num

string

Reference number

custom_broker

string

Custom broker information

port_of_entry

string

Port of entry in cross-border order

declared_value

float

Declared value

declared_value_currency

string

enum

Declared value currency

Allowed:

pickup_start_at

date-time

Pickup time range (start) in UTC

pickup_end_at

date-time

Pickup time range (end) in UTC

pickup_appt_start_at

date-time

Pickup appointment time range (start) in UTC. This field value can be null

pickup_appt_end_at

date-time

Pickup appointment time range (end) in UTC. This field value can be null

pickup_notes

string

Pickup notes for the order. This field value can be null

delivery_start_at

date-time

Expected delivery time range (start) in UTC. This field value can be null

delivery_end_at

date-time

Expected delivery time range (end) in UTC. This field value can be null

delivery_appt_start_at

date-time

Delivery appointment time range (start) in UTC. This field value can be null

delivery_appt_end_at

date-time

Delivery appointment time range (end) in UTC. This field value can be null

delivery_notes

string

Delivery notes for the order. This field value can be null

dim_type

string

enum

Defaults to ltl

Dimension type

Allowed:

default_measurement_unit_id

string

Identifying ID for the default unit of measurement for this order. Can be 'cm' or 'inch'

default_weight_unit_id

string

Identifying ID for the default unit of weight for this order. Can be 'kg' or 'lb'

commodities

array of objects

Commodities items

commodities

accessorials

array of uuids

accessorials

billable_miles

float

Total number of miles between pickup and delivery. This field value can be null

transportation_authority_id

uuid

Identifying ID for authority which adjusts BOL printouts

Responses

200successful operation

400Bad request