Skip to main content
GET
List Orders

API Url

Here, please put your company name in the url. Ex: if it is CompanyX company, then url should be

Sample request

Sample response

Filtering

Pass a JSON-encoded array to the filter query parameter. Each object in the array has three keys:

Supported operators

Examples

Filter by status:
Filter by delivery datetime range:
Filter after a date:
Combine multiple filters:

Ordering

Use the ordering query parameter with an ORM field path. Prefix with - for descending order.

Authorizations

Authorization
string
header
required

Query Parameters

page
integer

Page number for paginated results.

Example:

1

page_size
integer

Number of results per page (max 25, default 10).

Required range: x <= 25
Example:

10

ordering
string

ORM field path to order by. Prefix with - for descending order (e.g. -created_datetime, load_pay, status).

Example:

"-created_datetime"

filter
string

JSON-encoded array of filter objects. Each object has column (ORM field path), value, and contains (operator). Supported operators: is, is_not, is_in, is_not_in, contains, before, after, greater_than, less_than, between, between_datetime, isnull, today, exclude, exclude_in. Example: [{"column":"status","value":"booked","contains":"is"},{"column":"load_pay","value":"1000,5000","contains":"between"}]

Example:

"[{\"column\":\"status\",\"value\":\"booked\",\"contains\":\"is\"}]"

Response

Paginated list of orders.

count
integer
required

Total number of orders.

Example:

150

next
string | null
required

URL to the next page of results.

previous
string | null
required

URL to the previous page of results.

results
object[]
required

List of orders.