Skip to main content

ProductFilterInput

Filtering options for products.

input ProductFilterInput {
  archiveStatus: ProductArchiveStatusEnum
  brandIds: [ID!]
  categoryIds: [ID!] @deprecated
  colorIds: [ID!] @deprecated
  deletionStatus: ProductDeletionStatusEnum @deprecated
  description: String
  includeBrandless: Boolean
  innerPack: Boolean
  keyword: String
  masterCarton: Boolean
  name: String
  pallet: Boolean
  productAttributeFilters: [ProductAttributeFilterInput!]
  productType: ProductTypeEnum
  quickSearch: String
  sizeIds: [ID!] @deprecated
  sku: String
  sortField: ProductSortFieldEnum
  sortType: SortTypeEnum
  status: ProductStatusEnum @deprecated
  styleIds: [ID!] @deprecated
  supplierIds: [ID!]
  upc: String
}

Fields​

ProductFilterInput.archiveStatus ● ProductArchiveStatusEnum enum products​

The archive status of the queried products.

ProductFilterInput.brandIds ● [ID!] list scalar common​

IDs of the brands to get products for.

ProductFilterInput.categoryIds ● [ID!] deprecated list scalar common​

DEPRECATED

Use productAttributeFilters instead. This argument will be removed in the future.

IDs of the categories to filter products by.

ProductFilterInput.colorIds ● [ID!] deprecated list scalar common​

DEPRECATED

Use productAttributeFilters instead. This argument will be removed in the future.

IDs of the colors to filter products by.

ProductFilterInput.deletionStatus ● ProductDeletionStatusEnum deprecated enum products​

DEPRECATED

Use archiveStatus instead. This argument will be removed in the future.

The deletion status of the queried products.

ProductFilterInput.description ● String scalar common​

ProductFilterInput.includeBrandless ● Boolean scalar common​

When true, include products with no brand in the result set (within the current company scope).

ProductFilterInput.innerPack ● Boolean scalar common​

ProductFilterInput.keyword ● String scalar common​

Filter products by keyword. Searches in name, SKU, UPC, product type, and description and brand name. This filter is case-insensitive and should have a minimum length of 3 characters. If a keyword with less than 3 characters is provided, it will be ignored.

ProductFilterInput.masterCarton ● Boolean scalar common​

ProductFilterInput.name ● String scalar common​

Filter products by name.

ProductFilterInput.pallet ● Boolean scalar common​

ProductFilterInput.productAttributeFilters ● [ProductAttributeFilterInput!] list input products​

Filter products by attribute values. Each entry filters by a specific attribute definition. Multiple entries are AND-combined (product must match all filters).

ProductFilterInput.productType ● ProductTypeEnum enum products​

ProductFilterInput.quickSearch ● String scalar common​

Fast product search scoped to SKU and name. This filter is case-insensitive and is optimized for product list search.

ProductFilterInput.sizeIds ● [ID!] deprecated list scalar common​

DEPRECATED

Use productAttributeFilters instead. This argument will be removed in the future.

IDs of the sizes to filter products by.

ProductFilterInput.sku ● String scalar common​

Filter products by SKU.

ProductFilterInput.sortField ● ProductSortFieldEnum enum products​

Field to sort orders by.

ProductFilterInput.sortType ● SortTypeEnum enum common​

Sort type for orders.

ProductFilterInput.status ● ProductStatusEnum deprecated enum products​

DEPRECATED

This argument will be removed in the future. Use archiveStatus instead to determine if the product is active or inactive(archived).

ProductFilterInput.styleIds ● [ID!] deprecated list scalar common​

DEPRECATED

Use productAttributeFilters instead. This argument will be removed in the future.

IDs of the styles to filter products by.

ProductFilterInput.supplierIds ● [ID!] list scalar common​

IDs of the suppliers associated with the products.

ProductFilterInput.upc ● String scalar common​

Filter products by UPC.

Member Of​

products query