Catalog product content

The Catalog product details by EAN endpoint allows you to retrieve the current content details of one or more products in your catalog through its associated EAN.

It allows you to view the existing content of your product(s) in the catalog by providing access to the following details:

  • Publishing status

  • Product classification category

  • Enrichment level

  • Product attributes

  • Parties

  • Series

  • Audio tracks

The content details for different products can be retrieved by sending one EAN per request. The content for a product in the catalog can be a combination of content from various suppliers and is not limited to your content only.

You can use this endpoint to analyse the current content of a product before creating new content for your products through the Create content for a product request.

How can it help?

The Catalog product details by EAN endpoint benefits your business processes in the following ways:

  • Allows you to prevent excessive content upload requests.

  • Allows you to check whether the product already exists in the catalog.

  • Allows you to evaluate if the current product classification category is correct and whether a correction should be attempted.

  • Allows you to verify if your product meets the minimum publishing requirements(enrichment level 1) for the Wallonia region.

  • Allows you to identify the relevant attributes for a product based on its current product classification category. This prevents:

    • The product from being insufficiently enriched.

    • Sending requests with unrelated attributes based on the current product classification category.

Retrieving product content

Perform the steps below to retrieve the content details of your product:

  1. Specify the EAN of the product.

  2. Specify any one of the following language in which you want to retrieve the catalog product details:

    • nl

    • nl-BE

    • fr

    • fr-BE

    The default language setting for this endpoint is nl. For more information on the supported languages, click here.
  3. The response contains detailed information for the requested catalog product. For more information, refer to the Redoc.

Understanding publishing statuses and enrichment levels

The table below explains how to interpret the publishing statuses and enrichment levels for the specified EAN in the response body.

Table 1. Field names and their status descriptions
Field name Description

products.published

Specifies if the product complies with the minimum requirements to get published on the webshop.

  • true - Indicates that the provided product content does meets the minimum requirements to get published on the webshop.

  • false - Indicates that the provided product content is incomplete and has some attribute values missing.

products.enrichment.status

Specifies the current enrichment level of the product.

  • Level 0 - Indicates that the product is not published to the webshop as the mandatory attributes are missing.

  • Level 1 - Indicates that the product is published with some optional attributes missing.

  • Level 2 - Indicates that the product is fully enriched and is published with all mandatory and optional attributes.

An example of the API response in the data model is shown below:

{
  "products": [
    {
      "published": true,
      "gpc": {
        "chunkId": "string"
      },
      "enrichment": {
        "status": 0
      },
      "attributes": [
        {
          "id": "string",
          "values": [
            {
              "unitId": "string",
              "value": "string",
              "valueId": "string"
            }
          ]
        }
      ],
      "parties": [
        {
          "name": "string",
          "type": "string",
          "role": "string"
        }
      ],
      "audioTracks": [
        {
          "discNumber": "string",
          "trackNumber": "string",
          "discSide": "string",
          "title": "string",
          "artistName": "string",
          "playTime": "string",
          "clipUrl": "string",
          "clipType": "string"
        }
      ],
      "series": [
        {
          "name": "string"
        }
      ]
    }
  ]
}

For more information on the response codes and errors, refer to the Redoc.