input_object
The input fields for creating or updating a product.
The ID of the category that's associated with the product.
The input field to enable an app to provide additional product features. For example, you can specify
bundles: true
in thefield to let an app add a product configuration extension.
A list of collection IDs to associate with the product.
The collection IDs to disassociate from the product.
The role of the product in a combined listing. You can specify this field only when you create a product.
The description of the product, with HTML tags. For example, the description might include bold
<strong></strong>
and italic<i></i>
text.Whether the product is a gift card.
The theme template that's used when customers view a gift card in a store.
A unique, human-readable string of the product's title. A handle can contain letters, hyphens (
-
), and numbers, but no spaces. The handle is used in the online store URL for the product. For example, if a product is titled "Black Sunglasses", then the handle isblack-sunglasses
.The custom fields to associate with the product for the purposes of adding and storing additional information.
The product type that merchants define.
Whether a redirect is required after a new handle has been provided. If
true
, then the old handle is redirected to the new one automatically.Whether the product can only be purchased with a selling plan. Products that are sold on subscription (
) can be updated only for online stores. If you update a product to be subscription-only (
), then the product is unpublished from all channels except the online store.
The SEO title and description that are associated with a product.
The product status, which controls visibility across all sales channels.
A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the
sports
andsummer
tags to products that are associated with sportwear for summer.Updating
tags
overwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use themutation.
The theme template that's used when customers view a product in a store.
The name for the product that displays to customers. The title is used to construct the product's handle. For example, if a product is titled "Black Sunglasses", then the handle is
black-sunglasses
.The name of the product's vendor.