ProductInput

input

Input fields required for creating a product.

Fields

collectionsToJoin ● [ID!]non-null

The IDs of collections that the product will join.

spu ● String

The product's SPU code, limited to 255 characters.

options ● [String!]non-null

The list of options for the product (maximum of 5 per product).

id ● ID

Indicates the product to be updated in productUpdate and ignores it if provided in productCreate.

status ● ProductStatus

The product's status.

vendor ● String

The vendor name of the product.

path ● String

The relative path of the product URL in the online store, max 512 characters.

tip

No action is taken if this field is empty.

handle ● String

A distinctive, user-friendly string for a product. It is automatically created from the product title unless stated otherwise.

giftCard ● Boolean

Indicates if the product is a gift card.

collectionsToLeave ● [ID!]non-null

The IDs of the collections from which the existing product will be removed.

title ● String

The product's title.

variants ● [ProductVariantInput!]non-null

The list of product variants.

productCategory ● ProductCategoryInput

The category assigned to the product by the merchant.

tags ● [String!]non-null

List of tags associated with the product.

publishDate ● Date

Online store release time. Only active products can be published.

descriptionHtml ● String

The product's description, including HTML formatting.

productType ● String

The custom product type defined by the merchant.

subtitle ● String

Product summary, limited to 255 characters.

Status and error codes

For detailed information about common codes, see Status and error codes.

Map

Argument from

Mutation.productCreate

Mutation.productUpdate

ProductInput

Was this article helpful to you?

SHOPLINE

Legal