Product

Complete enriched product model with current processing and moderation results

  • externalRef
    Type: string
    required
  • id
    Type: stringFormat: uuid
    required
  • images
    Type:
    required
    Properties: 7
  • inStock
    Type: boolean
    required
  • isPublished
    Type: boolean
    required
  • name
    Type: object
    required
    Properties: 1
  • price
    Type:
    required

    Numeric price values keyed by uppercase ISO 4217 currency code

    Properties: 1
  • processing
    Type:
    required

    Progress for the catalogue's immutable feature-selected pipeline plan. Only stages in the compiled selected graph are returned; a returned stage can be skipped when runtime processing determines no work is needed. Moderation runs independently. Internal messages and traces are omitted.

    Properties: 5
  • processStatus
    Type: stringenum
    required
    values
    pendingprocessingcompletedpartialfailed
  • sku
    Type: string
    required
  • url
    Type: stringFormat: uri
    required
  • versionHash
    Type: string
    required
  • attribute_slugs
    Type:

    Resolved slug metadata by assigned category ID, then attribute key. The general bucket is used for uncategorized products.

    Properties: 1
  • attributes
    Type: object | null
    Properties: 1
  • brand
    Type: nullable
    Properties: 2
  • brandId
    Type: string | nullFormat: uuid
  • caption
    Type: string | null
  • categories
    Type: array
  • categoryDetails
    Type:
    Properties: 5
  • colour
    Type: nullable
    Properties: 2
  • createdAt
    Type: stringFormat: 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
    Properties: 1
  • deletedAt
    Type: string | nullFormat: date-time

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

  • description
    Type: object
    Properties: 1
  • dimensions
    Type: nullable
    Properties: 8
  • ean
    Type: string | null
  • gtin
    Type: string | null
  • identifiers
    Type:
    Properties: 2
  • keywords
    Type: array of string
  • moderation
    Type: nullable

    Current moderation aggregate and stage results for the active ruleset

    Properties: 11
  • offers
    Type:
    Properties: 23
  • priceDiscount
    Type: nullable

    Numeric price values keyed by uppercase ISO 4217 currency code

    Properties: 1
  • productLabel
    Type: string | null
  • upc
    Type: string | null
  • updatedAt
    Type: stringFormat: date-time

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

  • variantAxes
    Type: array of string
  • variants
    Type:
    Properties: 19
  • weight
    Type: number | null
Previous
ProductCategoryDetail
Next
ProductOfferEnhancementAcceptanceUpdateRequest