Interface: ClusterCategorySearchInput

Defined in: type/ClusterCategorySearchInput.ts:7

Input object for ClusterCategorySearchInput

Properties

hidden?

optional hidden?: YesNo

Defined in: type/ClusterCategorySearchInput.ts:17

Find categories by their hidden status

---

language?

optional language?: string

Defined in: type/ClusterCategorySearchInput.ts:11

The language to use when searching categories by name or slug. When omitted the categories default language is used

---

name?

optional name?: string

Defined in: type/ClusterCategorySearchInput.ts:9

Find categories by name

---

offset?

optional offset?: number

Defined in: type/ClusterCategorySearchInput.ts:21

The amount of categories return per page

---

page?

optional page?: number

Defined in: type/ClusterCategorySearchInput.ts:19

The page number to return

---

parentCategoryId?

optional parentCategoryId?: number[]

Defined in: type/ClusterCategorySearchInput.ts:15

Find categories by one or more parentCategoryIds

---

slug?

optional slug?: string[]

Defined in: type/ClusterCategorySearchInput.ts:13

Find categories by one or more slugs

---

sortField?

optional sortField?: CategorySortableFields

Defined in: type/ClusterCategorySearchInput.ts:23

Available sortable fields One of: [name, dateCreated, entityDateChanged]

---

sortOrder

sortOrder: SortOrder

Defined in: type/ClusterCategorySearchInput.ts:25

Sort ordering ['desc' or 'asc']