OBJECT

Product

Represents an individual item for sale in the storefront.

link GraphQL Schema definition

  • type Product implements Node {
  • # The ID of the object.
  • id: ID!
  • publicationDate: Date
  • isPublished: Boolean!
  • seoTitle: String
  • seoDescription: String
  • productType: ProductType!
  • name: String!
  • description: String!
  • descriptionJson: JSONString!
  • category: Category!
  • updatedAt: DateTime
  • chargeTaxes: Boolean!
  • weight: Weight
  • # The storefront URL for the product.
  • url: String!
  • # The URL of a main thumbnail for a product.
  • #
  • # Arguments
  • # size:
  • thumbnailUrl(
  • size: Int
  • ): String @deprecated( reason: "thumbnailUrl is deprecated, use\n thumbnail instead" )
  • # The main thumbnail for a product.
  • #
  • # Arguments
  • # size:
  • thumbnail(size: Int): Image
  • # Informs about product's availability in the
  • # storefront, current price and discounts.
  • availability: ProductPricingInfo @deprecated( reason: "Has been renamed to 'pricing'." )
  • # Lists the storefront product's pricing, the current
  • # price and discounts, only meant for displaying.
  • pricing: ProductPricingInfo
  • # Whether the product is in stock and visible or not.
  • isAvailable: Boolean
  • # The product's default base price.
  • basePrice: Money
  • # The product's default base price.
  • price: Money @deprecated( reason: "Has been replaced by 'basePrice'" )
  • # A type of tax rate.
  • taxRate: TaxRateType @deprecated( reason: "taxRate is deprecated. Use taxType to obtain taxCode for given tax gateway" )
  • # A type of tax. Assigned by enabled tax gateway
  • taxType: TaxType
  • # List of attributes assigned to this product.
  • attributes: [SelectedAttribute!]!
  • purchaseCost: MoneyRange
  • margin: Margin
  • # Get a single product image by ID
  • #
  • # Arguments
  • # id:
  • imageById(id: ID): ProductImage
  • # List of variants for the product
  • variants: [ProductVariant]
  • # List of images for the product
  • images: [ProductImage]
  • # List of collections for the product
  • collections: [Collection]
  • availableOn: Date @deprecated( reason: "availableOn is deprecated, use publicationDate instead" )
  • # Returns translated Product fields for the given language code.
  • #
  • # Arguments
  • # languageCode:
  • translation(languageCode: LanguageCodeEnum!): ProductTranslation
  • }