Product

Customer-facing product returned by the product SDK

  • externalRef
    Type: string
    required
  • 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
  • inStock
    Type: boolean
    required
  • isPublished
    Type: boolean
    required
  • name
    Type: object
    required
    • propertyName
      Type: anything
  • price
    Type: object · Currency
    required

    Numeric price values keyed by uppercase ISO 4217 currency code

    • propertyName
      Type: number
  • processing
    Type: object · ProductProcessing
    required
    • completedStages
      Type: integer
      required

      Integer numbers.

    • currentStage
      Type: string | null enum
      required
      values
      • ingest
      • images
      • enrichment
      • indexing
      • dedup
    • stages
      Type: array object[] · ProductProcessingStage[]
      required
    • totalStages
      Type: integer
      required

      Integer numbers.

  • processStatus
    Type: string enum
    required
    values
    • pending
    • processing
    • completed
    • failed
  • sku
    Type: string
    required
  • url
    Type: string Format: uri
    required
  • versionHash
    Type: string
    required
  • attributes
    Type: object | null
    • propertyName
      Type: anything
  • brand
    Type: object · ProductBrandnullable
    • id
      Type: string Format: uuid
    • name
      Type: string
  • brandId
    Type: string | null Format: uuid
  • caption
    Type: string | null
  • categories
    Type: array
      • 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

  • customProperties
    Type: object
    read-only
    • propertyName
      Type: anything
  • 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
  • identifiers
    Type: array object[] · ProductIdentifier[]
    • type
      Type: string
      required
    • value
      Type: string
      required
  • keywords
    Type: array string[]
  • moderation
    Type: object · ProductModerationSummarynullable

    Latest aggregate moderation result when available

    • imageUrl
      Type: string | null Format: uri
    • imageUrls
      Type: array string[]
    • passedSlugs
      Type: array string[]
    • reviewStatus
      Type: string enum
      values
      • none
      • pending
      • approved
      • rejected
    • rulesetId
      Type: string Format: uuid
    • rulesetVersion
      Type: string | null
    • status
      Type: string enum

      Current aggregate moderation lifecycle status

      values
      • pending
      • processing
      • approved
      • flagged
      • error
      • skipped
    • unpublishApplied
      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

    • violations
      Type: array object[]
  • offers
    Type: array object[] · ProductOffer[]
    • 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
  • priceDiscount
    Type: object · Currencynullable

    Numeric price values keyed by uppercase ISO 4217 currency code

    • propertyName
      Type: number
  • productLabel
    Type: string | null
  • 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

  • variantAxes
    Type: array string[]
  • variants
    Type: array object[] · ProductVariant[]
    • id
      Type: string Format: uuid
      required
    • images
      Type: array object[] · ProductImage[]
      required
    • offers
      Type: array object[] · ProductOffer[]
      required
    • attributes
      Type: object | null
    • attributesTranslated
      Type: object | null
    • colour
      Type: object · ProductColournullable
    • 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
    • dimensions
      Type: object · ProductDimensionsnullable
    • ean
      Type: string | null
    • gtin
      Type: string | null
    • name
      Type: object
    • originalAttributes
      Type: object
      read-only
    • originalDescription
      Type: object
    • originalName
      Type: object
    • 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.

    • weightKg
      Type: number | null
  • weight
    Type: number | null