ProductIngestInput

Product payload accepted by the catalogue ingest endpoint. Field names use camelCase. externalRef is not accepted from the client — the server generates it from sku, clientId, and catalogueId.

  • brand
    Type: string | null
    min length:  
    1
    required

    Brand name. Required key — pass null when unknown.

  • description
    Type: object · LocalizedString
    required

    String values in multiple languages

    • propertyName
      Type: string
  • dimensions
    Type: object · Dimensionsnullable
    required

    Physical dimensions in centimetres. The key is required on every product — pass null when dimensions are unknown.

    Physical dimensions of a product in centimetres

    • heightCm
      Type: number
      required

      Height in centimetres

    • lengthCm
      Type: number
      required

      Length in centimetres

    • widthCm
      Type: number
      required

      Width in centimetres

  • images
    Type: array string[] 1…
    required

    Public HTTP or HTTPS product image URLs without embedded credentials (required for visual AI features). Redirects must remain on public network addresses. Each downloaded JPEG, PNG, or WebP image is limited to 25 MiB.

  • inStock
    Type: boolean
    required

    Whether the product is currently in stock

  • isPublished
    Type: boolean
    required

    Whether the product is published and visible

  • name
    Type: object · LocalizedString
    required

    String values in multiple languages

    • propertyName
      Type: string
  • price
    Type: object · Currency
    required

    Numeric price values keyed by uppercase ISO 4217 currency code

    • propertyName
      Type: number
  • sku
    Type: string
    min length:  
    1
    required

    Stock keeping unit — unique within the catalogue

  • url
    Type: string Pattern: ^[Hh][Tt][Tt][Pp][Ss]?://(?![^/?#]*@)[^\s]+$Format: uri
    required

    Public HTTP or HTTPS URL to the product page; embedded credentials are not allowed

  • weightKg
    Type: number | null
    required

    Weight in kilograms. Required key — pass null when unknown.

  • categories
    Type: array string[]

    Category names

  • colour
    Type: object · Colournullable

    Optional colour information

    Colour information for a product

    • primary
      Type: string
      min length:  
      1
      required

      Primary colour name

    • secondary
      Type: string
      min length:  
      1

      Optional secondary colour name

  • customProperties
    Type: object

    Up to 10 custom key/value pairs for filtering (string, number, or boolean values)

    • propertyName
      • Type: string
  • ean
    Type: string | null

    European Article Number

  • priceDiscount
    Type: object · Currencynullable

    Discounted price in multiple currencies

    Numeric price values keyed by uppercase ISO 4217 currency code

    • propertyName
      Type: number
  • upc
    Type: string | null

    Universal Product Code