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

Version unstable

Represents a collection of products.

Required access

read_products access scope.

Connections

metafields (MetafieldConnection!)

A paginated list of metafields associated with the resource.
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 )

Finds all metafields with a specific namespace under the resource.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
privateMetafields (PrivateMetafieldConnection!)

List of private metafields.
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 )

Filter the private metafields by namespace.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
products (ProductConnection!)

The products that are included 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.
query ( String )

This field is only used when the collection is smart. If the collection is custom it returns an error. Supported filter parameters:

  • title
  • product_type
  • vendor
  • gift_card
  • created_at
  • updated_at

See the detailed search syntax.
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
resourcePublications (ResourcePublicationConnection!)

The list of resources that are published to a publication.

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published. Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
resourcePublicationsV2 (ResourcePublicationV2Connection!)

The list of resources that are either published or staged to be published to a publication.

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published. Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
unpublishedPublications (PublicationConnection!)

The list of publications that the resource is not published to.

Required access

read_publications access scope.
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

Fields

availablePublicationCount (Int!)

The number of publications a resource is published to without feedback errors.

Required access

read_publications access scope.
description (String!)

The stripped description of the collection, in a 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.
feedback (ResourceFeedback)

Information about the collection that's provided through resource feedback.
handle (String!)

A unique human-friendly string for the collection. Automatically generated from the collection's title.
hasProduct (Boolean!)

Whether the collection includes a product.
id ( ID! ) required

The ID of the product to check.
id (ID!)

Globally unique identifier.
image (Image)

The 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
legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.
metafield (Metafield)

The metafield associated with the resource.
key ( String! ) required

Identifier for the metafield (maximum of 30 characters).
namespace ( String! ) required

Container for a set of metafields (maximum of 20 characters).
privateMetafield (PrivateMetafield)

Returns a private metafield found by namespace and key.
key ( String! ) required

The key for the private metafield.
namespace ( String! ) required

The namespace for the private metafield.
productsCount (Int!)

The number of products included in the collection.
publicationCount (Int!)

The number of publications a resource is published on.

Required access

read_publications access scope.
onlyPublished ( Boolean )

Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.Default value: true
publishedOnCurrentPublication (Boolean!)

Check to see whether the resource is published to the calling app's publication.

Required access

read_product_listings access scope.
publishedOnPublication (Boolean!)

Check to see whether the resource is published to a given publication.

Required access

read_publications access scope.
publicationId ( ID! ) required

The ID of the publication to check.
ruleSet (CollectionRuleSet)

The rules used to assign products to the collection. This applies only to smart collections.
seo (SEO!)

SEO information for the collection.
sortOrder (CollectionSortOrder!)

The order in which the collection's products are sorted.
storefrontId (StorefrontID!)

The storefront ID of the collection.
templateSuffix (String)

The theme template used when viewing this collection in a store.
title (String!)

The title of the collection.
translations ([PublishedTranslation!]!)

The translations associated with the resource.
locale ( String! ) required

Filters translations locale.
updatedAt (DateTime!)

The date and time (ISO 8601 format) when the collection was last modified.

Types that return Collection

Mutations for Collection

collectionAddProducts

Adds products to a collection.
collectionCreate

Creates a collection.
collectionDelete

Deletes a collection.
collectionRemoveProducts

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.
collectionReorderProducts

Asynchronously reorders a set of products from a given collection.
collectionUpdate

Updates a collection.

Implements

Deprecated fields

publications (CollectionPublicationConnection!) deprecated

The channels where the collection is published.

Deprecation warning

Use resourcePublications instead

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether or not to return only the collection publications that are published.Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
publishedOnChannel (Boolean!) deprecated

Check to see whether the resource is published to a given channel.

Deprecation warning

Use publishedOnPublication instead

Required access

read_publications access scope.
channelId ( ID! ) required

The ID of the channel to check.
publishedOnCurrentChannel (Boolean!) deprecated

Check to see whether the resource is published to the calling app's channel.

Deprecation warning

Use publishedOnCurrentPublication instead

Required access

read_product_listings access scope.
unpublishedChannels (ChannelConnection!) deprecated

The list of channels that the resource is not published to.

Deprecation warning

Use unpublishedPublications instead

Required access

read_publications access scope.
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
Version unstable

Fields

edges ([CollectionEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.

Types that return Collection

Mutations for Collection

collectionAddProducts

Adds products to a collection.
collectionCreate

Creates a collection.
collectionDelete

Deletes a collection.
collectionRemoveProducts

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.
collectionReorderProducts

Asynchronously reorders a set of products from a given collection.
collectionUpdate

Updates a collection.
Version unstable

Fields

cursor (String!)

A cursor for use in pagination.
node (Collection!)

The item at the end of CollectionEdge.

Types that return Collection

Mutations for Collection

collectionAddProducts

Adds products to a collection.
collectionCreate

Creates a collection.
collectionDelete

Deletes a collection.
collectionRemoveProducts

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.
collectionReorderProducts

Asynchronously reorders a set of products from a given collection.
collectionUpdate

Updates a collection.
Version 2021-01 (Release candidate)

Represents a collection of products.

Required access

read_products access scope.

Connections

metafields (MetafieldConnection!)

A paginated list of metafields associated with the resource.
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 )

Finds all metafields with a specific namespace under the resource.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
privateMetafields (PrivateMetafieldConnection!)

List of private metafields.
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 )

Filter the private metafields by namespace.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
products (ProductConnection!)

The products that are included 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.
query ( String )

This field is only used when the collection is smart. If the collection is custom it returns an error. Supported filter parameters:

  • title
  • product_type
  • vendor
  • gift_card
  • created_at
  • updated_at

See the detailed search syntax.
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
resourcePublications (ResourcePublicationConnection!)

The list of resources that are published to a publication.

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published. Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
resourcePublicationsV2 (ResourcePublicationV2Connection!)

The list of resources that are either published or staged to be published to a publication.

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published. Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
unpublishedPublications (PublicationConnection!)

The list of publications that the resource is not published to.

Required access

read_publications access scope.
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

Fields

availablePublicationCount (Int!)

The number of publications a resource is published to without feedback errors.

Required access

read_publications access scope.
description (String!)

The stripped description of the collection, in a 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.
feedback (ResourceFeedback)

Information about the collection that's provided through resource feedback.
handle (String!)

A unique human-friendly string for the collection. Automatically generated from the collection's title.
hasProduct (Boolean!)

Whether the collection includes a product.
id ( ID! ) required

The ID of the product to check.
id (ID!)

Globally unique identifier.
image (Image)

The 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
legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.
metafield (Metafield)

The metafield associated with the resource.
key ( String! ) required

Identifier for the metafield (maximum of 30 characters).
namespace ( String! ) required

Container for a set of metafields (maximum of 20 characters).
privateMetafield (PrivateMetafield)

Returns a private metafield found by namespace and key.
key ( String! ) required

The key for the private metafield.
namespace ( String! ) required

The namespace for the private metafield.
productsCount (Int!)

The number of products included in the collection.
publicationCount (Int!)

The number of publications a resource is published on.

Required access

read_publications access scope.
onlyPublished ( Boolean )

Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.Default value: true
publishedOnCurrentPublication (Boolean!)

Check to see whether the resource is published to the calling app's publication.

Required access

read_product_listings access scope.
publishedOnPublication (Boolean!)

Check to see whether the resource is published to a given publication.

Required access

read_publications access scope.
publicationId ( ID! ) required

The ID of the publication to check.
ruleSet (CollectionRuleSet)

The rules used to assign products to the collection. This applies only to smart collections.
seo (SEO!)

SEO information for the collection.
sortOrder (CollectionSortOrder!)

The order in which the collection's products are sorted.
storefrontId (StorefrontID!)

The storefront ID of the collection.
templateSuffix (String)

The theme template used when viewing this collection in a store.
title (String!)

The title of the collection.
translations ([PublishedTranslation!]!)

The translations associated with the resource.
locale ( String! ) required

Filters translations locale.
updatedAt (DateTime!)

The date and time (ISO 8601 format) when the collection was last modified.

Types that return Collection

Mutations for Collection

collectionAddProducts

Adds products to a collection.
collectionCreate

Creates a collection.
collectionDelete

Deletes a collection.
collectionRemoveProducts

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.
collectionReorderProducts

Asynchronously reorders a set of products from a given collection.
collectionUpdate

Updates a collection.

Implements

Deprecated fields

publications (CollectionPublicationConnection!) deprecated

The channels where the collection is published.

Deprecation warning

Use resourcePublications instead

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether or not to return only the collection publications that are published.Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
publishedOnChannel (Boolean!) deprecated

Check to see whether the resource is published to a given channel.

Deprecation warning

Use publishedOnPublication instead

Required access

read_publications access scope.
channelId ( ID! ) required

The ID of the channel to check.
publishedOnCurrentChannel (Boolean!) deprecated

Check to see whether the resource is published to the calling app's channel.

Deprecation warning

Use publishedOnCurrentPublication instead

Required access

read_product_listings access scope.
unpublishedChannels (ChannelConnection!) deprecated

The list of channels that the resource is not published to.

Deprecation warning

Use unpublishedPublications instead

Required access

read_publications access scope.
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
Version 2021-01 (Release candidate)

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2021-01 (Release candidate)

Fields

cursor (String!)

A cursor for use in pagination.
node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge

Version 2020-10 (Latest)

Represents a collection of products.

Required access

read_products access scope.

Connections

metafields (MetafieldConnection!)

A paginated list of metafields associated with the resource.
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 )

Finds all metafields with a specific namespace under the resource.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
privateMetafields (PrivateMetafieldConnection!)

List of private metafields.
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 )

Filter the private metafields by namespace.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
products (ProductConnection!)

The products that are included 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.
query ( String )

This field is only used when the collection is smart. If the collection is custom it returns an error. Supported filter parameters:

  • title
  • product_type
  • vendor
  • gift_card
  • created_at
  • updated_at

See the detailed search syntax.
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
resourcePublications (ResourcePublicationConnection!)

The list of resources that are published to a publication.

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published. Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
resourcePublicationsV2 (ResourcePublicationV2Connection!)

The list of resources that are either published or staged to be published to a publication.

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published. Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
unpublishedPublications (PublicationConnection!)

The list of publications that the resource is not published to.

Required access

read_publications access scope.
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

Fields

availablePublicationCount (Int!)

The number of publications a resource is published to without feedback errors.

Required access

read_publications access scope.
description (String!)

The stripped description of the collection, in a 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.
feedback (ResourceFeedback)

Information about the collection that's provided through resource feedback.
handle (String!)

A unique human-friendly string for the collection. Automatically generated from the collection's title.
hasProduct (Boolean!)

Whether the collection includes a product.
id ( ID! ) required

The ID of the product to check.
id (ID!)

Globally unique identifier.
image (Image)

The 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
metafield (Metafield)

The metafield associated with the resource.
key ( String! ) required

Identifier for the metafield (maximum of 30 characters).
namespace ( String! ) required

Container for a set of metafields (maximum of 20 characters).
privateMetafield (PrivateMetafield)

Returns a private metafield found by namespace and key.
key ( String! ) required

The key for the private metafield.
namespace ( String! ) required

The namespace for the private metafield.
productsCount (Int!)

The number of products included in the collection.
publicationCount (Int!)

The number of publications a resource is published on.

Required access

read_publications access scope.
onlyPublished ( Boolean )

Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.Default value: true
publishedOnCurrentPublication (Boolean!)

Check to see whether the resource is published to the calling app's publication.

Required access

read_product_listings access scope.
publishedOnPublication (Boolean!)

Check to see whether the resource is published to a given publication.

Required access

read_publications access scope.
publicationId ( ID! ) required

The ID of the publication to check.
ruleSet (CollectionRuleSet)

The rules used to assign products to the collection. This applies only to smart collections.
seo (SEO!)

SEO information for the collection.
sortOrder (CollectionSortOrder!)

The order in which the collection's products are sorted.
storefrontId (StorefrontID!)

The storefront ID of the collection.
templateSuffix (String)

The theme template used when viewing this collection in a store.
title (String!)

The title of the collection.
translations ([PublishedTranslation!]!)

The translations associated with the resource.
locale ( String! ) required

Filters translations locale.
updatedAt (DateTime!)

The date and time (ISO 8601 format) when the collection was last modified.

Types that return Collection

Mutations for Collection

collectionAddProducts

Adds products to a collection.
collectionCreate

Creates a collection.
collectionDelete

Deletes a collection.
collectionRemoveProducts

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.
collectionReorderProducts

Asynchronously reorders a set of products from a given collection.
collectionUpdate

Updates a collection.

Implements

Deprecated fields

publications (CollectionPublicationConnection!) deprecated

The channels where the collection is published.

Deprecation warning

Use resourcePublications instead

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether or not to return only the collection publications that are published.Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
publishedOnChannel (Boolean!) deprecated

Check to see whether the resource is published to a given channel.

Deprecation warning

Use publishedOnPublication instead

Required access

read_publications access scope.
channelId ( ID! ) required

The ID of the channel to check.
publishedOnCurrentChannel (Boolean!) deprecated

Check to see whether the resource is published to the calling app's channel.

Deprecation warning

Use publishedOnCurrentPublication instead

Required access

read_product_listings access scope.
unpublishedChannels (ChannelConnection!) deprecated

The list of channels that the resource is not published to.

Deprecation warning

Use unpublishedPublications instead

Required access

read_publications access scope.
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
Version 2020-10 (Latest)

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2020-10 (Latest)

Fields

cursor (String!)

A cursor for use in pagination.
node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge

Version 2020-07

Represents a collection of products.

Required access

read_products access scope.

Connections

metafields (MetafieldConnection!)

A paginated list of metafields associated with the resource.
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 )

Finds all metafields with a specific namespace under the resource.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
privateMetafields (PrivateMetafieldConnection!)

List of private metafields.
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 )

Filter the private metafields by namespace.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
products (ProductConnection!)

The products that are included 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.
query ( String )

This field is only used when the collection is smart. If the collection is custom it returns an error. Supported filter parameters:

  • title
  • product_type
  • vendor
  • gift_card
  • created_at
  • updated_at

See the detailed search syntax.
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
resourcePublications (ResourcePublicationConnection!)

The list of resources that are published to a publication.

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published. Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
unpublishedPublications (PublicationConnection!)

The list of publications that the resource is not published to.

Required access

read_publications access scope.
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

Fields

availablePublicationCount (Int!)

The number of publications a resource is published to without feedback errors.

Required access

read_publications access scope.
description (String!)

The stripped description of the collection, in a 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.
feedback (ResourceFeedback)

Information about the collection that's provided through resource feedback.
handle (String!)

A unique human-friendly string for the collection. Automatically generated from the collection's title.
hasProduct (Boolean!)

Whether the collection includes a product.
id ( ID! ) required

The ID of the product to check.
id (ID!)

Globally unique identifier.
image (Image)

The 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
metafield (Metafield)

The metafield associated with the resource.
key ( String! ) required

Identifier for the metafield (maximum of 30 characters).
namespace ( String! ) required

Container for a set of metafields (maximum of 20 characters).
privateMetafield (PrivateMetafield)

Returns a private metafield found by namespace and key.
key ( String! ) required

The key for the private metafield.
namespace ( String! ) required

The namespace for the private metafield.
productsCount (Int!)

The number of products included in the collection.
publicationCount (Int!)

The number of publications a resource is published on.

Required access

read_publications access scope.
onlyPublished ( Boolean )

Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.Default value: true
publishedOnCurrentPublication (Boolean!)

Check to see whether the resource is published to the calling app's publication.

Required access

read_product_listings access scope.
publishedOnPublication (Boolean!)

Check to see whether the resource is published to a given publication.

Required access

read_publications access scope.
publicationId ( ID! ) required

The ID of the publication to check.
ruleSet (CollectionRuleSet)

The rules used to assign products to the collection. This applies only to smart collections.
seo (SEO!)

SEO information for the collection.
sortOrder (CollectionSortOrder!)

The order in which the collection's products are sorted.
storefrontId (StorefrontID!)

The storefront ID of the collection.
templateSuffix (String)

The theme template used when viewing this collection in a store.
title (String!)

The title of the collection.
translations ([PublishedTranslation!]!)

The translations associated with the resource.
locale ( String! ) required

Filters translations locale.
updatedAt (DateTime!)

The date and time (ISO 8601 format) when the collection was last modified.

Types that return Collection

Mutations for Collection

collectionAddProducts

Adds products to a collection.
collectionCreate

Creates a collection.
collectionDelete

Deletes a collection.
collectionRemoveProducts

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.
collectionReorderProducts

Asynchronously reorders a set of products from a given collection.
collectionUpdate

Updates a collection.

Implements

Deprecated fields

publications (CollectionPublicationConnection!) deprecated

The channels where the collection is published.

Deprecation warning

Use resourcePublications instead

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether or not to return only the collection publications that are published.Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
publishedOnChannel (Boolean!) deprecated

Check to see whether the resource is published to a given channel.

Deprecation warning

Use publishedOnPublication instead

Required access

read_publications access scope.
channelId ( ID! ) required

The ID of the channel to check.
publishedOnCurrentChannel (Boolean!) deprecated

Check to see whether the resource is published to the calling app's channel.

Deprecation warning

Use publishedOnCurrentPublication instead

Required access

read_product_listings access scope.
unpublishedChannels (ChannelConnection!) deprecated

The list of channels that the resource is not published to.

Deprecation warning

Use unpublishedPublications instead

Required access

read_publications access scope.
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
Version 2020-07

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2020-07

Fields

cursor (String!)

A cursor for use in pagination.
node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge

Version 2020-04

Represents a collection of products.

Required access

read_products access scope.

Connections

metafields (MetafieldConnection!)

A paginated list of metafields associated with the resource.
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 )

Finds all metafields with a specific namespace under the resource.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
privateMetafields (PrivateMetafieldConnection!)

List of private metafields.
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 )

Filter the private metafields by namespace.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
products (ProductConnection!)

The products that are included 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.
query ( String )

This field is only used when the collection is smart. If the collection is custom it returns an error. Supported filter parameters:

  • title
  • product_type
  • vendor
  • gift_card
  • created_at
  • updated_at

See the detailed search syntax.
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
resourcePublications (ResourcePublicationConnection!)

The list of resources that are published to a publication.

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published. Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
unpublishedPublications (PublicationConnection!)

The list of publications that the resource is not published to.

Required access

read_publications access scope.
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

Fields

availablePublicationCount (Int!)

The number of publications a resource is published to without feedback errors.

Required access

read_publications access scope.
description (String!)

The stripped description of the collection, in a 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.
feedback (ResourceFeedback)

Information about the collection that's provided through resource feedback.
handle (String!)

A unique human-friendly string for the collection. Automatically generated from the collection's title.
hasProduct (Boolean!)

Whether the collection includes a product.
id ( ID! ) required

The ID of the product to check.
id (ID!)

Globally unique identifier.
image (Image)

The 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
metafield (Metafield)

The metafield associated with the resource.
key ( String! ) required

Identifier for the metafield (maximum of 30 characters).
namespace ( String! ) required

Container for a set of metafields (maximum of 20 characters).
privateMetafield (PrivateMetafield)

Returns a private metafield found by namespace and key.
key ( String! ) required

The key for the private metafield.
namespace ( String! ) required

The namespace for the private metafield.
productsCount (Int!)

The number of products included in the collection.
publicationCount (Int!)

The number of publications a resource is published on.

Required access

read_publications access scope.
onlyPublished ( Boolean )

Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.Default value: true
publishedOnCurrentPublication (Boolean!)

Check to see whether the resource is published to the calling app's publication.

Required access

read_product_listings access scope.
publishedOnPublication (Boolean!)

Check to see whether the resource is published to a given publication.

Required access

read_publications access scope.
publicationId ( ID! ) required

The ID of the publication to check.
ruleSet (CollectionRuleSet)

The rules used to assign products to the collection. This applies only to smart collections.
seo (SEO!)

SEO information for the collection.
sortOrder (CollectionSortOrder!)

The order in which the collection's products are sorted.
storefrontId (StorefrontID!)

The storefront ID of the collection.
templateSuffix (String)

The theme template used when viewing this collection in a store.
title (String!)

The title of the collection.
translations ([PublishedTranslation!]!)

The translations associated with the resource.
locale ( String! ) required

Filters translations locale.
updatedAt (DateTime!)

The date and time (ISO 8601 format) when the collection was last modified.

Types that return Collection

Mutations for Collection

collectionAddProducts

Adds products to a collection.
collectionCreate

Creates a collection.
collectionDelete

Deletes a collection.
collectionRemoveProducts

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.
collectionReorderProducts

Asynchronously reorders a set of products from a given collection.
collectionUpdate

Updates a collection.

Implements

Deprecated fields

publications (CollectionPublicationConnection!) deprecated

The channels where the collection is published.

Deprecation warning

Use resourcePublications instead

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether or not to return only the collection publications that are published.Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
publishedOnChannel (Boolean!) deprecated

Check to see whether the resource is published to a given channel.

Deprecation warning

Use publishedOnPublication instead

Required access

read_publications access scope.
channelId ( ID! ) required

The ID of the channel to check.
publishedOnCurrentChannel (Boolean!) deprecated

Check to see whether the resource is published to the calling app's channel.

Deprecation warning

Use publishedOnCurrentPublication instead

Required access

read_product_listings access scope.
unpublishedChannels (ChannelConnection!) deprecated

The list of channels that the resource is not published to.

Deprecation warning

Use unpublishedPublications instead

Required access

read_publications access scope.
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
Version 2020-04

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2020-04

Fields

cursor (String!)

A cursor for use in pagination.
node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge

Version 2020-01

Represents a collection of products.

Required access

read_products access scope.

Connections

metafields (MetafieldConnection!)

A paginated list of metafields associated with the resource.
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 )

Finds all metafields with a specific namespace under the resource.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
privateMetafields (PrivateMetafieldConnection!)

List of private metafields.
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 )

Filter the private metafields by namespace.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
products (ProductConnection!)

The products that are included 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.
query ( String )

This field is only used when the collection is smart. If the collection is custom it returns an error. Supported filter parameters:

  • title
  • product_type
  • vendor
  • gift_card
  • created_at
  • updated_at

See the detailed search syntax.
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
resourcePublications (ResourcePublicationConnection!)

The list of resources that are published to a publication.

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published. Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
unpublishedPublications (PublicationConnection!)

The list of publications that the resource is not published to.

Required access

read_publications access scope.
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

Fields

availablePublicationCount (Int!)

The number of publications a resource is published to without feedback errors.

Required access

read_publications access scope.
description (String!)

The stripped description of the collection, in a 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.
feedback (ResourceFeedback)

Information about the collection that's provided through resource feedback.
handle (String!)

A unique human-friendly string for the collection. Automatically generated from the collection's title.
hasProduct (Boolean!)

Whether the collection includes a product.
id ( ID! ) required

The ID of the product to check.
id (ID!)

Globally unique identifier.
image (Image)

The 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
metafield (Metafield)

The metafield associated with the resource.
key ( String! ) required

Identifier for the metafield (maximum of 30 characters).
namespace ( String! ) required

Container for a set of metafields (maximum of 20 characters).
privateMetafield (PrivateMetafield)

Returns a private metafield found by namespace and key.
key ( String! ) required

The key for the private metafield.
namespace ( String! ) required

The namespace for the private metafield.
productsCount (Int!)

The number of products included in the collection.
publicationCount (Int!)

The number of publications a resource is published on.

Required access

read_publications access scope.
onlyPublished ( Boolean )

Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.Default value: true
publishedOnCurrentPublication (Boolean!)

Check to see whether the resource is published to the calling app's publication.

Required access

read_product_listings access scope.
publishedOnPublication (Boolean!)

Check to see whether the resource is published to a given publication.

Required access

read_publications access scope.
publicationId ( ID! ) required

The ID of the publication to check.
ruleSet (CollectionRuleSet)

The rules used to assign products to the collection. This applies only to smart collections.
seo (SEO!)

SEO information for the collection.
sortOrder (CollectionSortOrder!)

The order in which the collection's products are sorted.
storefrontId (StorefrontID!)

The storefront ID of the collection.
templateSuffix (String)

The theme template used when viewing this collection in a store.
title (String!)

The title of the collection.
translations ([PublishedTranslation!]!)

The translations associated with the resource.
locale ( String! ) required

Filters translations locale.
updatedAt (DateTime!)

The date and time (ISO 8601 format) when the collection was last modified.

Types that return Collection

Mutations for Collection

collectionAddProducts

Adds products to a collection.
collectionCreate

Creates a collection.
collectionDelete

Deletes a collection.
collectionRemoveProducts

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.
collectionReorderProducts

Asynchronously reorders a set of products from a given collection.
collectionUpdate

Updates a collection.

Implements

Deprecated fields

publications (CollectionPublicationConnection!) deprecated

The channels where the collection is published.

Deprecation warning

Use resourcePublications instead

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether or not to return only the collection publications that are published.Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
publishedOnChannel (Boolean!) deprecated

Check to see whether the resource is published to a given channel.

Deprecation warning

Use publishedOnPublication instead

Required access

read_publications access scope.
channelId ( ID! ) required

The ID of the channel to check.
publishedOnCurrentChannel (Boolean!) deprecated

Check to see whether the resource is published to the calling app's channel.

Deprecation warning

Use publishedOnCurrentPublication instead

Required access

read_product_listings access scope.
unpublishedChannels (ChannelConnection!) deprecated

The list of channels that the resource is not published to.

Deprecation warning

Use unpublishedPublications instead

Required access

read_publications access scope.
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
Version 2020-01

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2020-01

Fields

cursor (String!)

A cursor for use in pagination.
node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge

Version 2019-10 (Unsupported)

Represents a collection of products.

Required access

read_products access scope.

Connections

metafields (MetafieldConnection!)

A paginated list of metafields associated with the resource.
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 )

Finds all metafields with a specific namespace under the resource.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
privateMetafields (PrivateMetafieldConnection!)

List of private metafields.
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 )

Filter the private metafields by namespace.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
products (ProductConnection!)

The products that are included 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.
query ( String )

This field is only used when the collection is smart. If the collection is custom it returns an error. Supported filter parameters:

  • title
  • product_type
  • vendor
  • gift_card
  • created_at
  • updated_at

See the detailed search syntax.
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
resourcePublications (ResourcePublicationConnection!)

The list of resources that are published to a publication.

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published. Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
unpublishedPublications (PublicationConnection!)

The list of publications that the resource is not published to.

Required access

read_publications access scope.
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

Fields

availablePublicationCount (Int!)

The number of publications a resource is published to without feedback errors.

Required access

read_publications access scope.
description (String!)

The stripped description of the collection, in a 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.
feedback (ResourceFeedback)

Information about the collection that's provided through resource feedback.
handle (String!)

A unique human-friendly string for the collection. Automatically generated from the collection's title.
hasProduct (Boolean!)

Whether the collection includes a product.
id ( ID! ) required

The ID of the product to check.
id (ID!)

Globally unique identifier.
image (Image)

The 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
metafield (Metafield)

The metafield associated with the resource.
key ( String! ) required

Identifier for the metafield (maximum of 30 characters).
namespace ( String! ) required

Container for a set of metafields (maximum of 20 characters).
privateMetafield (PrivateMetafield)

Returns a private metafield found by namespace and key.
key ( String! ) required

The key for the private metafield.
namespace ( String! ) required

The namespace for the private metafield.
productsCount (Int!)

The number of products included in the collection.
publicationCount (Int!)

The number of publications a resource is published on.

Required access

read_publications access scope.
onlyPublished ( Boolean )

Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.Default value: true
publishedOnCurrentPublication (Boolean!)

Check to see whether the resource is published to the calling app's publication.

Required access

read_product_listings access scope.
publishedOnPublication (Boolean!)

Check to see whether the resource is published to a given publication.

Required access

read_publications access scope.
publicationId ( ID! ) required

The ID of the publication to check.
ruleSet (CollectionRuleSet)

The rules used to assign products to the collection. This applies only to smart collections.
seo (SEO!)

SEO information for the collection.
sortOrder (CollectionSortOrder!)

The order in which the collection's products are sorted.
storefrontId (StorefrontID!)

The storefront ID of the collection.
templateSuffix (String)

The theme template used when viewing this collection in a store.
title (String!)

The title of the collection.
translations ([PublishedTranslation!]!)

The translations associated with the resource.
locale ( String! ) required

Filters translations locale.
updatedAt (DateTime!)

The date and time (ISO 8601 format) when the collection was last modified.

Types that return Collection

Mutations for Collection

collectionAddProducts

Adds products to a collection.
collectionCreate

Creates a collection.
collectionDelete

Deletes a collection.
collectionRemoveProducts

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.
collectionReorderProducts

Asynchronously reorders a set of products from a given collection.
collectionUpdate

Updates a collection.

Implements

Deprecated fields

publications (CollectionPublicationConnection!) deprecated

The channels where the collection is published.

Deprecation warning

Use resourcePublications instead

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether or not to return only the collection publications that are published.Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
publishedOnChannel (Boolean!) deprecated

Check to see whether the resource is published to a given channel.

Deprecation warning

Use publishedOnPublication instead

Required access

read_publications access scope.
channelId ( ID! ) required

The ID of the channel to check.
publishedOnCurrentChannel (Boolean!) deprecated

Check to see whether the resource is published to the calling app's channel.

Deprecation warning

Use publishedOnCurrentPublication instead

Required access

read_product_listings access scope.
unpublishedChannels (ChannelConnection!) deprecated

The list of channels that the resource is not published to.

Deprecation warning

Use unpublishedPublications instead

Required access

read_publications access scope.
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
Version 2019-10 (Unsupported)

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2019-10 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.
node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge

Version 2019-07 (Unsupported)

Represents a collection of products.

Required access

read_products access scope.

Connections

metafields (MetafieldConnection!)

A paginated list of metafields associated with the resource.
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 )

Finds all metafields with a specific namespace under the resource.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
privateMetafields (PrivateMetafieldConnection!)

List of private metafields.
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 )

Filter the private metafields by namespace.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
products (ProductConnection!)

The products that are included 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.
query ( String )

This field is only used when the collection is smart. If the collection is custom it returns an error. Supported filter parameters:

  • title
  • product_type
  • vendor
  • gift_card
  • created_at
  • updated_at

See the detailed search syntax.
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
resourcePublications (ResourcePublicationConnection!)

The list of resources that are published to a publication.

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published. Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
unpublishedPublications (PublicationConnection!)

The list of publications that the resource is not published to.

Required access

read_publications access scope.
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

Fields

availablePublicationCount (Int!)

The number of publications a resource is published to without feedback errors.

Required access

read_publications access scope.
description (String!)

The stripped description of the collection, in a 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.
feedback (ResourceFeedback)

Information about the collection that's provided through resource feedback.
handle (String!)

A unique human-friendly string for the collection. Automatically generated from the collection's title.
hasProduct (Boolean!)

Whether the collection includes a product.
id ( ID! ) required

The ID of the product to check.
id (ID!)

Globally unique identifier.
image (Image)

The 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
metafield (Metafield)

The metafield associated with the resource.
key ( String! ) required

Identifier for the metafield (maximum of 30 characters).
namespace ( String! ) required

Container for a set of metafields (maximum of 20 characters).
privateMetafield (PrivateMetafield)

Returns a private metafield found by namespace and key.
key ( String! ) required

The key for the private metafield.
namespace ( String! ) required

The namespace for the private metafield.
productsCount (Int!)

The number of products included in the collection.
publicationCount (Int!)

The number of publications a resource is published on.

Required access

read_publications access scope.
onlyPublished ( Boolean )

Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.Default value: true
publishedOnCurrentPublication (Boolean!)

Check to see whether the resource is published to the calling app's publication.

Required access

read_product_listings access scope.
publishedOnPublication (Boolean!)

Check to see whether the resource is published to a given publication.

Required access

read_publications access scope.
publicationId ( ID! ) required

The ID of the publication to check.
ruleSet (CollectionRuleSet)

The rules used to assign products to the collection. This applies only to smart collections.
seo (SEO!)

SEO information for the collection.
sortOrder (CollectionSortOrder!)

The order in which the collection's products are sorted.
storefrontId (StorefrontID!)

The storefront ID of the collection.
templateSuffix (String)

The theme template used when viewing this collection in a store.
title (String!)

The title of the collection.
translations ([PublishedTranslation!]!)

The translations associated with the resource.
locale ( String! ) required

Filters translations locale.
updatedAt (DateTime!)

The date and time (ISO 8601 format) when the collection was last modified.

Types that return Collection

Mutations for Collection

collectionAddProducts

Adds products to a collection.
collectionCreate

Creates a collection.
collectionDelete

Deletes a collection.
collectionRemoveProducts

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.
collectionReorderProducts

Asynchronously reorders a set of products from a given collection.
collectionUpdate

Updates a collection.

Implements

Deprecated fields

publications (CollectionPublicationConnection!) deprecated

The channels where the collection is published.

Deprecation warning

Use resourcePublications instead

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether or not to return only the collection publications that are published.Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
publishedOnChannel (Boolean!) deprecated

Check to see whether the resource is published to a given channel.

Deprecation warning

Use publishedOnPublication instead

Required access

read_publications access scope.
channelId ( ID! ) required

The ID of the channel to check.
publishedOnCurrentChannel (Boolean!) deprecated

Check to see whether the resource is published to the calling app's channel.

Deprecation warning

Use publishedOnCurrentPublication instead

Required access

read_product_listings access scope.
unpublishedChannels (ChannelConnection!) deprecated

The list of channels that the resource is not published to.

Deprecation warning

Use unpublishedPublications instead

Required access

read_publications access scope.
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
Version 2019-07 (Unsupported)

On this page

Fields

edges ([CollectionEdge!]!)

A list of edges.
pageInfo (PageInfo!)

Information to aid in pagination.
Version 2019-07 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.
node (Collection!)

The item at the end of CollectionEdge.

Types that return CollectionEdge

Version 2019-04 (Unsupported)

Represents a collection of products.

Required access

read_products access scope.

Connections

metafields (MetafieldConnection!)

A paginated list of metafields associated with the resource.
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 )

Finds all metafields with a specific namespace under the resource.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
privateMetafields (PrivateMetafieldConnection!)

List of private metafields.
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 )

Filter the private metafields by namespace.
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
products (ProductConnection!)

The products that are included 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.
query ( String )

This field is only used when the collection is smart. If the collection is custom it returns an error. Supported filter parameters:

  • title
  • product_type
  • vendor
  • gift_card
  • created_at
  • updated_at

See the detailed search syntax.
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
resourcePublications (ResourcePublicationConnection!)

The list of resources that are published to a publication.

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published. Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
unpublishedPublications (PublicationConnection!)

The list of publications that the resource is not published to.

Required access

read_publications access scope.
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

Fields

availablePublicationCount (Int!)

The number of publications a resource is published to without feedback errors.

Required access

read_publications access scope.
description (String!)

The stripped description of the collection, in a 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.
feedback (ResourceFeedback)

Information about the collection that's provided through resource feedback.
handle (String!)

A unique human-friendly string for the collection. Automatically generated from the collection's title.
hasProduct (Boolean!)

Whether the collection includes a product.
id ( ID! ) required

The ID of the product to check.
id (ID!)

Globally unique identifier.
image (Image)

The 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
metafield (Metafield)

The metafield associated with the resource.
key ( String! ) required

Identifier for the metafield (maximum of 30 characters).
namespace ( String! ) required

Container for a set of metafields (maximum of 20 characters).
privateMetafield (PrivateMetafield)

Returns a private metafield found by namespace and key.
key ( String! ) required

The key for the private metafield.
namespace ( String! ) required

The namespace for the private metafield.
productsCount (Int!)

The number of products included in the collection.
publicationCount (Int!)

The number of publications a resource is published on.

Required access

read_publications access scope.
onlyPublished ( Boolean )

Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.Default value: true
publishedOnCurrentPublication (Boolean!)

Check to see whether the resource is published to the calling app's publication.

Required access

read_product_listings access scope.
publishedOnPublication (Boolean!)

Check to see whether the resource is published to a given publication.

Required access

read_publications access scope.
publicationId ( ID! ) required

The ID of the publication to check.
ruleSet (CollectionRuleSet)

The rules used to assign products to the collection. This applies only to smart collections.
seo (SEO!)

SEO information for the collection.
sortOrder (CollectionSortOrder!)

The order in which the collection's products are sorted.
storefrontId (StorefrontID!)

The storefront ID of the collection.
templateSuffix (String)

The theme template used when viewing this collection in a store.
title (String!)

The title of the collection.
translations ([PublishedTranslation!]!)

The translations associated with the resource.
locale ( String! ) required

Filters translations locale.
updatedAt (DateTime!)

The date and time (ISO 8601 format) when the collection was last modified.

Types that return Collection

Mutations for Collection

collectionAddProducts

Adds products to a collection.
collectionCreate

Creates a collection.
collectionDelete

Deletes a collection.
collectionRemoveProducts

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.
collectionReorderProducts

Asynchronously reorders a set of products from a given collection.
collectionUpdate

Updates a collection.

Implements

Deprecated fields

publications (CollectionPublicationConnection!) deprecated

The channels where the collection is published.

Deprecation warning

Use resourcePublications instead

Required access

read_publications access scope.
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.
onlyPublished ( Boolean )

Whether or not to return only the collection publications that are published.Default value: true
reverse ( Boolean )

Reverse the order of the underlying list.Default value: false
publishedOnChannel (Boolean!) deprecated

Check to see whether the resource is published to a given channel.

Deprecation warning

Use publishedOnPublication instead

Required access

read_publications access scope.
channelId ( ID! ) required

The ID of the channel to check.
publishedOnCurrentChannel (Boolean!) deprecated

Check to see whether the resource is published to the calling app's channel.

Deprecation warning

Use publishedOnCurrentPublication instead

Required access

read_product_listings access scope.
unpublishedChannels (ChannelConnection!) deprecated

The list of channels that the resource is not published to.

Deprecation warning

Use unpublishedPublications instead

Required access

read_publications access scope.
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 la