Skip to main content

Interface: UseProductSearchOptions

Defined in: composables/vue/useProductSearch.ts:52

Properties​

applyOrderlists?​

optional applyOrderlists?: Ref<boolean | undefined, boolean | undefined>

Defined in: composables/vue/useProductSearch.ts:70

Apply the orderlist filter. Defaults to true when orderlistIds is non-empty, false otherwise — so an authenticated user without a contract still sees the full catalogue.

availability?​

optional availability?: Ref<Availability | undefined, Availability | undefined>

Defined in: composables/vue/useProductSearch.ts:85

Stock selection to filter by. 'all' or unset sends no stock filter. Filtering happens server-side, so itemsFound and the page count describe the filtered set.

brand?​

optional brand?: Ref<string | undefined, string | undefined>

Defined in: composables/vue/useProductSearch.ts:58

categoryId?​

optional categoryId?: Ref<number | undefined, number | undefined>

Defined in: composables/vue/useProductSearch.ts:56

companyId?​

optional companyId?: Ref<number | undefined, number | undefined>

Defined in: composables/vue/useProductSearch.ts:62

configuration​

configuration: object

Defined in: composables/vue/useProductSearch.ts:92

anonymousUserId?​

optional anonymousUserId?: number

The channel's anonymous user — logged-out listings are scoped to it.

baseCategoryId?​

optional baseCategoryId?: number

imageSearchFiltersGrid?​

optional imageSearchFiltersGrid?: MediaImageProductSearchInput

imageVariantFiltersMedium?​

optional imageVariantFiltersMedium?: TransformationsInput

graphqlClient?​

optional graphqlClient?: GraphQLClient

Defined in: composables/vue/useProductSearch.ts:53

language?​

optional language?: Ref<string, string>

Defined in: composables/vue/useProductSearch.ts:59

minStock?​

optional minStock?: Ref<number | undefined, number | undefined>

Defined in: composables/vue/useProductSearch.ts:87

Minimum stock quantity for the 'in-stock' selection.

onCategoryChange?​

optional onCategoryChange?: (category) => void

Defined in: composables/vue/useProductSearch.ts:104

Parameters​

category​

Category

Returns​

void

onFiltersChange?​

optional onFiltersChange?: (filters) => void

Defined in: composables/vue/useProductSearch.ts:99

Parameters​

filters​

AttributeFilter[]

Returns​

void

onItemsFoundChange?​

optional onItemsFoundChange?: (count) => void

Defined in: composables/vue/useProductSearch.ts:101

Parameters​

count​

number

Returns​

void

onPageChange?​

optional onPageChange?: (page) => void

Defined in: composables/vue/useProductSearch.ts:102

Parameters​

page​

number

Returns​

void

onPriceBoundsChange?​

optional onPriceBoundsChange?: (min, max) => void

Defined in: composables/vue/useProductSearch.ts:100

Parameters​

min​

number

max​

number

Returns​

void

onProductsResponse?​

optional onProductsResponse?: (products) => void

Defined in: composables/vue/useProductSearch.ts:103

Parameters​

products​

ProductsResponse

Returns​

void

orderlistIds?​

optional orderlistIds?: Ref<number[] | undefined, number[] | undefined>

Defined in: composables/vue/useProductSearch.ts:64

Scope the product fetch to specific orderlist IDs (e.g. a chosen B2B contract).

page?​

optional page?: Ref<number | undefined, number | undefined>

Defined in: composables/vue/useProductSearch.ts:90

pageSize?​

optional pageSize?: Ref<number, number>

Defined in: composables/vue/useProductSearch.ts:91

priceFilterMax?​

optional priceFilterMax?: Ref<number | undefined, number | undefined>

Defined in: composables/vue/useProductSearch.ts:79

priceFilterMin?​

optional priceFilterMin?: Ref<number | undefined, number | undefined>

Defined in: composables/vue/useProductSearch.ts:78

products?​

optional products?: Ref<(Product | Cluster)[] | undefined, (Product | Cluster)[] | undefined>

Defined in: composables/vue/useProductSearch.ts:55

Controlled mode: pass products in, skip internal fetch

productTrackAttributes?​

optional productTrackAttributes?: Ref<string[] | undefined, string[] | undefined>

Defined in: composables/vue/useProductSearch.ts:76

Attribute names to request per product, e.g. ['MPN']. Unset returns the first page of ALL attributes (12 per product), so products with more than 12 silently lose the rest — name what you render.

sortField?​

optional sortField?: Ref<string | undefined, string | undefined>

Defined in: composables/vue/useProductSearch.ts:88

sortOrder?​

optional sortOrder?: Ref<string | undefined, string | undefined>

Defined in: composables/vue/useProductSearch.ts:89

taxZone?​

optional taxZone?: string

Defined in: composables/vue/useProductSearch.ts:60

term?​

optional term?: Ref<string | undefined, string | undefined>

Defined in: composables/vue/useProductSearch.ts:57

textFilters?​

optional textFilters?: Ref<ProductTextFilterInput[] | undefined, ProductTextFilterInput[] | undefined>

Defined in: composables/vue/useProductSearch.ts:77

user?​

optional user?: Ref<Contact | Customer | null, Contact | Customer | null>

Defined in: composables/vue/useProductSearch.ts:61