Interface: ClusterSearchInput

Defined in: type/ClusterSearchInput.ts:4

Input object for ClusterSearchInput

Properties

applyOrderlists?

optional applyOrderlists?: boolean

Defined in: type/ClusterSearchInput.ts:24

Whether to apply orderlist filtering

---

categoryId?

optional categoryId?: number

Defined in: type/ClusterSearchInput.ts:12

Filter by category ID

---

clusterConfigId?

optional clusterConfigId?: number

Defined in: type/ClusterSearchInput.ts:16

Filter by cluster configuration ID

---

clusterIds?

optional clusterIds?: number[]

Defined in: type/ClusterSearchInput.ts:14

Filter by specific cluster IDs

---

companyId?

optional companyId?: number

Defined in: type/ClusterSearchInput.ts:22

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

---

hidden?

optional hidden?: boolean

Defined in: type/ClusterSearchInput.ts:18

Is cluster hidden?

---

language?

optional language?: string

Defined in: type/ClusterSearchInput.ts:32

Language for search and sorting

---

offset?

optional offset?: number

Defined in: type/ClusterSearchInput.ts:30

Number of items per page

---

orderlistIds?

optional orderlistIds?: number[]

Defined in: type/ClusterSearchInput.ts:26

Order list IDs to apply for filtering

---

page?

optional page?: number

Defined in: type/ClusterSearchInput.ts:28

Page number for pagination

---

skus?

optional skus?: string[]

Defined in: type/ClusterSearchInput.ts:8

Filter by SKUs

---

slugs?

optional slugs?: string[]

Defined in: type/ClusterSearchInput.ts:10

Filter by slugs (requires language parameter)

---

term?

optional term?: string

Defined in: type/ClusterSearchInput.ts:6

Search term for names, descriptions, or SKU

---

userId?

optional userId?: number

Defined in: type/ClusterSearchInput.ts:20

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