Search sales orders with advanced filters

🚧

Beta — subject to change. This endpoint is publicly available, but its request/response shape may evolve before General Availability as we incorporate early feedback.

Searches sales orders using a structured filter body with nested logical operators (and, or) and per-field comparators. Use this when the flat query parameters on GET /sales_orders aren’t expressive enough. The response payload matches GET /sales_orders.

Only the fields listed in the request schema may appear in where and order; unknown fields return 422. Custom field values are addressable via custom_fields.<uuid> nested paths.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Structured filter body. See the schema for the field allowlist, the operator allowlist, and value caps.

filter
object
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json