ProductIngestInput

Product payload accepted by the catalogue ingest endpoint. Field names use camelCase. Top-level 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:
    required

    String values in multiple languages

    Properties: 1
  • dimensions
    Type: nullable
    required

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

    Properties: 3
  • images
    Type: array of string 1…Format: uri
    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:
    required

    String values in multiple languages

    Properties: 1
  • price
    Type:
    required

    Numeric price values keyed by uppercase ISO 4217 currency code

    Properties: 1
  • sku
    Type: string
    min length:  
    1
    required

    Stock keeping unit — unique within the catalogue

  • url
    Type: stringFormat: 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 of string
    min length:  
    1

    Category names

  • colour
    Type: nullable

    Optional colour information

    Properties: 2
  • customProperties
    Type: object

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

    Properties: 1
  • ean
    Type: string | null

    European Article Number

  • priceDiscount
    Type: nullable

    Discounted price in multiple currencies

    Properties: 1
  • upc
    Type: string | null

    Universal Product Code

  • vendor
    Type:

    Merchant for this offer. Missing or null preserves an existing merchant link. Changing the merchant resets all enrichment approval groups to pending.

    Properties: 2
    • name
      Type: string
      required
Previous
VendorInput
Next
CatalogueIngestRequest