katana_public_api_client.models.sales_order_search_request

katana_public_api_client.models.sales_order_search_request

Classes

SalesOrderSearchRequest

Structured filter body for POST /sales_orders/search. Returns the same paginated {"data": [...]} shape as GET /sales_orders plus an X-Pagination header. Beta — request/response shape may evolve before GA.

Example:
    {'filter': {'where': {'and': [{'status': {'inq': ['NOT_SHIPPED', 'PACKED']}}, {'created_at': {'gte':
        '2026-01-01T00:00:00.000Z'}}, {'custom_fields.0c8f1d6e-3c2a-4f5b-9d77-12ab34cd56ef': 2}]}, 'order': ['created_at
        DESC', 'id DESC'], 'limit': 50, 'page': 1}}

Attributes:
    filter_ (SalesOrderSearchFilter | Unset): Filter envelope for ``POST /sales_orders/search``.