The product-related input fields.
Fields
id ● ID
The unique identifier for the product. Used to specify the product to be updated in the productUpdate API. If this parameter is passed in the productCreate API, the system will ignore it.
Maximum length: 64
collectionsToJoin ● [ID!]non-null
The IDs of collections to which the product will be added.
collectionsToLeave ● [ID!]non-null
The IDs of the collections from which the product will be removed.
descriptionHtml ● String
The product description.
Maximum size: 512 KB
giftCard ● Boolean
Indicates whether the product is a gift card product.
  • true: The product is a gift card product.
  • false: The product is not a gift card product.
handle ● String
The semantically unique identifier for the product, which is generated based on title by default.
Maximum length: 255
options ● [String!]non-null
A list of product options.
Maximum size: 5
productCategory ● ProductCategoryInput
The standard category assigned to the product by the merchant.
More
productType ● String
The product type customized by the merchant.
Maximum length: 255
status ● ProductStatus
The status of the product.
More
tags ● [String!]non-null
A list of tags of the product.
Maximum size: 250
Maximum length per string: 255
title ● String
The title of the product.
Maximum length: 255
variants ● [ProductVariantInput!]non-null
A list of product variants.
Maximum size: 500
More
vendor ● String
The brand or vendor of the product.
Maximum length: 255
publishDate ● Datedeprecated
The date and time when the product was published to the online store. Format: ISO 8601.
DEPRECATED: This parameter is deprecated from API version v20241201.
path ● String
The relative path of the product page.
Maximum length: 512
spu ● String
The identifier customized for the product by the merchant.
Maximum length: 255
subtitle ● String
The subtitle of the product.
Maximum length: 400
templateSuffix ● String
The theme template of the product.
Was this article helpful to you?