Schema Documentation

LineItemToProductConnectionWhereArgs

Description

Arguments for filtering the LineItemToProductConnection connection

Fields
Input FieldDescription
attribute - String Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.
attributeTerm - String Limit result set to products with a specific attribute term ID (required an assigned attribute).
category - String Limit result set to products assigned a specific category name.
categoryId - Int Limit result set to products assigned a specific category name.
categoryIdIn - [Int] Limit result set to products assigned to a specific group of category IDs.
categoryIdNotIn - [Int] Limit result set to products not assigned to a specific group of category IDs.
categoryIn - [String] Limit result set to products assigned to a group of specific categories by name.
categoryNotIn - [String] Limit result set to products not assigned to a group of specific categories by name.
dateQuery - DateQueryInput Filter the connection based on dates.
exclude - [Int] Ensure result set excludes specific IDs.
featured - Boolean Limit result set to featured products.
include - [Int] Limit result set to specific ids.
includeVariations - Boolean Include variations in the result set.
maxPrice - Float Limit result set to products based on a maximum price.
minPrice - Float Limit result set to products based on a minimum price.
onSale - Boolean Limit result set to products on sale.
orderby - [ProductsOrderbyInput] What paramater to use to order the objects by.
parent - Int Use ID to return only children. Use 0 to return only top-level items.
parentIn - [Int] Specify objects whose parent is in an array.
parentNotIn - [Int] Specify objects whose parent is not in an array.
rating - [Int] Limit result set to products with a specific average rating. Must be between 1 and 5
search - String Limit result set to products based on a keyword search.
shippingClassId - Int Limit result set to products assigned a specific shipping class ID.
sku - String Limit result set to products with specific SKU(s). Use commas to separate.
slugIn - [String] Limit result set to products with specific slugs.
status - String Limit result set to products assigned a specific status.
stockStatus - [StockStatusEnum] Limit result set to products in stock or out of stock.
supportedTypesOnly - Boolean Limit result types to types supported by WooGraphQL.
tag - String Limit result set to products assigned a specific tag name.
tagId - Int Limit result set to products assigned a specific tag ID.
tagIdIn - [Int] Limit result set to products assigned to a specific group of tag IDs.
tagIdNotIn - [Int] Limit result set to products not assigned to a specific group of tag IDs.
tagIn - [String] Limit result set to products assigned to a specific group of tags by name.
tagNotIn - [String] Limit result set to products not assigned to a specific group of tags by name.
taxonomyFilter - ProductTaxonomyInput Limit result set with complex set of taxonomy filters.
type - ProductTypesEnum Limit result set to products assigned a specific type.
typeIn - [ProductTypesEnum] Limit result set to products assigned to a group of specific types.
typeNotIn - [ProductTypesEnum] Limit result set to products not assigned to a group of specific types.
visibility - CatalogVisibilityEnum Limit result set to products with a specific visibility level.
Example
{"attribute":"xyz789","attributeTerm":"abc123","category":"abc123","categoryId":123,"categoryIdIn":[123],"categoryIdNotIn":[987],"categoryIn":["xyz789"],"categoryNotIn":["xyz789"],"dateQuery":DateQueryInput,"exclude":[987],"featured":false,"include":[987],"includeVariations":false,"maxPrice":123.45,"minPrice":987.65,"onSale":true,"orderby":[ProductsOrderbyInput],"parent":987,"parentIn":[123],"parentNotIn":[987],"rating":[123],"search":"xyz789","shippingClassId":987,"sku":"abc123","slugIn":["abc123"],"status":"abc123","stockStatus":["IN_STOCK"],"supportedTypesOnly":true,"tag":"xyz789","tagId":987,"tagIdIn":[987],"tagIdNotIn":[123],"tagIn":["abc123"],"tagNotIn":["xyz789"],"taxonomyFilter":ProductTaxonomyInput,"type":"BUNDLE","typeIn":["BUNDLE"],"typeNotIn":["BUNDLE"],"visibility":"CATALOG"}