ProductVariant

  • id
    Type: string Format: uuid
    required
  • images
    Type: array object[] · ProductImage[]
    required
    • id
      Type: string Format: uuid
      required
    • url
      Type: string Format: uri
      required
    • altText
      Type: string | null
    • isMatch
      Type: boolean
    • isPrimary
      Type: boolean
    • processStatus
      Type: string
    • storageUrl
      Type: string | null Format: uri
    • variantId
      Type: string Format: uuid
  • offers
    Type: array object[] · ProductOffer[]
    required
    • externalRef
      Type: string | null
      required
    • id
      Type: string Format: uuid
      required
    • inStock
      Type: boolean
      required
    • isPublished
      Type: boolean
      required
    • price
      Type: object · Currency
      required

      Numeric price values keyed by uppercase ISO 4217 currency code

    • sku
      Type: string
      required
    • url
      Type: string Format: uri
      required
    • versionHash
      Type: string
      required
    • condition
      Type: string enum
      values
      • new
      • like_new
      • open_box
      • refurbished
      • used
    • conditionNotes
      Type: object | null
    • createdAt
      Type: string Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • deletedAt
      Type: string | null Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • matchSource
      Type: string
    • priceDiscount
      Type: object · Currencynullable

      Numeric price values keyed by uppercase ISO 4217 currency code

    • unpublishedByModeration
      Type: boolean
    • updatedAt
      Type: string Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • variantId
      Type: string Format: uuid
    • vendor
      Type: string
    • vendorId
      Type: string
  • attributes
    Type: object | null
    • propertyName
      Type: anything
  • attributesTranslated
    Type: object | null
    • propertyName
      Type: object
      • propertyName
        Type: string
  • colour
    Type: object · ProductColournullable
    • primary
      Type: string
    • secondary
      Type: string | null
  • createdAt
    Type: string Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • deletedAt
    Type: string | null Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • description
    Type: object
    • propertyName
      Type: anything
  • dimensions
    Type: object · ProductDimensionsnullable
    • depth
      Type: number
    • depthCm
      Type: number
    • height
      Type: number
    • heightCm
      Type: number
    • length
      Type: number
    • unit
      Type: string
    • width
      Type: number
    • widthCm
      Type: number
  • ean
    Type: string | null
  • gtin
    Type: string | null
  • name
    Type: object
    • propertyName
      Type: anything
  • originalAttributes
    Type: object
    read-only
    • propertyName
      Type: anything
  • originalDescription
    Type: object
    • propertyName
      Type: anything
  • originalName
    Type: object
    • propertyName
      Type: anything
  • productId
    Type: string Format: uuid
  • upc
    Type: string | null
  • updatedAt
    Type: string Format: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • variantValues
    Type: object

    Dynamic configuration-axis values for this variant. Newly inferred keys and string values are lowercased, with keys normally using lower_snake_case (for example color, capacity, or pack_quantity). Existing stored keys and values are preserved, so clients must not assume a closed vocabulary.

    • propertyName
      Type: anything
  • weightKg
    Type: number | null