Collection object
Represents a collection of products.
Required access
read_products
access scope.
On this page
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availablePublicationCount (
Int!
)The number of publications a resource is published to without feedback errors.
Required access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores. -
description (
String!
)The stripped description of the collection, in a single line with HTML tags removed.
Argument Description truncateAt
(Int
)Truncates string after the given length.
-
descriptionHtml (
HTML!
)The description of the collection, complete with HTML formatting.
-
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.
Argument Description id
(ID!
) requiredThe ID of the product to check.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The image associated with the collection.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.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.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description 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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description publicationId
(ID!
) requiredThe 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.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the collection was last modified.
Types that return Collection
-
Channel.collections
-
Collection.node
-
CollectionPublication.collection
-
DiscountCollections.collections
-
PriceRuleItemEntitlements.collections
-
PriceRuleLineItemPrerequisites.collections
-
Product.collections
-
Publication.collections
-
QueryRoot.collection
-
QueryRoot.collectionByHandle
-
QueryRoot.collections
Mutations for Collection
-
Adds products to a collection.
-
Creates a collection.
-
Deletes a collection.
-
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.
-
Asynchronously reorders a set of products from a given collection.
-
Updates a collection.
Implements
Deprecated fields
-
publications (
CollectionPublicationConnection!
) deprecatedThe channels where the collection is published.
Deprecation warning
Use
resourcePublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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!
) deprecatedCheck to see whether the resource is published to a given channel.
Deprecation warning
Use
publishedOnPublication
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description channelId
(ID!
) requiredThe ID of the channel to check.
-
publishedOnCurrentChannel (
Boolean!
) deprecatedCheck to see whether the resource is published to the calling app's channel.
Deprecation warning
Use
publishedOnCurrentPublication
insteadRequired access
read_product_listings
access scope. -
unpublishedChannels (
ChannelConnection!
) deprecatedThe list of channels that the resource is not published to.
Deprecation warning
Use
unpublishedPublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
An auto-generated type for paginating through multiple Collections.
Fields
-
edges (
[CollectionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
Types that return Collection
-
Channel.collections
-
Collection.node
-
CollectionPublication.collection
-
DiscountCollections.collections
-
PriceRuleItemEntitlements.collections
-
PriceRuleLineItemPrerequisites.collections
-
Product.collections
-
Publication.collections
-
QueryRoot.collection
-
QueryRoot.collectionByHandle
-
QueryRoot.collections
Mutations for Collection
-
Adds products to a collection.
-
Creates a collection.
-
Deletes a collection.
-
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.
-
Asynchronously reorders a set of products from a given collection.
-
Updates a collection.
An auto-generated type which holds one Collection and a cursor during pagination.
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
Collection!
)The item at the end of CollectionEdge.
Types that return Collection
-
Channel.collections
-
Collection.node
-
CollectionPublication.collection
-
DiscountCollections.collections
-
PriceRuleItemEntitlements.collections
-
PriceRuleLineItemPrerequisites.collections
-
Product.collections
-
Publication.collections
-
QueryRoot.collection
-
QueryRoot.collectionByHandle
-
QueryRoot.collections
Mutations for Collection
-
Adds products to a collection.
-
Creates a collection.
-
Deletes a collection.
-
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.
-
Asynchronously reorders a set of products from a given collection.
-
Updates a collection.
Represents a collection of products.
Required access
read_products
access scope.
On this page
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availablePublicationCount (
Int!
)The number of publications a resource is published to without feedback errors.
Required access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores. -
description (
String!
)The stripped description of the collection, in a single line with HTML tags removed.
Argument Description truncateAt
(Int
)Truncates string after the given length.
-
descriptionHtml (
HTML!
)The description of the collection, complete with HTML formatting.
-
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.
Argument Description id
(ID!
) requiredThe ID of the product to check.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The image associated with the collection.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.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.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description 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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description publicationId
(ID!
) requiredThe 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.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the collection was last modified.
Types that return Collection
-
Channel.collections
-
CollectionPublication.collection
-
DiscountCollections.collections
-
PriceRuleItemEntitlements.collections
-
PriceRuleLineItemPrerequisites.collections
-
Product.collections
-
Publication.collections
-
QueryRoot.collection
-
QueryRoot.collectionByHandle
-
QueryRoot.collections
Mutations for Collection
-
Adds products to a collection.
-
Creates a collection.
-
Deletes a collection.
-
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.
-
Asynchronously reorders a set of products from a given collection.
-
Updates a collection.
Implements
Deprecated fields
-
publications (
CollectionPublicationConnection!
) deprecatedThe channels where the collection is published.
Deprecation warning
Use
resourcePublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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!
) deprecatedCheck to see whether the resource is published to a given channel.
Deprecation warning
Use
publishedOnPublication
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description channelId
(ID!
) requiredThe ID of the channel to check.
-
publishedOnCurrentChannel (
Boolean!
) deprecatedCheck to see whether the resource is published to the calling app's channel.
Deprecation warning
Use
publishedOnCurrentPublication
insteadRequired access
read_product_listings
access scope. -
unpublishedChannels (
ChannelConnection!
) deprecatedThe list of channels that the resource is not published to.
Deprecation warning
Use
unpublishedPublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
An auto-generated type for paginating through multiple Collections.
On this page
Fields
-
edges (
[CollectionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one Collection and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
Collection!
)The item at the end of CollectionEdge.
Types that return CollectionEdge
Represents a collection of products.
Required access
read_products
access scope.
On this page
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availablePublicationCount (
Int!
)The number of publications a resource is published to without feedback errors.
Required access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores. -
description (
String!
)The stripped description of the collection, in a single line with HTML tags removed.
Argument Description truncateAt
(Int
)Truncates string after the given length.
-
descriptionHtml (
HTML!
)The description of the collection, complete with HTML formatting.
-
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.
Argument Description id
(ID!
) requiredThe ID of the product to check.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The image associated with the collection.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.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.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description 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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description publicationId
(ID!
) requiredThe 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.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the collection was last modified.
Types that return Collection
-
Channel.collections
-
CollectionPublication.collection
-
DiscountCollections.collections
-
PriceRuleItemEntitlements.collections
-
PriceRuleLineItemPrerequisites.collections
-
Product.collections
-
Publication.collections
-
QueryRoot.collection
-
QueryRoot.collectionByHandle
-
QueryRoot.collections
Mutations for Collection
-
Adds products to a collection.
-
Creates a collection.
-
Deletes a collection.
-
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.
-
Asynchronously reorders a set of products from a given collection.
-
Updates a collection.
Implements
Deprecated fields
-
publications (
CollectionPublicationConnection!
) deprecatedThe channels where the collection is published.
Deprecation warning
Use
resourcePublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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!
) deprecatedCheck to see whether the resource is published to a given channel.
Deprecation warning
Use
publishedOnPublication
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description channelId
(ID!
) requiredThe ID of the channel to check.
-
publishedOnCurrentChannel (
Boolean!
) deprecatedCheck to see whether the resource is published to the calling app's channel.
Deprecation warning
Use
publishedOnCurrentPublication
insteadRequired access
read_product_listings
access scope. -
unpublishedChannels (
ChannelConnection!
) deprecatedThe list of channels that the resource is not published to.
Deprecation warning
Use
unpublishedPublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
An auto-generated type for paginating through multiple Collections.
On this page
Fields
-
edges (
[CollectionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one Collection and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
Collection!
)The item at the end of CollectionEdge.
Types that return CollectionEdge
Represents a collection of products.
Required access
read_products
access scope.
On this page
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availablePublicationCount (
Int!
)The number of publications a resource is published to without feedback errors.
Required access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores. -
description (
String!
)The stripped description of the collection, in a single line with HTML tags removed.
Argument Description truncateAt
(Int
)Truncates string after the given length.
-
descriptionHtml (
HTML!
)The description of the collection, complete with HTML formatting.
-
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.
Argument Description id
(ID!
) requiredThe ID of the product to check.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The image associated with the collection.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
metafield (
Metafield
)The metafield associated with the resource.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description 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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description publicationId
(ID!
) requiredThe 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.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the collection was last modified.
Types that return Collection
-
Channel.collections
-
CollectionPublication.collection
-
DiscountCollections.collections
-
PriceRuleItemEntitlements.collections
-
PriceRuleLineItemPrerequisites.collections
-
Product.collections
-
Publication.collections
-
QueryRoot.collection
-
QueryRoot.collectionByHandle
-
QueryRoot.collections
Mutations for Collection
-
Adds products to a collection.
-
Creates a collection.
-
Deletes a collection.
-
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.
-
Asynchronously reorders a set of products from a given collection.
-
Updates a collection.
Implements
Deprecated fields
-
publications (
CollectionPublicationConnection!
) deprecatedThe channels where the collection is published.
Deprecation warning
Use
resourcePublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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!
) deprecatedCheck to see whether the resource is published to a given channel.
Deprecation warning
Use
publishedOnPublication
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description channelId
(ID!
) requiredThe ID of the channel to check.
-
publishedOnCurrentChannel (
Boolean!
) deprecatedCheck to see whether the resource is published to the calling app's channel.
Deprecation warning
Use
publishedOnCurrentPublication
insteadRequired access
read_product_listings
access scope. -
unpublishedChannels (
ChannelConnection!
) deprecatedThe list of channels that the resource is not published to.
Deprecation warning
Use
unpublishedPublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
An auto-generated type for paginating through multiple Collections.
On this page
Fields
-
edges (
[CollectionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one Collection and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
Collection!
)The item at the end of CollectionEdge.
Types that return CollectionEdge
Represents a collection of products.
Required access
read_products
access scope.
On this page
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availablePublicationCount (
Int!
)The number of publications a resource is published to without feedback errors.
Required access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores. -
description (
String!
)The stripped description of the collection, in a single line with HTML tags removed.
Argument Description truncateAt
(Int
)Truncates string after the given length.
-
descriptionHtml (
HTML!
)The description of the collection, complete with HTML formatting.
-
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.
Argument Description id
(ID!
) requiredThe ID of the product to check.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The image associated with the collection.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
metafield (
Metafield
)The metafield associated with the resource.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description 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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description publicationId
(ID!
) requiredThe 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.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the collection was last modified.
Types that return Collection
-
Channel.collections
-
CollectionPublication.collection
-
DiscountCollections.collections
-
PriceRuleItemEntitlements.collections
-
PriceRuleLineItemPrerequisites.collections
-
Product.collections
-
Publication.collections
-
QueryRoot.collection
-
QueryRoot.collectionByHandle
-
QueryRoot.collections
Mutations for Collection
-
Adds products to a collection.
-
Creates a collection.
-
Deletes a collection.
-
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.
-
Asynchronously reorders a set of products from a given collection.
-
Updates a collection.
Implements
Deprecated fields
-
publications (
CollectionPublicationConnection!
) deprecatedThe channels where the collection is published.
Deprecation warning
Use
resourcePublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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!
) deprecatedCheck to see whether the resource is published to a given channel.
Deprecation warning
Use
publishedOnPublication
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description channelId
(ID!
) requiredThe ID of the channel to check.
-
publishedOnCurrentChannel (
Boolean!
) deprecatedCheck to see whether the resource is published to the calling app's channel.
Deprecation warning
Use
publishedOnCurrentPublication
insteadRequired access
read_product_listings
access scope. -
unpublishedChannels (
ChannelConnection!
) deprecatedThe list of channels that the resource is not published to.
Deprecation warning
Use
unpublishedPublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
An auto-generated type for paginating through multiple Collections.
On this page
Fields
-
edges (
[CollectionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one Collection and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
Collection!
)The item at the end of CollectionEdge.
Types that return CollectionEdge
Represents a collection of products.
Required access
read_products
access scope.
On this page
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availablePublicationCount (
Int!
)The number of publications a resource is published to without feedback errors.
Required access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores. -
description (
String!
)The stripped description of the collection, in a single line with HTML tags removed.
Argument Description truncateAt
(Int
)Truncates string after the given length.
-
descriptionHtml (
HTML!
)The description of the collection, complete with HTML formatting.
-
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.
Argument Description id
(ID!
) requiredThe ID of the product to check.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The image associated with the collection.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
metafield (
Metafield
)The metafield associated with the resource.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description 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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description publicationId
(ID!
) requiredThe 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.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the collection was last modified.
Types that return Collection
-
Channel.collections
-
CollectionPublication.collection
-
DiscountCollections.collections
-
PriceRuleItemEntitlements.collections
-
PriceRuleLineItemPrerequisites.collections
-
Product.collections
-
Publication.collections
-
QueryRoot.collection
-
QueryRoot.collectionByHandle
-
QueryRoot.collections
Mutations for Collection
-
Adds products to a collection.
-
Creates a collection.
-
Deletes a collection.
-
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.
-
Asynchronously reorders a set of products from a given collection.
-
Updates a collection.
Implements
Deprecated fields
-
publications (
CollectionPublicationConnection!
) deprecatedThe channels where the collection is published.
Deprecation warning
Use
resourcePublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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!
) deprecatedCheck to see whether the resource is published to a given channel.
Deprecation warning
Use
publishedOnPublication
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description channelId
(ID!
) requiredThe ID of the channel to check.
-
publishedOnCurrentChannel (
Boolean!
) deprecatedCheck to see whether the resource is published to the calling app's channel.
Deprecation warning
Use
publishedOnCurrentPublication
insteadRequired access
read_product_listings
access scope. -
unpublishedChannels (
ChannelConnection!
) deprecatedThe list of channels that the resource is not published to.
Deprecation warning
Use
unpublishedPublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
An auto-generated type for paginating through multiple Collections.
On this page
Fields
-
edges (
[CollectionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one Collection and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
Collection!
)The item at the end of CollectionEdge.
Types that return CollectionEdge
Represents a collection of products.
Required access
read_products
access scope.
On this page
Connections
-
metafields (
MetafieldConnection!
)A paginated list of metafields associated with the resource.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.namespace
(String
)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.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
availablePublicationCount (
Int!
)The number of publications a resource is published to without feedback errors.
Required access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores. -
description (
String!
)The stripped description of the collection, in a single line with HTML tags removed.
Argument Description truncateAt
(Int
)Truncates string after the given length.
-
descriptionHtml (
HTML!
)The description of the collection, complete with HTML formatting.
-
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.
Argument Description id
(ID!
) requiredThe ID of the product to check.
-
id (
ID!
)Globally unique identifier.
-
image (
Image
)The image associated with the collection.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
metafield (
Metafield
)The metafield associated with the resource.
-
privateMetafield (
PrivateMetafield
)Returns a private metafield found by namespace and key.
-
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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description 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. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description publicationId
(ID!
) requiredThe 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.
Argument Description locale
(String!
) requiredFilters translations locale.
-
updatedAt (
DateTime!
)The date and time (ISO 8601 format) when the collection was last modified.
Types that return Collection
-
Channel.collections
-
CollectionPublication.collection
-
DiscountCollections.collections
-
PriceRuleItemEntitlements.collections
-
PriceRuleLineItemPrerequisites.collections
-
Product.collections
-
Publication.collections
-
QueryRoot.collection
-
QueryRoot.collectionByHandle
-
QueryRoot.collections
Mutations for Collection
-
Adds products to a collection.
-
Creates a collection.
-
Deletes a collection.
-
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.
-
Asynchronously reorders a set of products from a given collection.
-
Updates a collection.
Implements
Deprecated fields
-
publications (
CollectionPublicationConnection!
) deprecatedThe channels where the collection is published.
Deprecation warning
Use
resourcePublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.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!
) deprecatedCheck to see whether the resource is published to a given channel.
Deprecation warning
Use
publishedOnPublication
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.Argument Description channelId
(ID!
) requiredThe ID of the channel to check.
-
publishedOnCurrentChannel (
Boolean!
) deprecatedCheck to see whether the resource is published to the calling app's channel.
Deprecation warning
Use
publishedOnCurrentPublication
insteadRequired access
read_product_listings
access scope. -
unpublishedChannels (
ChannelConnection!
) deprecatedThe list of channels that the resource is not published to.
Deprecation warning
Use
unpublishedPublications
insteadRequired access
read_publications
access scope. This scope is currently available only to private apps installed on Shopify Plus stores.