katana_public_api_client.models.variant_search_request

katana_public_api_client.models.variant_search_request

Classes

VariantSearchRequest

Structured search body for POST /variants/search. Returns the same paginated {"data": [...]} shape as the corresponding list endpoint, plus an X-Pagination header.

Example:
    {'filter': {'and': [{'item_type': None, 'eq': 'product'}]}, 'order': ['sku ASC'], 'limit': 50, 'page': 1}

Attributes:
    filter_ (VariantSearchFilter | Unset): Filter clause for ``POST /variants/search``. Only the fields listed
        here may appear; unknown fields are rejected with 422. Custom field
        values are addressable via ``custom_fields.<uuid>`` keys.
    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.
    page (int | Unset): 1-based page number. Omit to let the server default to 1.
    include (list[VariantSearchRequestIncludeItem] | Unset): Related data to include, and result-set widening.
        ``item``
        enriches each variant with its parent item under ``item``;
        ``archived`` and ``deleted`` include otherwise-excluded
        variants in the results.