Skip to main content
Version: 3.x

collections

List of the shop's collections. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.

collections(
filter: CollectionFilterInput
sortBy: CollectionSortingInput
channel: String
before: String
after: String
first: Int
last: Int
): CollectionCountableConnection

Arguments

filter (CollectionFilterInput)

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)

Return the first n elements from the list.

last (Int)

Return the last n elements from the list.

Type

CollectionCountableConnection