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

Details

type CollectionCountableConnection {
  pageInfo: PageInfo!
  edges: [CollectionCountableEdge!]!
  totalCount: Int
}

Arguments

filter ● CollectionFilterInput

Filtering options for collections.

where ● CollectionWhereInput

Where filtering options for collections.

sortBy ● CollectionSortingInput

Sort collections.

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.

Type

CollectionCountableConnection

Represents a connection to a list of collections.