Skip to main content

Interface: ProductSearchInput

Defined in: type/ProductSearchInput.ts:14

Input object for ProductSearchInput

Properties​

applyOrderlists?​

optional applyOrderlists?: boolean

Defined in: type/ProductSearchInput.ts:79

Enable or disable filtering for orderlists

categoryId?​

optional categoryId?: number

Defined in: type/ProductSearchInput.ts:73

Product unique category identifier

class?​

optional class?: ProductClass

Defined in: type/ProductSearchInput.ts:34

Product class

clusterIds?​

optional clusterIds?: number[]

Defined in: type/ProductSearchInput.ts:32

List of clusterIds to search for

companyId?​

optional companyId?: number

Defined in: type/ProductSearchInput.ts:67

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

containerSlugs?​

optional containerSlugs?: string[]

Defined in: type/ProductSearchInput.ts:63

Product container slug(s)

createdAt?​

optional createdAt?: DateSearchInput

Defined in: type/ProductSearchInput.ts:69

Search by date created

EANCodes?​

optional EANCodes?: string[]

Defined in: type/ProductSearchInput.ts:26

List of product EAN codes

getDescendants?​

optional getDescendants?: boolean

Defined in: type/ProductSearchInput.ts:77

Get all descending products (true) or only the direct child products (false) of the given categoryId when supplied.

hasBundle?​

optional hasBundle?: YesNo

Defined in: type/ProductSearchInput.ts:59

Is product in a bundle

hidden?​

optional hidden?: boolean

Defined in: type/ProductSearchInput.ts:53

Is product hidden?

ids?​

optional ids?: number[]

Defined in: type/ProductSearchInput.ts:28

List of unique product identifiers

inventory?​

optional inventory?: ProductSearchInventoryFilterInput

Defined in: type/ProductSearchInput.ts:86

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/ProductSearchInput.ts:61

Is product a bundle leader

language​

language: string

Defined in: type/ProductSearchInput.ts:38

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

lastModifiedAt?​

optional lastModifiedAt?: DateSearchInput

Defined in: type/ProductSearchInput.ts:71

Search by date changed

manufacturerCodes?​

optional manufacturerCodes?: string[]

Defined in: type/ProductSearchInput.ts:24

List of product manufacturer codes

manufacturers?​

optional manufacturers?: string[]

Defined in: type/ProductSearchInput.ts:18

List of product manufacturers

offset​

offset: number

Defined in: type/ProductSearchInput.ts:43

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/ProductSearchInput.ts:81

List orderlists to apply

page​

page: number

Defined in: type/ProductSearchInput.ts:40

Pagination page number [default=1]

price?​

optional price?: ProductPriceFilterInput

Defined in: type/ProductSearchInput.ts:49

Product price filter

productIds?​

optional productIds?: number[]

Defined in: type/ProductSearchInput.ts:30

List of productIds to search for

rangeFilters?​

optional rangeFilters?: ProductRangeFilterInput[]

Defined in: type/ProductSearchInput.ts:47

List of range filters

searchFields?​

optional searchFields?: SearchFieldsInput[]

Defined in: type/ProductSearchInput.ts:57

List of product search fields

skus?​

optional skus?: string[]

Defined in: type/ProductSearchInput.ts:75

List of product SKUs

sortInputs?​

optional sortInputs?: ProductSortInput[]

Defined in: type/ProductSearchInput.ts:55

List of product sort filters

statuses​

statuses: ProductStatus[]

Defined in: type/ProductSearchInput.ts:51

List of product status filters

supplierCodes?​

optional supplierCodes?: string[]

Defined in: type/ProductSearchInput.ts:20

List of product supplier codes

suppliers?​

optional suppliers?: string[]

Defined in: type/ProductSearchInput.ts:22

List of product suppliers

tags?​

optional tags?: string[]

Defined in: type/ProductSearchInput.ts:36

List of product tags

term?​

optional term?: string

Defined in: type/ProductSearchInput.ts:16

Product search term

textFilters?​

optional textFilters?: ProductTextFilterInput[]

Defined in: type/ProductSearchInput.ts:45

List of text filters

userId?​

optional userId?: number

Defined in: type/ProductSearchInput.ts:65

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