Skip to main content

Interface: CategoryBaseProductsSearchInput

Defined in: type/CategoryBaseProductsSearchInput.ts:9

Input object for CategoryBaseProductsSearchInput

Properties​

applyOrderlists?​

optional applyOrderlists?: boolean

Defined in: type/CategoryBaseProductsSearchInput.ts:39

Whether to apply orderlist filtering

companyId?​

optional companyId?: number

Defined in: type/CategoryBaseProductsSearchInput.ts:45

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

getDescending?​

optional getDescending?: YesNo

Defined in: type/CategoryBaseProductsSearchInput.ts:23

Include products from descendant categories

hidden?​

optional hidden?: boolean

Defined in: type/CategoryBaseProductsSearchInput.ts:21

Filter base products by hidden status. true = only hidden, false = only non-hidden, null = no filter.

language?​

optional language?: string

Defined in: type/CategoryBaseProductsSearchInput.ts:29

Language for localized content

manufacturers?​

optional manufacturers?: string[]

Defined in: type/CategoryBaseProductsSearchInput.ts:17

Filter by manufacturers (applies to PRODUCT type only)

offset?​

optional offset?: number

Defined in: type/CategoryBaseProductsSearchInput.ts:27

Number of items per page

orderlistIds?​

optional orderlistIds?: number[]

Defined in: type/CategoryBaseProductsSearchInput.ts:41

Order list IDs to apply for filtering

page?​

optional page?: number

Defined in: type/CategoryBaseProductsSearchInput.ts:25

Page number for pagination

sortBy?​

optional sortBy?: BaseProductSortField

Defined in: type/CategoryBaseProductsSearchInput.ts:31

Field to sort by

sortOrder?​

optional sortOrder?: SortOrder

Defined in: type/CategoryBaseProductsSearchInput.ts:33

Sort order

source?​

optional source?: string

Defined in: type/CategoryBaseProductsSearchInput.ts:35

Source system name (must be used with sourceIds)

sourceIds?​

optional sourceIds?: string[]

Defined in: type/CategoryBaseProductsSearchInput.ts:37

Source IDs to filter by (must be used with source)

statuses?​

optional statuses?: ProductStatus[]

Defined in: type/CategoryBaseProductsSearchInput.ts:15

Filter by product statuses (applies to PRODUCT type only)

suppliers?​

optional suppliers?: string[]

Defined in: type/CategoryBaseProductsSearchInput.ts:19

Filter by suppliers (applies to PRODUCT type only)

term?​

optional term?: string

Defined in: type/CategoryBaseProductsSearchInput.ts:11

Search term for SKU and localized content

types?​

optional types?: ProductClass[]

Defined in: type/CategoryBaseProductsSearchInput.ts:13

Filter by base product types

userId?​

optional userId?: number

Defined in: type/CategoryBaseProductsSearchInput.ts:43

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