Validation¶

Validation of the catalog import is a vital part of Voyado Elevate to ensure a fully functional site. All files are automatically validated on import, where any syntax errors or detected content errors will cause the import to fail. Examples of content errors are duplicate keys, duplicate image URLs, and missing mandatory information.

Validation-only mode¶

Catalog imports can be submitted with the query parameter validationOnly=true, in which case the import is validated but not applied. This allows errors to be caught and resolved before data reaches the system.

Error details¶

When an import fails validation, the response includes an errorDetails JSON object. It reports the total error count, which keys are erroneous grouped by entity type, and a breakdown of each distinct error message with an example key list.

{
  "count": 4,
  "productGroups": {
    "count": 1,
    "keys": ["PG1"]
  },
  "products": {
    "count": 2,
    "keys": ["P1", "P2"]
  },
  "variants": {
    "count": 1,
    "keys": ["P2V1"]
  },
  "dataErrors": {
    "product: 'se' in 'markets' have not been configured.": {
      "count": 2,
      "exampleKeys": ["P1", "P2"]
    },
    "variant: Missing mandatory property 'listPrice'": {
      "count": 1,
      "exampleKeys": ["P2V1"]
    },
    "product group: Inner error for product group. See other errors for details.": {
      "count": 1,
      "exampleKeys": ["PG1"]
    }
  }
}

OpenAPI specification¶

An OpenAPI specification that details the catalog format is available for each API version on the Specifications page. The specification can be used to validate catalog data locally before import, and to generate typed clients or connectors for the integration.