Skip to main content

Collection

Requires read_products access scope.

Subscribe to field-level changes on the Collection GraphQL Admin API object. You can subscribe to create, delete, and update events, as well as changes to specific fields.

Each topic corresponds to a commerce resource (for example, a collection) that can exist independently within its domain. Child entities that depend on a parent within the same domain don't have their own topic. Instead, changes to child entities trigger a delivery on the parent topic. Calculated fields, derived fields, auto-updated timestamps, and cross-domain fields aren't available as triggers.

Anchor to Supported triggersSupported triggers

Field-level triggers for Collection subscriptions.

All triggers require the read_products access scope, and those triggers that require additional scopes are documented where relevant. Deprecated triggers are listed last.

Subscriptions can include multiple triggers. Use the shopify-webhook-id header for deduplication when handling duplicate deliveries.

Custom queries aren't limited to Collection. They can query the full GraphQL Admin API.

Anchor to list-of-topics-collection
collection

Fires when events involve the Collection object, which represents a group of products that merchants can organize to make their stores easier to browse and help customers find related products.

The "create" and "delete" actions are only relevant within the context of this parent topic. Use fields_changed to follow or replicate impacted data after a delete event. Define a custom query to retrieve specific fields from create events.

Collect details about changes to the object by subscribing to the trigger along with the "update" action, though it's recommended that you narrow your subscription to one of the other triggers below.

Variables: collectionId

Anchor to list-of-topics-collection.descriptionHtml
collection.descriptionHtml

Fires when the descriptionHtml field on the Collection object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The descriptionHtml field represents the description of the collection, including any HTML tags and formatting.

Variables: collectionId

Anchor to list-of-topics-collection.handle
collection.handle

Fires when the handle field on the Collection object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The handle field represents a unique string that identifies the collection.

Variables: collectionId

Anchor to list-of-topics-collection.image
collection.image

Fires when the image field on the Collection object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The image field represents the image associated with the collection.

Variables: collectionId

Anchor to list-of-topics-collection.metafield
collection.metafield

Fires when the metafield field on the Collection object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The metafield field represents a custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Variables: collectionId, metafieldKey, metafieldNamespace

Anchor to list-of-topics-collection.metafield.value
collection.metafield.value

Fires when the value field on the Metafield object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The value field represents the data stored in the metafield.

Variables: collectionId, metafieldKey, metafieldNamespace

Anchor to list-of-topics-collection.products
collection.products

Fires when the products field on the Collection object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The products field represents the products that are included in the collection.

Variables: collectionId, productsId

Anchor to list-of-topics-collection.sortOrder
collection.sortOrder

Fires when the sortOrder field on the Collection object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The sortOrder field represents the order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store.

Variables: collectionId

Anchor to list-of-topics-collection.templateSuffix
collection.templateSuffix

Fires when the templateSuffix field on the Collection object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The templateSuffix field represents the suffix of the Liquid template being used to show the collection in an online store.

Variables: collectionId

Anchor to list-of-topics-collection.title
collection.title

Fires when the title field on the Collection object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The title field represents the name of the collection.

Variables: collectionId

Was this page helpful?