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
    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 · Dimensions nullable
    required

    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[]
    required

    Product image URLs (required for visual AI features)

  • 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

    Price values in multiple currencies

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

    Stock keeping unit — unique within the catalogue

  • url
    Type: stringFormat: uri
    required

    URL to the product page on your storefront

  • weightKg
    Type: number | null
    required

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

  • categories
    Type: array string[]

    Category names

  • colour
    Type: object · Colour nullable

    Colour information for a product

    • primary
      Type: string
      required

      Primary colour name

    • secondary
      Type: string

      Optional secondary colour name

  • customProperties
    Type: object

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

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

    European Article Number

  • priceDiscount
    Type: object · Currency nullable

    Price values in multiple currencies

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

    Universal Product Code