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
Show return type

Arguments​

where ● ProductWhereInput​

Where filtering options for products.

sortBy ● ProductOrder​

Sort products.

Search products.

channel ● String​

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

before ● String​

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

after ● String​

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

first ● Int​

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

last ● Int​

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

Show deprecated

Type​

ProductCountableConnection​