Skip to main content

collections Query

List of the shop's collections.

Requires one of the following permissions to include the unpublished items: MANAGE_ORDERSMANAGE_DISCOUNTSMANAGE_PRODUCTS
collections(
  filter: CollectionFilterInput
  where: CollectionWhereInput
  sortBy: CollectionSortingInput
  channel: String
  before: String
  after: String
  first: Int
  last: Int
): CollectionCountableConnection

Arguments​

collections.filter ● CollectionFilterInput input products​

Filtering options for collections.

collections.where ● CollectionWhereInput input products​

Where filtering options.

collections.sortBy ● CollectionSortingInput input products​

Sort collections.

collections.channel ● String scalar miscellaneous​

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

collections.before ● String scalar miscellaneous​

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

collections.after ● String scalar miscellaneous​

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

collections.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.

collections.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​

CollectionCountableConnection object products​

Represents a connection to a list of collections.