Home > @infiniteobjects/shopify-data-manager > AdminTypes > ProductInput
The input fields required to create a product.
Signature:
export interface ProductInput
Property | Modifiers | Type | Description |
---|---|---|---|
claimOwnership? | InputMaybe<ProductClaimOwnershipInput> | (Optional) Claim ownership of a product. | |
collectionsToJoin? | InputMaybe<Array<Scalars[‘ID’][‘input’]>> | (Optional) The IDs of the collections that this product will be added to. | |
collectionsToLeave? | InputMaybe<Array<Scalars[‘ID’][‘input’]>> | (Optional) The IDs of collections that will no longer include the existing product. | |
customProductType? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The custom product type specified by the merchant. | |
descriptionHtml? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The description of the product, complete with HTML formatting. | |
giftCard? | InputMaybe<Scalars[‘Boolean’][‘input’]> | (Optional) Whether the product is a gift card. | |
giftCardTemplateSuffix? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The theme template used when viewing the gift card in a store. | |
handle? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) A unique, human-friendly string for the product. Automatically generated from the product’s title unless otherwise specified. | |
id? | InputMaybe<Scalars[‘ID’][‘input’]> | (Optional) Specifies the product to update in productUpdate or creates a new product if absent in productCreate. | |
metafields? | InputMaybe<Array<MetafieldInput>> | (Optional) The metafields to associate with this product. | |
options? | InputMaybe<Array<Scalars[‘String’][‘input’]>> | (Optional) List of custom product options (maximum of 3 per product). | |
productCategory? | InputMaybe<ProductCategoryInput> | (Optional) The product category in the Shopify product taxonomy. | |
productType? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The product type specified by the merchant. | |
redirectNewHandle? | InputMaybe<Scalars[‘Boolean’][‘input’]> | (Optional) 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. | |
requiresSellingPlan? | InputMaybe<Scalars[‘Boolean’][‘input’]> | (Optional) Whether the product can only be purchased with a selling plan (subscription). Products that are sold exclusively on subscription can only be created on online stores. If set to true on an already existing product, then the product will be marked unavailable on channels that don’t support subscriptions. |
|
seo? | InputMaybe<SeoInput> | (Optional) The SEO information associated with the product. | |
standardizedProductType? | InputMaybe<StandardizedProductTypeInput> | (Optional) The standardized product type in the Shopify product taxonomy. | |
status? | InputMaybe<ProductStatus | `${ProductStatus}`> | (Optional) The status of the product. | |
tags? | InputMaybe<Array<Scalars[‘String’][‘input’]>> | (Optional) A comma separated list of tags that have been added to the product. | |
templateSuffix? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The theme template used when viewing the product in a store. | |
title? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The title of the product. | |
variants? | InputMaybe<Array<ProductVariantInput>> | (Optional) A list of variants associated with the product. | |
vendor? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The name of the product’s vendor. |