List Orders

get

https://app.rackbeat.com/api/orders

Retrieve a list of orders with optional filtering and pagination.

Only want to retrieve Draft Orders? Explore state based filtering.

To retrieve only draft orders you will need to send the request with the query parameter is_booked set to false, which results in this request: api/orders?is_booked=false. There are also other state based filters that can be worth exploring - e.g. is_cancelled, is_shipped or is_ready_for_shipping.

Learn about Filtering and Optimizing Queries

Receiving large response pay loads on list endpoints? Check out our guides on "Optimizing Queries" and "Filtering & Sorting" to learn how to only receive the data that you need.

Query Params

simple_filter[number]

string

Can be filtered using all operators

simple_filter[created_at]

string

Can be filtered using all operators

simple_filter[updated_at]

string

Can be filtered using all operators

is_cancelled

string

Used to filter output. Example: true

is_booked

string

Used to filter output. Example: true

is_shipped

string

Used to filter output. Example: true

is_ready_for_shipping

string

Used to filter output. Example: true

date_from

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

date_to

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

booked_at_from

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

booked_at_to

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

order_date_from

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

order_date_to

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

revenue_delivery_date_from

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

revenue_delivery_date_to

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

order_delivery_date_from

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

order_delivery_date_to

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

address_email

string

Used to filter output. Example: [email protected]

employee_number

string

Used to filter output. Example: test123

string

Used to filter output. Example: test123

is_archived

string

Used to filter output. Example: true

other_reference

string

Used to filter output. Example: test123

other_reference_eq

string

Used to filter output. Example: test123

employee

string

Used to filter output. Example: test123

employee_from

string

Used to filter ouput between entities. Example: 1005

employee_to

string

Used to filter ouput between entities. Example: 1005

has_item

string

Used to filter output. Example: true

item_from

string

Used to filter ouput between entities. Example: 1005

item_to

string

Used to filter ouput between entities. Example: 1005

customer_number

string

Used to filter output. Example: test123

customer_from

string

Used to filter ouput between entities. Example: 1005

customer_to

string

Used to filter ouput between entities. Example: 1005

customer_group_number

string

Used to filter output. Example: test123

customer_group_from

string

Used to filter ouput between entities. Example: 1005

customer_group_to

string

Used to filter ouput between entities. Example: 1005

delivery_date_from

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

delivery_date_to

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

updated_at_from

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

updated_at_to

string

Used to filter output between dates. Example: 2023-01-01 12:00:00

string

Used to filter output. Example: 123,777,1002

not_in

string

Used to filter output. Example: 123,777,1002

Headers

Authorization

string

Response

206