Query: flexSearchProductFamilies

Queries for ProductFamilies using FlexSearch.

Return Type




Args

NameTypeDescription
afterString

If this is set to the value of the _cursor field of an item, only items after that one will be included in the result. The value of the after of this query must match the one where the _cursor value has been retrieved from.

filterProductFamilyFilter

Renamed to postFilter. Use postFilter instead.

firstInt

The number of items to include in the result. If omitted, all remaining items will be included (which can cause performance problems on large collections).

flexSearchFilterProductFamilyFlexSearchFilter
orderByProductFamilyOrderBy

Specifies the how this collection should be sorted. If omitted, the result order is not specified. If cursor-based pagination is used (i.e., the after is specified or the _cursor is requested), id_ASC will be implicitly added as last sort criterion so that the sort order is deterministic.

postFilterProductFamilyFilter

Filters that will be applied in memory after the flexSearchFilter.

This will not use any indices and will only work if applied on less than 10 000 objects.

skipInt

The number of items in the list or collection to skip. Is applied after the after argument if both are specified.


Properties

NameTypeDescription
_cursorString

Provides a value that can be supplied to the after argument for pagination. Depends on the value of the orderBy argument.

_productsMeta_QueryMeta

The products in this product family

_revisionID

An identifier that is updated automatically on each update of this root entity (but not on relation changes)

createdAtDateTime

The instant this object has been created

createdByUser

The user who created this product family

ctxProductRelationEntityCtx

Context contains fields that are accesible to the permissions profile. This is an internal field related to user permissions.

iconString

URL pointing to an icon associated with this product family

idID

An auto-generated string that identifies this root entity uniquely among others of the same type

imageString

URL pointing to an image for this product family

nameString

Name of the product family

products[Product]

The products in this product family

updatedAtDateTime

The instant this object has been updated the last time (not including relation updates)


This page was generated: 2024-05-17