Book a demo

Product Feed

The fields of the product feed, which Athena XAI uses for search indexing and search relevance processing.

Last updated

On this page

Overview

Athena XAI uses the product feed for search indexing and search relevance processing. Format your data using the fields and the example below.

Basic product fields

Field nameData typeDescriptionRequirement
entity_idintYour product’s unique identifier. Each product needs a unique value. Use your product’s ID where possible.required
skustringYour product’s Stock Keeping Unit (SKU). Each product needs a unique value. Use your product’s SKU where possible. This field can be searchable.optional
namestringYour product’s name. It should match the title on your product landing page and accurately describe the product in a few words. This field can be searchable.required
imagestringThe URL of your product’s main image.required
linkstringThe URL of your product’s landing page.required
descriptionstringYour product’s description. It should accurately describe the product and match the description on your landing page. This field can be searchable.required
type_id‘configurable’ | ‘simple’ | ‘bundle’The type of your product: simple, configurable, bundle… If the product has configurable options (for example, different colors or sizes), use ‘configurable’. If not, use ‘simple’.required
hover_imagestringThe URL of your product’s hover image.optional
short_descriptionstringYour product’s short description. It should accurately describe the product in a few words and match the description on your landing page. This field can be searchable.optional
reviewsintoptional
total_reviewsintoptional

Price and availability fields

Field nameData typeDescriptionRequirement
priceintYour product’s price as a number. It should match the price on the product’s landing page. You can search for products by the value of the price.required
special_priceintYour product’s price when it is on sale. It should match the price on the product’s landing page. You can search for products by the value of the special price.optional
stock1 | 0Tells whether your product is in stock: 1 if it is in stock, 0 if it is out of stock. The default value of this field is 1.optional
salable_qtyintSalable Quantity is the sum of available resources, grouped in stocks. The default value of this field is 1 if stock is 1. If stock is 0, the default value is 0.optional
child_pricesarray of doubleIf your products have child products, you can submit an array of child product prices. If you set child prices, Athena XAI uses the smallest child price as the price of the product.optional
child_special_pricesarray of doubleIf your products have child products with special prices, you can submit an array of child special prices. If you set them, Athena XAI uses the smallest child special price as the special price of the product.optional
customer_groupsarray of objectsUse this field to add different prices for each customer group. Each object should have a customer_group_id, regular_price and special_price, as in the example.optional
btb_groupsarray of objectsUse this field to add different prices for each B2B group. Each object should have a btb_group_id, qty, regular_price and special_price, as in the example.optional

Product categories and attributes fields

Field nameData typeDescriptionRequirement
categoriesint[]The categories your product belongs to. Set them as an array of category IDs, as in the example.optional
{{ attribute_code }}arrayThe attributes of your product, from those you provided in the Attribute Feed. You can see all of them on the Athena XAI Dashboard under Settings -> Filters. An attribute can have one or multiple values. Separate multiple values with a comma (for example, “size”: “4504,4505,4506”, where the key is the attribute code from your feed and the values are its possible values). Attributes can be used to search for your product.optional

The name of the {{ attribute_code }} field is the value of the code field of the attribute you want to reference (for example, ‘size’, ‘color’, ‘brand’, ‘material’).

Additional product fields

Field nameData typeDescriptionRequirement
configurable_optionsobjectIf your product has configurable options and you set type_id to configurable, set those options here. Provide only the options you want to see on the frontend, as in the example.optional
child_productsobjectData about your product’s child products, as in the example. Each child can have the same fields as a parent object and should have a unique key, which should be the child product’s entity_id if possible.optional
meta_titlestringA text that provides additional short information about your product.optional
mata_descriptionstringA text that provides additional product description.optional

Example

JSON
[
  {
    "entity_id": "68",
    "type_id": "configurable",
    "name": "Chaz Kangeroo Hoodie",
    "sku": "MH01",
    "image": "https://magento.local.com/media/main-image.jpg",
    "hover_image": "https://magento.local.com/media/hover-image.jpg",
    "brand": "158",
    "material": "201,203,204,207,209",
    "new": "0",
    "sale": "1",
    "price": 52.99,
    "special_price": 42.99,
    "short_description": "Ideal for cold-weather training or work outdoors",
    "description": "Ideal for cold-weather training or work outdoors, hoodie promises superior warmth.",
    "meta_title": "Your product’s meta title",
    "meta_description": "Your product’s meta description",
    "store_id": 1,
    "total_reviews": 2,
    "reviews": 70,
    "link": "https://magento.local.com/chaz-kangeroo-hoodie.html",
    "status": 1,
    "stock": 1,
    "salable_qty": 146,
    "created_at": "2021-07-26 08:02:53",
    "updated_at": "2021-07-26 08:02:53",
    "categories": [
      "15",
      "36",
      "2"
    ],
    "configurable_options": {
      "size": {
        "0": "166",
        "3": "167"
      },
      "color": {
        "0": "49"
      }
    },
    "customer_groups": {
      "0": {
        "regular_price": 52.99,
        "customer_group_id": 0
      },
      "1": {
        "regular_price": 52.99,
        "special_price": 42.99,
        "customer_group_id": 1
      },
      "2": {
        "regular_price": 52.99,
        "special_price": 42.99,
        "customer_group_id": 2
      }
    },
    "btb_groups": [
      {
        "regular_price": 512.99,
        "qty": 98,
        "btb_group_id": "company-23"
      },
      {
        "regular_price": 72.99,
        "qty": 235,
        "btb_group_id": "company-56"
      },
      {
        "regular_price": 52.99,
        "special_price": 32.99,
        "qty": 52,
        "btb_group_id": "company-39"
      }
    ],
    "child_prices": {
      "53": 52.99,
      "54": 52.99
    },
    "child_special_prices": {
      "53": 42.99,
      "54": 42.99
    },
    "child_products": {
      "53": {
        "entity_id": "53",
        "sku": "MH01-XS-Black",
        "image": "https://magento.local.com/media/main-child-image.jpg",
        "hover_image": "https://magento.local.com/media/hover-child-image.jpg",
        "status": true,
        "configurable_options": {
          "size": "166",
          "color": "49"
        }
      },
      "54": {
        "entity_id": "54",
        "sku": "MH01-XS-Gray",
        "image": "https://magento.local.com/media/main-child-image1.jpg",
        "hover_image": "https://magento.local.com/media/hover-child-image-1.jpg",
        "status": false,
        "configurable_options": {
          "size": "166",
          "color": "52"
        }
      }
    }
  }
]