katana_public_api_client.models.sales_order_row_search_request

katana_public_api_client.models.sales_order_row_search_request

Classes

SalesOrderRowSearchRequest

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

Example:
    {'filter': {'and': [{'sales_order_id': {'inq': [12345, 12346, 12347]}}, {'quantity': {'gt': 0}},
        {'product_availability': 'IN_STOCK'}]}, 'order': ['delivery_date ASC', 'id ASC'], 'limit': 100, 'page': 1}

Attributes:
    filter_ (SalesOrderRowSearchFilter | Unset): ``filter`` clause for ``POST /sales_order_rows/search``. Only the
        fields listed here may appear; unknown fields are rejected with
        422. Custom field values are addressable via additional
        ``custom_fields.<uuid>`` keys (snake_case), where ``<uuid>`` is the
        custom field definition id. Compose with ``and`` / ``or`` (max
        nesting depth 2).
    order (list[str] | str | Unset): Sort directive(s). Each entry is ``<field> ASC|DESC``
        (direction defaults to ASC). Only filterable fields may be
        used; ``custom_fields.<uuid>`` paths are orderable.
    limit (int | Unset): Page size; maximum 200. Omit to let the server apply its
        default of 50 (the client omits the key when unset rather than
        sending a default, so direct construction and round-tripped
        ``from_dict`` payloads behave identically).
    page (int | Unset): 1-based page number. Omit to let the server default to 1.