ProductResponse

  • data
    Type: object · Product
    required

    Customer-facing product returned by the product SDK

    • externalRef
      Type: string
      required
    • id
      Type: string Format: uuid
      required
    • images
      Type: array object[] · ProductImage[]
      required
    • inStock
      Type: boolean
      required
    • isPublished
      Type: boolean
      required
    • name
      Type: object
      required
    • price
      Type: object · Currency
      required

      Numeric price values keyed by uppercase ISO 4217 currency code

    • processing
      Type: object · ProductProcessing
      required
    • 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
    • brand
      Type: object · ProductBrandnullable
    • brandId
      Type: string | null Format: uuid
    • caption
      Type: string | null
    • categories
      Type: array
    • 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

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

      Latest aggregate moderation result when available

    • offers
      Type: array object[] · ProductOffer[]
    • priceDiscount
      Type: object · Currencynullable

      Numeric price values keyed by uppercase ISO 4217 currency code

    • 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[]
    • weight
      Type: number | null
  • success
    enum
    const:  
    true
    required
    values
    • true