Skip to main content

Product

type Product {
id: ID!
attributes: [ProductAttributeValue!]
baseUnit: ProductBaseUnitModel
brand: SimpleProductBrand
brandId: String
categories: [SimpleCategory!]
categoryIds: [String!]
description: String
dynamicPriceListIds: [String!]
googleTaxonomyId: String
groupVariantsByVariantTypeId: String
hiddenSalesChannelIds: [String!]
maxQuantityPerCart: Float
metaData: HTMLMetaData
name: String!
productOptionSetId: String
productVariantTypes: [ProductVariantType!]
productVolumeDiscountId: String
salesChannelIds: [String!]
shortDescription: String
tagIds: [String!]
tags: [SimpleProductTag!]
totalStock: Float
translations: [ProductTranslation!]
type: ProductTypeEnum!
variants: [Variant!]!
vendorId: String
weight: Float
}

Fields

idID!required

List of product attributes.

Base unit of the product.

Brand of the product.

brandIdString

Brand id of the product.

List of categories of the product.

categoryIds[String!]

List category identifiers of the product.

descriptionString

Description of the product.

dynamicPriceListIds[String!]
googleTaxonomyIdString
groupVariantsByVariantTypeIdString

This is the variant type id that can be used to group variants by a specific variant type id.

hiddenSalesChannelIds[String!]

List of hidden sales channel ids of the product.

maxQuantityPerCartFloat

Max purchasable quantity of the product for per cart.

metaDataHTMLMetaData

HTML Metadata identifier of the product.

nameString!required

Unique identifier of the product.

productOptionSetIdString

Option set id of the product.

productVariantTypes[ProductVariantType!]

Variant types of the product.

productVolumeDiscountIdString

Volume discount id of the product.

salesChannelIds[String!]

List of sales channel ids of the product.

shortDescriptionString

Short description of the product.

tagIds[String!]

List of product tag identifiers.

List of product tags.

totalStockFloat

Translations for the product.

typeProductTypeEnum!required

Type of the product.

variants[Variant!]!required

List of product variants.

vendorIdString

Vendor id of the product.

weightFloat

Weight of the product.