List Orders

API operation: Open the endpoint in Scalar

Use GET /orders to list orders. The current public operation is Order.findAll.orders.

Authentication is required. Without mode=dashboard, results are scoped to the caller's customer orders. Dashboard mode applies role-based access for operational users; administrators and agents have broader access.

For new-order notifications, use the Sockets reference; event names and payloads may depend on the configured integration.

const response = await ordering.orders().get();

This SDK syntax is historical. Confirm the package and version before using it.

OpenAPI reference

Operation: GET /orders

Query parameters

Name	Type	Required	Description
params	string	No	Comma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields.
orderBy	string	No	Field to sort by, with - prefixed for descending order. Multiple fields can be chained with commas.
where	string	No	JSON filter over the fields the model declares as filterable. Valid fields for each resource are exposed in its x-ordering-whereable schema extension.
page	integer	No	Page number, starting at 1. Applies only to lists that return a pagination block.
page_size	integer	No	Number of items per page.
business_id	integer	No	—
customer_phone	string	No	—
limit	integer	No	—
mode	string	No	—
scope	string	No	—

Responses

Code	Description
200	OK (Envelope)
400	Bad Request (ErrorResponse)
401	Unauthorized
404	Not Found
429	Too Many Requests (ErrorResponse)
500	Internal Server Error (ErrorResponse)
503	Service Unavailable (ErrorResponse)

Open this operation in the API reference