Skip to main content

collections

List collections for a Storefront with optional filters.

Requires the publiccollection/read scope.

collections(
  after: String
  before: String
  collectionType: StringFilterInput
  first: Int
  last: Int
  numberOfTermAggregations: CollectionNumberOfTermAggregationsInput
  query: String
  slugs: [String]
  sortOrder: [CollectionSortInput]
  tagPrefixes: [StringFilterInput]
  tags: [StringFilterInput]
): PublicCollectionConnectionWithSearch!

Arguments​

collections.after ● String scalar​

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

collections.before ● String scalar​

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

collections.collectionType ● StringFilterInput input​

Filter Collections using collectionType

collections.first ● Int scalar​

Returns the first n elements from the list.

collections.last ● Int scalar​

Returns the last n elements from the list.

collections.numberOfTermAggregations ● CollectionNumberOfTermAggregationsInput input​

The number of results to return for each term aggregation. Defaults to 0 for each.

collections.query ● String scalar​

Query collections for certain terms. Searches several fields, including collection.description, collection.subtitle, collection.title, and collectionTags.

collections.slugs ● [String] list scalar​

Filter Collections using slugs

collections.sortOrder ● [CollectionSortInput] list input​

Sort Collections by a series of fields and directions.

collections.tagPrefixes ● [StringFilterInput] list input​

Filter Collections using Tag Prefixes (starts with).

collections.tags ● [StringFilterInput] list input​

Filter Collections using Tags.

Type​

PublicCollectionConnectionWithSearch object​

Paginate through PublicCollections