API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

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.

Required access

unauthenticated_read_product_listings access scope.

Connections

products (ProductConnection!)

List of products in the collection.

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.

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.

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

Implements

Fields

edges ([CollectionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Types that return Collection

Fields

cursor (String!)

A cursor for use in pagination.

node (Collection!)

The item at the end of CollectionEdge.

Types that return Collection

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

Required access

unauthenticated_read_product_listings access scope.

Connections

products (ProductConnection!)

List of products in the collection.

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.

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.

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

Implements

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Fields

cursor (String!)

A cursor for use in pagination.

node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge

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

Required access

unauthenticated_read_product_listings access scope.

Connections

products (ProductConnection!)

List of products in the collection.

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.

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.

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

Implements

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Fields

cursor (String!)

A cursor for use in pagination.

node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge

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

Required access

unauthenticated_read_product_listings access scope.

Connections

products (ProductConnection!)

List of products in the collection.

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.

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.

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

Implements

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Fields

cursor (String!)

A cursor for use in pagination.

node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge

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

Required access

unauthenticated_read_product_listings access scope.

Connections

products (ProductConnection!)

List of products in the collection.

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.

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.

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

Implements

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Fields

cursor (String!)

A cursor for use in pagination.

node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge

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

Required access

unauthenticated_read_product_listings access scope.

Connections

products (ProductConnection!)

List of products in the collection.

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.

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.

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

Implements

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Fields

cursor (String!)

A cursor for use in pagination.

node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge

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

Required access

unauthenticated_read_product_listings access scope.

Connections

products (ProductConnection!)

List of products in the collection.

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.

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.

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

Implements

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Fields

cursor (String!)

A cursor for use in pagination.

node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge

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

Required access

unauthenticated_read_product_listings access scope.

Connections

products (ProductConnection!)

List of products in the collection.

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.

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.

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

Implements

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Fields

cursor (String!)

A cursor for use in pagination.

node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge