Search orders

get https://platform.roserocket.com/api/v1/orders

The "Sort" parameter is not supported, despite the documentation indicating it is.

Query Params

created_start_at

date-time

Date range (start)

created_end_at

date-time

Date range (end)

updated_start_at

date-time

Updated At Date range (start)

updated_end_at

date-time

Updated At Date range (end)

search_term

string

Search term

customer_id

string

Customer ID to filter by

po_num

string

PO Number to filter by (exact match)

ref_num

string

Ref Number to filter by (exact match)

tender_num

string

Load Tender Number to filter by (exact match)

custom_field_search

string

Filter for any orders whose PO Number, Ref Number, or Load Tender Number exactly matches this value

in_external_ids

array of strings

List of External ID's to filter by

in_external_ids

in_status_ids

array of strings

List of Statuses to filter by

in_status_ids

sort

string

Sort Results

offset

integer

≥ 0

Defaults to 0

Pagination offset

limit

integer

0 to 50

Defaults to 20

Pagination limit

Responses

Response body

object

orders

array of objects

orders

object

uuid

Auto generated system ID

created_at

date-time

The time of the event's creation

updated_at

date-time

The time the event was last updated

sequence_id

integer

Auto generated sequence ID per customer

external_id

string

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

public_id

string

Auto generated human readable ID

tender_id

string

Tender ID that is related to the order. This field can be null

customer

object

Customer

origin

object

Order address

destination

object

Order address

billing

object

Order address

status

string

Order Status

new saved cancelled quoting quoted no-quote spot-quote-requested pending-dispatch dispatched in-transit delivered archived invoice-created invoice-sent invoice-paid claim draft-quick-quote quick-quoting quick-quoted no-quick-quote spot-qq-requested pickup-request rejected

billing_option

string

Defaults to prepaid

Billing Option

prepaid collect thirdparty

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

Declared value currency

cad usd

pickup_start_at

date-time

Pickup time range (start) in UTC

pickup_start_at_local

date-time

Pickup time range (start) in local time

pickup_end_at

date-time

Pickup time range (end) in UTC

pickup_end_at_local

date-time

Pickup time range (end) in local time

pickup_appt_start_at

date-time

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

pickup_appt_start_at_local

date-time

Pickup appointment time range (start) in local time. 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_appt_end_at_local

date-time

Pickup appointment time range (end) in local time. 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_start_at_local

date-time

Expected delivery time range (start) in local time. 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_end_at_local

date-time

Expected delivery time range (end) in local time. 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_start_at_local

date-time

Delivery appointment time range (start) in local time. 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_appt_end_at_local

date-time

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

dim_type

string

Defaults to ltl

Dimension type

ltl ftl volume

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

object

uuid

Auto generated commodity id

measurement_unit

string

Measurement unit

inch cm

weight_unit

string

Weight unit

lb kg

freight_class

string

An industry standard value used for commodities transported via LTL. Use "none" if not applicable.

50 55 60 65 70 77.5 85 92.5 100 110 125 150 175 200 250 300 400 500 none

commodity_type

string

Defaults to skid

Commodity type

skid other

commodity_type_other

string

If commodity type is set to other, then this field must have value

description

string

Description of the commodity

feet

float

Total feet in length of the truck the commodity is occupying. This field must have value if order's dimension type is set to ftl

volume

float

Total volume of the commodity item. This field must have value if order's dimension type is set to volume

length

float

Length of the commodity

width

float

Width of the commodity

height

float

Height of the commodity

weight

float

Weight of the commodity

nmfc

string

NMFC number

is_stackable

boolean

Is this commodity can be stacked?

quantity

integer

Quantity of the commodity

pieces

integer

Total number of pieces. This field value can be null

sku

string

SKU number

accessorials

array of uuids

accessorials

type

string

is_multistop_order

boolean

multistop_order_full_id

string

Full ID referencing Multistop Order. This field can be null

multistop_order_sequence_id

integer

Sequence ID for Multistop Order. This field can be null

sales_user_ids

array of uuids

Array of Sales User IDs (Order Commission Users) associated to Order

sales_user_ids

sales_user_id

uuid

User ID of the First Sales User associated to Order

offset

integer

limit

integer

total

integer

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://platform.roserocket.com/api/v1/orders?offset=0&limit=20' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation

400Bad request