OBJECT

Collection

A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse.

link GraphQL Schema definition

1type Collection implements Node {
2
3# Stripped description of the collection, single line with HTML tags removed.
4#
5# Arguments
6# truncateAt: Truncates string after the given length.
7description(truncateAt: Int): String!
8
9# The description of the collection, complete with HTML formatting.
10descriptionHtml: HTML!
11
12# A human-friendly unique string for the collection automatically generated from
13# its title.
14# Limit of 255 characters.
15handle: String!
16
17id: ID!
18
19# Image associated with the collection.
20#
21# Arguments
22# maxWidth: Image width in pixels between 1 and 2048
23# maxHeight: Image height in pixels between 1 and 2048
24# crop: If specified, crop the image keeping the specified region
25# scale: Image size multiplier retina displays. Must be between 1 and 3
26image(maxWidth: Int, maxHeight: Int, crop: CropRegion, scale: Int): Image
27
28# List of products in the collection.
29products(first: Int!, after: String, reverse: Boolean): ProductConnection!
30
31# The collection’s name. Limit of 255 characters.
32title: String!
33
34# The date and time when the collection was last modified.
35updatedAt: DateTime!
36
37}