ProductListResponse

data
Type: array object[] · Product[]
required
Complete enriched product model with current processing and moderation results
- externalRef
  Type: string
  required
- id
  Type: string Format: uuid
  required
- images
  Type: array object[] · ProductImage[]
  required
  
  Public product image metadata. Private storage references are not returned.
- 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
  
  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.
- processStatus
  Type: string enum
  required
  values
  pending
  processing
  completed
  partial
  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
  
  Current moderation aggregate and stage results for the active ruleset
- 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
meta
Type: object · PaginationMeta
required
- currentPage
  Type: integer
  min:
  1
  required
  
  Integer numbers.
- pageSize
  Type: integer
  min:
  1
  required
  
  Integer numbers.
- totalItems
  Type: integer
  min:
  0
  required
  
  Integer numbers.
- totalPages
  Type: integer
  min:
  0
  required
  
  Integer numbers.
success
enum
const:
true
required
values
- true