---
title: "ProductInput"
description: "The product-related input fields."
doc_type: graphql
doc_category: adminGraphQL
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/admin-graph-ql-api/products-and-collections/inputs/product-input'
  md: 'https://developer.shopline.com/docs/admin-graph-ql-api/products-and-collections/inputs/product-input.md'
---
# ProductInput

The product-related input fields.

- **API Version:** v20270301
- **API Type:** Admin
- **API Protocol:** GraphQL
- **Operation Type:** Input

## Input Fields

* `id`

  [ID](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/id.md)

  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.<br/>
  Maximum length: 64 

* `collectionsToJoin`

  [[ID!]](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/id.md)

  The IDs of collections to which the product will be added.

* `collectionsToLeave`

  [[ID!]](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/id.md)

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

* `descriptionHtml`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  The product description. <br/>
  Maximum size: 512 KB

* `giftCard`

  [Boolean](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/boolean.md)

  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](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  The semantically unique identifier for the product,
  which is generated based on `title` by default.<br/>
  Maximum length: 255

* `options`

  [[String!]](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  A list of product options.<br/>
  Maximum size: 5

* `productCategory`

  [ProductCategoryInput](https://developer.shopline.com/docs/admin-graph-ql-api/products-and-collections/inputs/product-category-input.md)

  The standard category assigned to the product by the merchant.

* `productType`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  The product type customized by the merchant.<br/>
  Maximum length: 255

* `status`

  [ProductStatus](https://developer.shopline.com/docs/admin-graph-ql-api/products-and-collections/enums/product-status.md)

  The status of the product.

* `tags`

  [[String!]](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  A list of tags of the product.<br/>
  Maximum size: 250<br/>
  Maximum length per string: 255

* `title`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  The title of the product.<br/>
  Maximum length: 255

* `variants`

  [[ProductVariantInput!]](https://developer.shopline.com/docs/admin-graph-ql-api/products-and-collections/inputs/product-variant-input.md)

  A list of product variants.<br/>
  Maximum size: 500

* `vendor`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  The brand or vendor of the product.<br/>
  Maximum length: 255

* `publishDate`

  [Date](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/date.md)

  The date and time when the product was published to the online store. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).
  
  :::danger
  **DEPRECATED**: This parameter is deprecated from API version v20241201.
  :::

* `path`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  The relative path of the product page.<br/>
  Maximum length: 512

* `spu`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  The identifier customized for the product by the merchant.<br/>
  Maximum length: 255

* `subtitle`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  The subtitle of the product.<br/>
  Maximum length: 400

* `templateSuffix`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  The theme template of the product.

## Argument from

* [Mutation](https://developer.shopline.com/docs/admin-graph-ql-api/products-and-collections/mutations/product-create.md).productCreate

* [Mutation](https://developer.shopline.com/docs/admin-graph-ql-api/products-and-collections/mutations/product-update.md).productUpdate