Interface: CategorySearchInput

Defined in: type/CategorySearchInput.ts:7

Input object for CategorySearchInput

Properties

categoryIds?

optional categoryIds?: number[]

Defined in: type/CategorySearchInput.ts:28

Filter by category IDs

---

createdAtFrom?

optional createdAtFrom?: string

Defined in: type/CategorySearchInput.ts:32

Start date for creation date filtering (ISO 8601 format)

---

createdAtTo?

optional createdAtTo?: string

Defined in: type/CategorySearchInput.ts:34

End date for creation date filtering (ISO 8601 format)

---

hidden?

optional hidden?: YesNo

Defined in: type/CategorySearchInput.ts:13

Find categories by their hidden status

---

language?

optional language?: string

Defined in: type/CategorySearchInput.ts:11

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

---

lastModifiedAtFrom?

optional lastModifiedAtFrom?: string

Defined in: type/CategorySearchInput.ts:36

Start date for modification date filtering (ISO 8601 format)

---

lastModifiedAtTo?

optional lastModifiedAtTo?: string

Defined in: type/CategorySearchInput.ts:38

End date for modification date filtering (ISO 8601 format)

---

name?

optional name?: string

Defined in: type/CategorySearchInput.ts:9

Find categories by name

---

offset?

optional offset?: number

Defined in: type/CategorySearchInput.ts:17

The amount of categories return per page

---

page?

optional page?: number

Defined in: type/CategorySearchInput.ts:15

The page number to return

---

parentCategoryIds?

optional parentCategoryIds?: number[]

Defined in: type/CategorySearchInput.ts:26

Filter by parent category IDs

---

slugs?

optional slugs?: string[]

Defined in: type/CategorySearchInput.ts:24

Search by category slugs

---

sortField?

optional sortField?: CategorySortableFields

Defined in: type/CategorySearchInput.ts:19

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

---

sortOrder

sortOrder: SortOrder

Defined in: type/CategorySearchInput.ts:21

Sort ordering ['desc' or 'asc']

---

source?

optional source?: string

Defined in: type/CategorySearchInput.ts:40

Source system name (must be used with sourceIds)

---

sourceIds?

optional sourceIds?: string[]

Defined in: type/CategorySearchInput.ts:42

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

---

uuids?

optional uuids?: string[]

Defined in: type/CategorySearchInput.ts:30

Filter by category UUIDs