Collection object

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

Connections

• metafields (MetafieldConnection!)

  A paginated list of metafields associated with the resource.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  namespace ( String )	Container for a set of metafields (maximum of 20 characters).
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false

• products (ProductConnection!)

  List of products in the collection.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( ProductCollectionSortKeys )	Sort the underlying list by the given key. Default value: COLLECTION_DEFAULT

Fields

• description (String!)

  Stripped description of the collection, single line with HTML tags removed.

  Argument	Description
  truncateAt ( Int )	Truncates string after the given length.

• descriptionHtml (HTML!)

  The description of the collection, complete with HTML formatting.

• handle (String!)

  A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.

• id (ID!)

  Globally unique identifier.

• image (Image)

  Image associated with the collection.

  Argument	Description
  crop ( CropRegion )	Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.
  maxHeight ( Int )	Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
  maxWidth ( Int )	Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
  scale ( Int )	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead. Default value: 1

• metafield (Metafield)

  The metafield associated with the resource.

  Argument	Description
  key ( String! ) required	Identifier for the metafield (maximum of 30 characters).
  namespace ( String! ) required	Container for a set of metafields (maximum of 20 characters).

• title (String!)

  The collection’s name. Limit of 255 characters.

• updatedAt (DateTime!)

  The date and time when the collection was last modified.

Types that return Collection

• Collection.node
• Product.collections
• QueryRoot.collectionByHandle
• QueryRoot.collections

Implements

• HasMetafields
• Node

An auto-generated type for paginating through multiple Collections.

Fields

• edges ([CollectionEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

Types that return Collection

• Collection.node
• Product.collections
• QueryRoot.collectionByHandle
• QueryRoot.collections

An auto-generated type which holds one Collection and a cursor during pagination.

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (Collection!)

  The item at the end of CollectionEdge.

Types that return Collection

• Collection.node
• Product.collections
• QueryRoot.collectionByHandle
• QueryRoot.collections

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

Connections

• products (ProductConnection!)

  List of products in the collection.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( ProductCollectionSortKeys )	Sort the underlying list by the given key. Default value: COLLECTION_DEFAULT

Fields

• description (String!)

  Stripped description of the collection, single line with HTML tags removed.

  Argument	Description
  truncateAt ( Int )	Truncates string after the given length.

• descriptionHtml (HTML!)

  The description of the collection, complete with HTML formatting.

• handle (String!)

  A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.

• id (ID!)

  Globally unique identifier.

• image (Image)

  Image associated with the collection.

  Argument	Description
  crop ( CropRegion )	Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.
  maxHeight ( Int )	Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
  maxWidth ( Int )	Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
  scale ( Int )	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead. Default value: 1

• title (String!)

  The collection’s name. Limit of 255 characters.

• updatedAt (DateTime!)

  The date and time when the collection was last modified.

Types that return Collection

• Product.collections
• QueryRoot.collectionByHandle
• QueryRoot.collections

Implements

• Node

An auto-generated type for paginating through multiple Collections.

Fields

• edges ([CollectionEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

An auto-generated type which holds one Collection and a cursor during pagination.

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (Collection!)

  The item at the end of CollectionEdge.

Types that return CollectionEdge

• CollectionConnection.edges

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

Connections

• products (ProductConnection!)

  List of products in the collection.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( ProductCollectionSortKeys )	Sort the underlying list by the given key. Default value: COLLECTION_DEFAULT

Fields

• description (String!)

  Stripped description of the collection, single line with HTML tags removed.

  Argument	Description
  truncateAt ( Int )	Truncates string after the given length.

• descriptionHtml (HTML!)

  The description of the collection, complete with HTML formatting.

• handle (String!)

  A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.

• id (ID!)

  Globally unique identifier.

• image (Image)

  Image associated with the collection.

  Argument	Description
  crop ( CropRegion )	Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.
  maxHeight ( Int )	Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
  maxWidth ( Int )	Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
  scale ( Int )	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead. Default value: 1

• title (String!)

  The collection’s name. Limit of 255 characters.

• updatedAt (DateTime!)

  The date and time when the collection was last modified.

Types that return Collection

• Product.collections
• QueryRoot.collectionByHandle
• QueryRoot.collections

Implements

• Node

An auto-generated type for paginating through multiple Collections.

Fields

• edges ([CollectionEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

An auto-generated type which holds one Collection and a cursor during pagination.

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (Collection!)

  The item at the end of CollectionEdge.

Types that return CollectionEdge

• CollectionConnection.edges

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

Connections

• products (ProductConnection!)

  List of products in the collection.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( ProductCollectionSortKeys )	Sort the underlying list by the given key. Default value: COLLECTION_DEFAULT

Fields

• description (String!)

  Stripped description of the collection, single line with HTML tags removed.

  Argument	Description
  truncateAt ( Int )	Truncates string after the given length.

• descriptionHtml (HTML!)

  The description of the collection, complete with HTML formatting.

• handle (String!)

  A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.

• id (ID!)

  Globally unique identifier.

• image (Image)

  Image associated with the collection.

  Argument	Description
  crop ( CropRegion )	Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.
  maxHeight ( Int )	Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
  maxWidth ( Int )	Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
  scale ( Int )	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead. Default value: 1

• title (String!)

  The collection’s name. Limit of 255 characters.

• updatedAt (DateTime!)

  The date and time when the collection was last modified.

Types that return Collection

• Product.collections
• QueryRoot.collectionByHandle
• QueryRoot.collections

Implements

• Node

An auto-generated type for paginating through multiple Collections.

Fields

• edges ([CollectionEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

An auto-generated type which holds one Collection and a cursor during pagination.

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (Collection!)

  The item at the end of CollectionEdge.

Types that return CollectionEdge

• CollectionConnection.edges

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

Connections

• products (ProductConnection!)

  List of products in the collection.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( ProductCollectionSortKeys )	Sort the underlying list by the given key. Default value: COLLECTION_DEFAULT

Fields

• description (String!)

  Stripped description of the collection, single line with HTML tags removed.

  Argument	Description
  truncateAt ( Int )	Truncates string after the given length.

• descriptionHtml (HTML!)

  The description of the collection, complete with HTML formatting.

• handle (String!)

  A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.

• id (ID!)

  Globally unique identifier.

• image (Image)

  Image associated with the collection.

  Argument	Description
  crop ( CropRegion )	Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.
  maxHeight ( Int )	Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
  maxWidth ( Int )	Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
  scale ( Int )	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead. Default value: 1

• title (String!)

  The collection’s name. Limit of 255 characters.

• updatedAt (DateTime!)

  The date and time when the collection was last modified.

Types that return Collection

• Product.collections
• QueryRoot.collectionByHandle
• QueryRoot.collections

Implements

• Node

An auto-generated type for paginating through multiple Collections.

Fields

• edges ([CollectionEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

An auto-generated type which holds one Collection and a cursor during pagination.

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (Collection!)

  The item at the end of CollectionEdge.

Types that return CollectionEdge

• CollectionConnection.edges

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

Connections

• products (ProductConnection!)

  List of products in the collection.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( ProductCollectionSortKeys )	Sort the underlying list by the given key. Default value: COLLECTION_DEFAULT

Fields

• description (String!)

  Stripped description of the collection, single line with HTML tags removed.

  Argument	Description
  truncateAt ( Int )	Truncates string after the given length.

• descriptionHtml (HTML!)

  The description of the collection, complete with HTML formatting.

• handle (String!)

  A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.

• id (ID!)

  Globally unique identifier.

• image (Image)

  Image associated with the collection.

  Argument	Description
  crop ( CropRegion )	Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.
  maxHeight ( Int )	Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
  maxWidth ( Int )	Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
  scale ( Int )	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead. Default value: 1

• title (String!)

  The collection’s name. Limit of 255 characters.

• updatedAt (DateTime!)

  The date and time when the collection was last modified.

Types that return Collection

• Product.collections
• QueryRoot.collectionByHandle
• QueryRoot.collections

Implements

• Node

An auto-generated type for paginating through multiple Collections.

Fields

• edges ([CollectionEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

An auto-generated type which holds one Collection and a cursor during pagination.

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (Collection!)

  The item at the end of CollectionEdge.

Types that return CollectionEdge

• CollectionConnection.edges

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

Connections

• products (ProductConnection!)

  List of products in the collection.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( ProductCollectionSortKeys )	Sort the underlying list by the given key. Default value: COLLECTION_DEFAULT

Fields

• description (String!)

  Stripped description of the collection, single line with HTML tags removed.

  Argument	Description
  truncateAt ( Int )	Truncates string after the given length.

• descriptionHtml (HTML!)

  The description of the collection, complete with HTML formatting.

• handle (String!)

  A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.

• id (ID!)

  Globally unique identifier.

• image (Image)

  Image associated with the collection.

  Argument	Description
  crop ( CropRegion )	Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.
  maxHeight ( Int )	Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
  maxWidth ( Int )	Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
  scale ( Int )	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead. Default value: 1

• title (String!)

  The collection’s name. Limit of 255 characters.

• updatedAt (DateTime!)

  The date and time when the collection was last modified.

Types that return Collection

• Product.collections
• QueryRoot.collectionByHandle
• QueryRoot.collections

Implements

• Node

An auto-generated type for paginating through multiple Collections.

Fields

• edges ([CollectionEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

An auto-generated type which holds one Collection and a cursor during pagination.

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (Collection!)

  The item at the end of CollectionEdge.

Types that return CollectionEdge

• CollectionConnection.edges

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

Connections

• products (ProductConnection!)

  List of products in the collection.

  Argument	Description
  after ( String )	Returns the elements that come after the specified cursor.
  before ( String )	Returns the elements that come before the specified cursor.
  first ( Int )	Returns up to the first n elements from the list.
  last ( Int )	Returns up to the last n elements from the list.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( ProductCollectionSortKeys )	Sort the underlying list by the given key. Default value: COLLECTION_DEFAULT

Fields

• description (String!)

  Stripped description of the collection, single line with HTML tags removed.

  Argument	Description
  truncateAt ( Int )	Truncates string after the given length.

• descriptionHtml (HTML!)

  The description of the collection, complete with HTML formatting.

• handle (String!)

  A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.

• id (ID!)

  Globally unique identifier.

• image (Image)

  Image associated with the collection.

  Argument	Description
  crop ( CropRegion )	Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.
  maxHeight ( Int )	Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
  maxWidth ( Int )	Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
  scale ( Int )	Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead. Default value: 1

• title (String!)

  The collection’s name. Limit of 255 characters.

• updatedAt (DateTime!)

  The date and time when the collection was last modified.

Types that return Collection

• Product.collections
• QueryRoot.collectionByHandle
• QueryRoot.collections

Implements

• Node

An auto-generated type for paginating through multiple Collections.

Fields

• edges ([CollectionEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

An auto-generated type which holds one Collection and a cursor during pagination.

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (Collection!)

  The item at the end of CollectionEdge.

Types that return CollectionEdge

• CollectionConnection.edges