Skip to main content

ProductCategorySearchInput

Search criteria for product-associated categories. Inherits all CategorySearchInput functionality except categoryId filtering.

input ProductCategorySearchInput {
  name: String
  slugs: [String!]
  slug: [String!]
  parentCategoryIds: [Int!]
  parentCategoryId: [Int!]
  categoryIds: [Int!]
  uuids: [String!]
  hidden: YesNo
  createdAtFrom: String
  createdAtTo: String
  lastModifiedAtFrom: String
  lastModifiedAtTo: String
  dateCreatedFrom: String
  dateCreatedTo: String
  dateModifiedFrom: String
  dateModifiedTo: String
  page: Int
  offset: Int
  language: String
  sortField: CategorySortableFields
  sortOrder: SortOrder
  source: String
  sourceIds: [String!]
}

Fields

`ProductCategorySearchInput.name` ● `String` scalar

Search term for category names

`ProductCategorySearchInput.slugs` ● `[String!]` list scalar

Search by category slugs

`ProductCategorySearchInput.slug` ● `[String!]` list scalar

Deprecated: use slugs instead.

`ProductCategorySearchInput.parentCategoryIds` ● `[Int!]` list scalar

Filter by parent category IDs

`ProductCategorySearchInput.parentCategoryId` ● `[Int!]` list scalar

Deprecated: use parentCategoryIds instead.

`ProductCategorySearchInput.categoryIds` ● `[Int!]` list scalar

Filter by category IDs

`ProductCategorySearchInput.uuids` ● `[String!]` list scalar

Filter by category UUIDs

`ProductCategorySearchInput.hidden` ● `YesNo` enum

Filter by hidden status (Y or N)

`ProductCategorySearchInput.createdAtFrom` ● `String` scalar

Start date for creation date filtering (ISO 8601 format)

`ProductCategorySearchInput.createdAtTo` ● `String` scalar

End date for creation date filtering (ISO 8601 format)

`ProductCategorySearchInput.lastModifiedAtFrom` ● `String` scalar

Start date for modification date filtering (ISO 8601 format)

`ProductCategorySearchInput.lastModifiedAtTo` ● `String` scalar

End date for modification date filtering (ISO 8601 format)

`ProductCategorySearchInput.dateCreatedFrom` ● `String` scalar

Deprecated: use createdAtFrom instead. Start date for creation date filtering (ISO 8601 format)

`ProductCategorySearchInput.dateCreatedTo` ● `String` scalar

Deprecated: use createdAtTo instead. End date for creation date filtering (ISO 8601 format)

`ProductCategorySearchInput.dateModifiedFrom` ● `String` scalar

Deprecated: use lastModifiedAtFrom instead. Start date for modification date filtering (ISO 8601 format)

`ProductCategorySearchInput.dateModifiedTo` ● `String` scalar

Deprecated: use lastModifiedAtTo instead. End date for modification date filtering (ISO 8601 format)

`ProductCategorySearchInput.page` ● `Int` scalar

Page number for pagination

`ProductCategorySearchInput.offset` ● `Int` scalar

Number of items per page

`ProductCategorySearchInput.language` ● `String` scalar

Language for localized content

`ProductCategorySearchInput.sortField` ● `CategorySortableFields` enum

Field to sort the categories by

`ProductCategorySearchInput.sortOrder` ● `SortOrder` enum

Sort order for results.

Determines the sorting direction for the specified sort field. ASC = ascending order, DESC = descending order. Defaults to ascending order.

`ProductCategorySearchInput.source` ● `String` scalar

Source system name (must be used with sourceIds)

`ProductCategorySearchInput.sourceIds` ● `[String!]` list scalar

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

Fields