Product

A product entity with complete metadata

  • categories
    Type: array object[]

    Product categories

    Empty object
  • createdAt
    Type: stringFormat: date-time

    When the product was created

  • description
    Type: object · LocalizedString

    String values in multiple languages

    • propertyName
      Type: string
  • dimensions
    Type: object · Dimensions

    Physical dimensions of a product in centimetres

    • heightCm
      Type: number
      required

      Height in centimetres

    • lengthCm
      Type: number
      required

      Length in centimetres

    • widthCm
      Type: number
      required

      Width in centimetres

  • externalRef
    Type: string

    External reference in format COMPANY:PLATFORM:VERSION:RESOURCE:ID

  • id
    Type: string

    Product unique identifier

  • images
    Type: array object[] · ProductImage[]

    Product image metadata

    • isMain
      Type: boolean

      Whether this is the main product image

    • isMatch
      Type: boolean

      Whether this is the matching image for lens search

    • url
      Type: stringFormat: uri

      URL to the image

  • inStock
    Type: boolean

    Whether the product is in stock

  • meta
    Type: object

    Custom properties for filtering (max 10 items)

    • propertyName
      Type: anything
  • name
    Type: object · LocalizedString

    String values in multiple languages

    • propertyName
      Type: string
  • price
    Type: object · Currency

    Price values in multiple currencies

    • propertyName
      Type: number
  • priceDiscount
    Type: object · Currency

    Price values in multiple currencies

    • propertyName
      Type: number
  • retailerId
    Type: string

    Identifier of the retailer

  • updatedAt
    Type: stringFormat: date-time

    When the product was last updated

  • url
    Type: string | null

    URL to the product page