Product

Object

Fields returned for product.

Fields

attributeAssignments [AttributeAssignment!]!: A list of attributes associated with the product.
categories CategoryConnection!: A list of categories associated with the product.
collections CollectionConnection!: A list of collections associated with the product.
description String: The rich description of the product.
events ProductEventConnection!: Retrieves a paginated list of events for a specific product.
heroVariant ProductVariant: The featured (hero) variant for this product.
id ID!: The unique identifier for the product.
metadata [MetadataItem!]!: Custom metadata key/value pairs for the product.
metafields [Metafield!]!: A list of metafields associated with the product. If a metafield definition has no explicit assignment for this product, the definition’s default value is returned.
name String!: The name of the product.
publications ProductPublicationConnection!: A list of publications associated with the product.
publicationsCount Long!: The number of channel publications that are associated with the product.
slug String!: The slug of the product, which is a URL-friendly identifier.
status ProductStatus!: The status of the product.
Possible enum values
ACTIVE
The product is available through published catalog experiences.
DRAFT
The product is retained as a draft and is not published.
tags [String!]!: A list of tags applied to the product.
totalInventoryCount Int!: The number of inventory entries that are associated with the product.
translations [Translation!]!: A list of translations associated with the product.
variants ProductVariantConnection!: A list of variants associated with the product.
variantsCount Long!: The number of variants that are associated with the product and published in the current channel.
vendor String: The vendor of the product.

Queries

product: Retrieves a single product by its ID.
products: Retrieves a paged list of products with optional filtering, sorting, and full-text search.

Mutations

attributeAssignmentsAdd: Adds attribute assignments to a product.
attributeAssignmentsRemove: Removes attribute assignments from a product.
attributeAssignmentsReorder: Reorders attribute assignments for a product.
productCreate: Creates a new product with the specified details.
productDelete: Deletes a product by its ID.
productPublishDeprecated: Adds publications to a product.
Deprecated: Use publishablePublish or publishableBulkPublish instead.
productUnpublishDeprecated: Removes publications from a product.
Deprecated: Use publishablePublish or publishableBulkPublish instead.
productUpdate: Updates an existing product identified by its ID.
productVariantPublishDeprecated: Adds or updates publications for a single product variant.
Deprecated: Use publishablePublish or publishableBulkPublish instead.
productVariantUnpublishDeprecated: Removes publications from a single product variant.
Deprecated: Use publishablePublish or publishableBulkPublish instead.
productVariantsBulkCreate: Creates multiple variants for a product in bulk.
productVariantsBulkDelete: Deletes multiple variants from a product in bulk.
productVariantsBulkUpdate: Updates multiple variants of a product in bulk.
productVariantsMediaAdd: Adds media items to one or more product variants.
productVariantsMediaRemove: Removes media items from one or more product variants.
productVariantsMediaReorder: Reorders media items within one or more product variants.
productVariantsReorder: Reorders product variants for a given product by applying the specified sort order updates.