Skip to main content

products Query

List of the shop's products.

Requires one of the following permissions to include the unpublished items: MANAGE_ORDERSMANAGE_DISCOUNTSMANAGE_PRODUCTS
products(
  filter: ProductFilterInput
  where: ProductWhereInput
  sortBy: ProductOrder
  search: String
  channel: String
  before: String
  after: String
  first: Int
  last: Int
): ProductCountableConnection

Arguments​

products.filter ● ProductFilterInput deprecated input products​

DEPRECATED

Use where filter instead.

Filtering options for products.

products.where ● ProductWhereInput input products​

Where filtering options for products.

products.sortBy ● ProductOrder input products​

Sort products.

products.search ● String scalar miscellaneous​

Search products.

products.channel ● String scalar miscellaneous​

Slug of a channel for which the data should be returned.

products.before ● String scalar miscellaneous​

Return the elements in the list that come before the specified cursor.

products.after ● String scalar miscellaneous​

Return the elements in the list that come after the specified cursor.

products.first ● Int scalar miscellaneous​

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

products.last ● Int scalar miscellaneous​

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

Type​

ProductCountableConnection object products​