Skip to main content

Interface: BaseProductSearchInput

Defined in: type/BaseProductSearchInput.ts:8

Input object for BaseProductSearchInput

Properties​

applyOrderlists?​

optional applyOrderlists?: boolean

Defined in: type/BaseProductSearchInput.ts:48

Whether to apply orderlist filtering

categoryId?​

optional categoryId?: number

Defined in: type/BaseProductSearchInput.ts:14

Filter by category ID

categoryUuid?​

optional categoryUuid?: string

Defined in: type/BaseProductSearchInput.ts:16

Filter by category UUID

clusterConfigId?​

optional clusterConfigId?: number

Defined in: type/BaseProductSearchInput.ts:24

Filter by cluster configuration ID

clusterIds?​

optional clusterIds?: number[]

Defined in: type/BaseProductSearchInput.ts:22

Filter by specific cluster IDs

companyId?​

optional companyId?: number

Defined in: type/BaseProductSearchInput.ts:70

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

dateCreatedFrom?​

optional dateCreatedFrom?: string

Defined in: type/BaseProductSearchInput.ts:52

Filter by creation date from (ISO string)

dateCreatedTo?​

optional dateCreatedTo?: string

Defined in: type/BaseProductSearchInput.ts:54

Filter by creation date to (ISO string)

dateModifiedFrom?​

optional dateModifiedFrom?: string

Defined in: type/BaseProductSearchInput.ts:56

Filter by modification date from (ISO string)

dateModifiedTo?​

optional dateModifiedTo?: string

Defined in: type/BaseProductSearchInput.ts:58

Filter by modification date to (ISO string)

getDescendants?​

optional getDescendants?: boolean

Defined in: type/BaseProductSearchInput.ts:18

Include items from descendant categories (requires categoryId or categoryUuid)

hidden?​

optional hidden?: boolean

Defined in: type/BaseProductSearchInput.ts:50

Is product hidden?

ids?​

optional ids?: number[]

Defined in: type/BaseProductSearchInput.ts:64

Filter by specific product/cluster IDs

language?​

optional language?: string

Defined in: type/BaseProductSearchInput.ts:32

Language for localized content

manufacturers?​

optional manufacturers?: string[]

Defined in: type/BaseProductSearchInput.ts:28

Filter by manufacturers (PRODUCT type only)

offset?​

optional offset?: number

Defined in: type/BaseProductSearchInput.ts:40

Items per page

orderlistIds?​

optional orderlistIds?: number[]

Defined in: type/BaseProductSearchInput.ts:46

Order list IDs to apply for filtering

page?​

optional page?: number

Defined in: type/BaseProductSearchInput.ts:38

Page number

productIds?​

optional productIds?: number[]

Defined in: type/BaseProductSearchInput.ts:20

Filter by specific product IDs

skus?​

optional skus?: string[]

Defined in: type/BaseProductSearchInput.ts:60

Filter by specific SKUs

slugs?​

optional slugs?: string[]

Defined in: type/BaseProductSearchInput.ts:62

Filter by specific slugs (requires language parameter)

sortBy?​

optional sortBy?: BaseProductSortField

Defined in: type/BaseProductSearchInput.ts:34

Sort field

sortOrder?​

optional sortOrder?: SortOrder

Defined in: type/BaseProductSearchInput.ts:36

Sort order

source?​

optional source?: string

Defined in: type/BaseProductSearchInput.ts:42

Source system name (required when sourceIds provided)

sourceIds?​

optional sourceIds?: string[]

Defined in: type/BaseProductSearchInput.ts:44

Source IDs from the specified source system

statuses?​

optional statuses?: ProductStatus[]

Defined in: type/BaseProductSearchInput.ts:26

Filter by product statuses (PRODUCT type only)

suppliers?​

optional suppliers?: string[]

Defined in: type/BaseProductSearchInput.ts:30

Filter by suppliers (PRODUCT type only)

term?​

optional term?: string

Defined in: type/BaseProductSearchInput.ts:10

Search term for SKU and localized content

types?​

optional types?: ProductClass[]

Defined in: type/BaseProductSearchInput.ts:12

Filter by product types

userId?​

optional userId?: number

Defined in: type/BaseProductSearchInput.ts:68

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

uuids?​

optional uuids?: string[]

Defined in: type/BaseProductSearchInput.ts:66

Filter by specific product/cluster UUIDs