Skip to main content

Interface: CategoryProductSearchInput

Defined in: type/CategoryProductSearchInput.ts:13

Input object for CategoryProductSearchInput

Properties​

class?​

optional class?: ProductClass

Defined in: type/CategoryProductSearchInput.ts:33

Product class

clusterIds?​

optional clusterIds?: number[]

Defined in: type/CategoryProductSearchInput.ts:31

List of clusterIds to search for

companyId?​

optional companyId?: number

Defined in: type/CategoryProductSearchInput.ts:68

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

containerPathSlugs?​

optional containerPathSlugs?: string[]

Defined in: type/CategoryProductSearchInput.ts:64

Product path slug(s)

containerSlugs?​

optional containerSlugs?: string[]

Defined in: type/CategoryProductSearchInput.ts:62

Product container slug(s)

createdAt?​

optional createdAt?: DateSearchInput

Defined in: type/CategoryProductSearchInput.ts:70

Search by date created

EANCodes?​

optional EANCodes?: string[]

Defined in: type/CategoryProductSearchInput.ts:25

List of product EAN codes

getDescendants?​

optional getDescendants?: boolean

Defined in: type/CategoryProductSearchInput.ts:74

Get all descending products (true) or only the direct child products of this category (false)

hasBundle?​

optional hasBundle?: YesNo

Defined in: type/CategoryProductSearchInput.ts:58

Is product in a bundle

hidden?​

optional hidden?: boolean

Defined in: type/CategoryProductSearchInput.ts:52

Is product hidden?

ids?​

optional ids?: number[]

Defined in: type/CategoryProductSearchInput.ts:27

List of unique product identifiers

isBundleLeader?​

optional isBundleLeader?: YesNo

Defined in: type/CategoryProductSearchInput.ts:60

Is product a bundle leader

language​

language: string

Defined in: type/CategoryProductSearchInput.ts:37

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

lastModifiedAt?​

optional lastModifiedAt?: DateSearchInput

Defined in: type/CategoryProductSearchInput.ts:72

Search by date changed

manufacturerCodes?​

optional manufacturerCodes?: string[]

Defined in: type/CategoryProductSearchInput.ts:23

List of product manufacturer codes

manufacturers?​

optional manufacturers?: string[]

Defined in: type/CategoryProductSearchInput.ts:17

List of product manufacturers

offset​

offset: number

Defined in: type/CategoryProductSearchInput.ts:42

Pagination offset number [default=12][max: 500] NOTE: If offset > 500 is supplied it will be capped to 500

page​

page: number

Defined in: type/CategoryProductSearchInput.ts:39

Pagination page number [default=1]

price?​

optional price?: ProductPriceFilterInput

Defined in: type/CategoryProductSearchInput.ts:48

Product price filter

productIds?​

optional productIds?: number[]

Defined in: type/CategoryProductSearchInput.ts:29

List of productIds to search for

rangeFilters?​

optional rangeFilters?: ProductRangeFilterInput[]

Defined in: type/CategoryProductSearchInput.ts:46

List of range filters

searchFields?​

optional searchFields?: SearchFieldsInput[]

Defined in: type/CategoryProductSearchInput.ts:56

List of product search fields

skus?​

optional skus?: string[]

Defined in: type/CategoryProductSearchInput.ts:76

List of product SKUs

sortInputs?​

optional sortInputs?: ProductSortInput[]

Defined in: type/CategoryProductSearchInput.ts:54

List of product sort filters

statuses​

statuses: ProductStatus[]

Defined in: type/CategoryProductSearchInput.ts:50

List of product status filters

supplierCodes?​

optional supplierCodes?: string[]

Defined in: type/CategoryProductSearchInput.ts:19

List of product supplier codes

suppliers?​

optional suppliers?: string[]

Defined in: type/CategoryProductSearchInput.ts:21

List of product suppliers

tags?​

optional tags?: string[]

Defined in: type/CategoryProductSearchInput.ts:35

List of product tags

term?​

optional term?: string

Defined in: type/CategoryProductSearchInput.ts:15

Product search term

textFilters?​

optional textFilters?: ProductTextFilterInput[]

Defined in: type/CategoryProductSearchInput.ts:44

List of text filters

userId?​

optional userId?: number

Defined in: type/CategoryProductSearchInput.ts:66

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