Skip to main content

Interface: ProductSearchByCategoryInput

Defined in: type/ProductSearchByCategoryInput.ts:15

Input object for ProductSearchByCategoryInput

Properties​

applyOrderlists?​

optional applyOrderlists?: boolean

Defined in: type/ProductSearchByCategoryInput.ts:83

Apply orderlist filtering to search results

categoryIds​

categoryIds: number[]

Defined in: type/ProductSearchByCategoryInput.ts:17

List of category IDs to search. Each category will be searched separately.

class?​

optional class?: ProductClass

Defined in: type/ProductSearchByCategoryInput.ts:41

Product class

clusterIds?​

optional clusterIds?: number[]

Defined in: type/ProductSearchByCategoryInput.ts:39

List of clusterIds to search for

companyId?​

optional companyId?: number

Defined in: type/ProductSearchByCategoryInput.ts:75

Browse catalog as a specific Company. Permissions, orderlists, favorite will be merged with the logged in user.

createdAt?​

optional createdAt?: DateSearchInput

Defined in: type/ProductSearchByCategoryInput.ts:77

Search by date created

EANCodes?​

optional EANCodes?: string[]

Defined in: type/ProductSearchByCategoryInput.ts:31

List of product EAN codes

facets?​

optional facets?: ProductSearchFacetInput[]

Defined in: type/ProductSearchByCategoryInput.ts:81

List of attribute IDs to include in faceted aggregations

getDescendants?​

optional getDescendants?: boolean

Defined in: type/ProductSearchByCategoryInput.ts:19

Include descendants of each category in the search

hasBundle?​

optional hasBundle?: YesNo

Defined in: type/ProductSearchByCategoryInput.ts:69

Is product in a bundle

hidden?​

optional hidden?: boolean

Defined in: type/ProductSearchByCategoryInput.ts:63

Is product hidden?

ids?​

optional ids?: number[]

Defined in: type/ProductSearchByCategoryInput.ts:35

List of unique product identifiers

inventory?​

optional inventory?: ProductSearchInventoryFilterInput

Defined in: type/ProductSearchByCategoryInput.ts:90

Server-side stock filter. Operators are inclusive: greaterThan: N is stock >= N and lessThan: N is stock <= N. Never-stocked products count as 0. Filtering is applied upstream, so itemsFound / pages reflect the filtered set.

isBundleLeader?​

optional isBundleLeader?: YesNo

Defined in: type/ProductSearchByCategoryInput.ts:71

Is product a bundle leader

language​

language: string

Defined in: type/ProductSearchByCategoryInput.ts:45

Specify through which language to search in, has no effect on other returned fields (eg. names,slugs)

lastModifiedAt?​

optional lastModifiedAt?: DateSearchInput

Defined in: type/ProductSearchByCategoryInput.ts:79

Search by date changed

manufacturerCodes?​

optional manufacturerCodes?: string[]

Defined in: type/ProductSearchByCategoryInput.ts:29

List of product manufacturer codes

manufacturers?​

optional manufacturers?: string[]

Defined in: type/ProductSearchByCategoryInput.ts:23

List of product manufacturers

offset​

offset: number

Defined in: type/ProductSearchByCategoryInput.ts:51

Pagination offset number [default=12][max: 500]

NOTE: If offset > 500 is supplied it will be capped to 500

orderlistIds?​

optional orderlistIds?: number[]

Defined in: type/ProductSearchByCategoryInput.ts:85

Order list IDs to apply for filtering

page​

page: number

Defined in: type/ProductSearchByCategoryInput.ts:47

Pagination page number [default=1]

price?​

optional price?: ProductSearchPriceFilterInput

Defined in: type/ProductSearchByCategoryInput.ts:57

Product price filter

priceSheetIds?​

optional priceSheetIds?: string[]

Defined in: type/ProductSearchByCategoryInput.ts:59

List of priceSheetIds (UUIDs) ordered by priority. The first priceSheetId has highest priority. Used to determine customer-specific pricing for sorting, filtering, and aggregation. When not provided, the default price is used.

productIds?​

optional productIds?: number[]

Defined in: type/ProductSearchByCategoryInput.ts:37

List of productIds to search for

rangeFilters?​

optional rangeFilters?: ProductSearchRangeFilterInput[]

Defined in: type/ProductSearchByCategoryInput.ts:55

List of range filters

searchFields?​

optional searchFields?: ProductSearchFieldsInput[]

Defined in: type/ProductSearchByCategoryInput.ts:67

List of product search fields

skus?​

optional skus?: string[]

Defined in: type/ProductSearchByCategoryInput.ts:33

List of product SKUS

sortInputs?​

optional sortInputs?: ProductSearchSortInput[]

Defined in: type/ProductSearchByCategoryInput.ts:65

List of product sort filters

statuses​

statuses: ProductStatus[]

Defined in: type/ProductSearchByCategoryInput.ts:61

List of product status filters

supplierCodes?​

optional supplierCodes?: string[]

Defined in: type/ProductSearchByCategoryInput.ts:25

List of product supplier codes

suppliers?​

optional suppliers?: string[]

Defined in: type/ProductSearchByCategoryInput.ts:27

List of product suppliers

tags?​

optional tags?: string[]

Defined in: type/ProductSearchByCategoryInput.ts:43

List of product tags

term?​

optional term?: string

Defined in: type/ProductSearchByCategoryInput.ts:21

Product search term

textFilters?​

optional textFilters?: ProductSearchTextFilterInput[]

Defined in: type/ProductSearchByCategoryInput.ts:53

List of text filters

userId?​

optional userId?: number

Defined in: type/ProductSearchByCategoryInput.ts:73

Browse catalog as a specific User. Permissions, orderlists, favorite will be merged with the logged in user.