Search sales order rows with advanced filters

post

https://api.katanamrp.com/v1/sales_order_rows/search

🚧
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 order rows 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_order_rows aren’t expressive enough. The response payload matches GET /sales_order_rows.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

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

filter

object

Filter clause. Only the fields listed below may appear here — unknown fields are rejected with 422. Custom field values can also be addressed via custom_fields.<uuid> nested keys, where <uuid> is the custom field definition id.

order

Sort directive(s). Each entry is <field> ASC|DESC (direction defaults to ASC). Only filterable fields may be used here. custom_fields.<uuid> nested paths are orderable.

limit

integer

0 to 200

Defaults to 50

Page size. Defaults to 50 when omitted. Maximum 200.

page

integer

≥ 1

Defaults to 1

1-based page number. Defaults to 1 when omitted. Pagination follows the same convention as every other paginated endpoint in the public API.

Responses

200Paginated list of sales order rows matching the filter.

401Make sure you've entered your API token correctly.

422Check the details property for a specific error message.

429The rate limit has been reached. Please try again later.

500The server encountered an error. If this persists, please contact support