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

  • type Collection implements Node {
  • # Stripped description of the collection, single line with HTML tags removed.
  • #
  • # Arguments
  • # truncateAt: Truncates string after the given length.
  • description(truncateAt: Int): String!
  • # The description of the collection, complete with HTML formatting.
  • descriptionHtml: HTML!
  • # A human-friendly unique string for the collection automatically generated from
  • # its title.
  • # Limit of 255 characters.
  • handle: String!
  • id: ID!
  • # Image associated with the collection.
  • #
  • # Arguments
  • # maxWidth: Image width in pixels between 1 and 2048
  • # maxHeight: Image height in pixels between 1 and 2048
  • # crop: If specified, crop the image keeping the specified region
  • # scale: Image size multiplier retina displays. Must be between 1
  • # and 3
  • image(maxWidth: Int, maxHeight: Int, crop: CropRegion, scale: Int): Image
  • # List of products in the collection.
  • #
  • # Arguments
  • # first: [Not documented]
  • # after: [Not documented]
  • # reverse: [Not documented]
  • products(first: Int!, after: String, reverse: Boolean): ProductConnection!
  • # The collection’s name. Limit of 255 characters.
  • title: String!
  • # The date and time when the collection was last modified.
  • updatedAt: DateTime!
  • }