Skip to main content

ProductInput

No description

input ProductInput {
  attributes: [AttributeValueInput!]
  variantAttributes: [ID!]
  productType: ID
  customFields: [AttributeValueInput!]
  publicationDate: Date
  category: ID
  chargeTaxes: Boolean
  collections: [ID!]
  currency: String
  description: String
  descriptionHtml: String
  isPublished: Boolean
  name: String
  slug: String
  taxCode: String
  seo: SeoInput
  weight: WeightScalar
  sku: String
  trackInventory: Boolean
  basePrice: PositiveDecimal
  costPrice: PositiveDecimal
  visibleInListings: Boolean
  overridePrice: Boolean
  overrideCurrency: Boolean
  subStatus: ProductSubStatusEnum
  subStatusReason: String
  isShippingRequired: Boolean
  isDigital: Boolean
  isPriceOverrideAllowed: Boolean
  dimensions: ProductDimensionsInput
  allowSellerVariants: Boolean
}
Show more ↓

Fields​

ProductInput.attributes ● [AttributeValueInput!] list input​

List of attributes.

ProductInput.variantAttributes ● [ID!] list scalar​

List of attributes to assign as variant attributes to this product.

ProductInput.productType ● ID scalar​

ID of the type that product belongs to.

ProductInput.customFields ● [AttributeValueInput!] list input​

List of custom fields.

ProductInput.publicationDate ● Date scalar​

Publication date. ISO 8601 standard.

ProductInput.category ● ID scalar​

ID of the product's category.

ProductInput.chargeTaxes ● Boolean scalar​

Determine if taxes are being charged for the product.

ProductInput.collections ● [ID!] list scalar​

List of IDs of collections that the product belongs to.

ProductInput.currency ● String scalar​

Choose a currency to assign to the product prices.

ProductInput.description ● String scalar​

Product description (plaintext, read-only).

ProductInput.descriptionHtml ● String scalar​

Product description (html).

ProductInput.isPublished ● Boolean scalar​

Determines if product is visible to customers.

ProductInput.name ● String scalar​

Product name.

ProductInput.slug ● String scalar​

Product slug.

ProductInput.taxCode ● String scalar​

Tax rate for enabled tax gateway.

ProductInput.seo ● SeoInput input​

Search engine optimization fields.

ProductInput.weight ● WeightScalar scalar​

Weight of the Product.

ProductInput.sku ● String scalar​

Stock keeping unit of a product. Note: this field is only used if a product doesn't use variants. DEPRECATED: All products are now configurable instead of simple. This field will be removed after 2024-07-01.

ProductInput.trackInventory ● Boolean scalar​

Determines whether to track changes to this variant's inventory. If set to 'false', the product's stock quantity won't reduce when a customer purchases this item. However, even when 'false', you must assign a stock quantity to a warehouse to allow checkouts. Usually, this involves allocating a placeholder stock amount that matches the maximum quantity purchased at once. Note: this field is applicable only for simple products.DEPRECATED: All products are now configurable instead of simple. This field will be removed after 2024-07-01.

ProductInput.basePrice ● PositiveDecimal scalar​

Default price for product variant. DEPRECATED: All products are now configurable instead of simple. This field will be removed after 2024-07-01.

ProductInput.costPrice ● PositiveDecimal scalar​

Default cost price for product variant. DEPRECATED: All products are now configurable instead of simple. This field will be removed after 2024-07-01.

ProductInput.visibleInListings ● Boolean scalar​

Determines if product is visible in product listings (doesn't apply to product collections).

ProductInput.overridePrice ● Boolean scalar​

Override price for grouped products

ProductInput.overrideCurrency ● Boolean scalar​

Override currency for product

ProductInput.subStatus ● ProductSubStatusEnum enum​

Substatus the product is to be changed to.

ProductInput.subStatusReason ● String scalar​

A reason for why the sub status changed, which will be displayed to the creator of the product.

ProductInput.isShippingRequired ● Boolean scalar​

Set whether this product requires shipping by default, will be overridden by product type if provided

ProductInput.isDigital ● Boolean scalar​

Set whether this product is digital by default, will be overridden by product type if provided

ProductInput.isPriceOverrideAllowed ● Boolean scalar​

Set whether this product allows price overrides by default, will be controlled by product type if provided

ProductInput.dimensions ● ProductDimensionsInput input​

Product dimensions.

ProductInput.allowSellerVariants ● Boolean scalar​

When enabled, other sellers can create their own variants on this product (cross-sell). Requires marketplace-level enable_master_products to be True. Only the product owner can modify this setting.

Member Of​

productUpdate mutation

Was this page helpful?