Product schema

Learn about the format of your product records in Algolia for BigCommerce.

Algolia’s BigCommerce integration stores your product data in an extensible format that’s optimal for search. The search record format has two options: product-level or variant-level indexing. Product-level indices have variants embedded in the entity, while variant-level produces one record per variant.

Product-level schema

Algolia stores BigCommerce products in the following format:

JSON

{
  "brand_id": 37,
  "brand_name": "My Brand",
  "categories": {
    "lvl0": ["Library", "New Products", "Publications"]
  },
  "category_ids": [20, 23, 24],
  "custom_fields": {},
  "date_created": "2015-07-03T20:55:30Z",
  "date_modified": "2023-11-22T10:26:41Z",
  "default_price": 37,
  "description": "...",
  "image_url": "https://...",
  "in_stock": true,
  "inventory": 90,
  "inventory_tracking": "variant",
  "is_visible": true,
  "metafields": {},
  "name": "My Awesome Product",
  "objectID": "111",
  "option_names": ["Publisher", "Edition"],
  "prices": { "EUR": 11.112, "USD": 34.65 },
  "product_images": [
    {
      "description": "",
      "is_thumbnail": false,
      "url_thumbnail": "https://..."
    },
    {
      "description": "",
      "is_thumbnail": true,
      "url_thumbnail": "https://..."
    }
  ],
  "retail_prices": { "EUR": 0, "USD": 0 },
  "sales_prices": { "EUR": 0, "USD": 0 },
  "calculated_prices": { "EUR": 0, "USD": 0 },
  "sku": "MAP0001",
  "url": "/my-awesome-product/",
  "variant_ids": [1210, 1211],
  "variants": [
    {
      "id": 1210,
      "image_url": "",
      "in_stock": false,
      "inventory": 0,
      "metafields": {},
      "options": { "Premium": "Yes", "Toto": "test" },
      "prices": { "EUR": 11.112, "USD": 34.65 },
      "retail_prices": { "EUR": 0, "USD": 0 },
      "sales_prices": { "EUR": 0, "USD": 0 },
      "sku": "MAP0001-A",
      "upc": "1234",
      "mpn": "2344",
      "gtin": "3456"
    },
    {
      "id": 1211,
      "image_url": "",
      "in_stock": true,
      "inventory": 10,
      "metafields": {},
      "options": { "Publisher": "My Publisher", "Edition": "2024" },
      "prices": { "EUR": 11.112, "USD": 34.65 },
      "retail_prices": { "EUR": 0, "USD": 0 },
      "sales_prices": { "EUR": 0, "USD": 0 },
      "sku": "MAP0001-B",
      "upc": "4321",
      "mpn": "5432",
      "gtin": "6543"
    }
  ],
  "upc": "123456789",
  "mpn": "123456789",
  "gtin": "123456789"
}

Variant-level schema

Algolia stores BigCommerce product variants in the following format:

JSON

{
  "brand_id": 37,
  "brand_name": "My Brand",
  "categories": {
    "lvl0": ["Library", "New Products", "Publications"]
  },
  "category_ids": [20, 23, 24],
  "custom_fields": {},
  "date_created": "2015-07-03T20:55:30Z",
  "date_modified": "2023-11-22T10:26:41Z",
  "default_price": 37,
  "description": "...",
  "image_url": "https://...",
  "in_stock": false,
  "inventory": 0,
  "inventory_tracking": "variant",
  "is_visible": true,
  "name": "My Awesome Product",
  "objectID": "1",
  "option_names": ["Publisher", "Edition"],
  "options": { "Publisher": "My Publisher", "Edition": "2024" },
  "prices": { "EUR": 34.262, "USD": 34.65 },
  "product_id": 111,
  "product_images": [
    {
      "description": "",
      "is_thumbnail": false,
      "url_thumbnail": "https://..."
    },
    {
      "description": "",
      "is_thumbnail": true,
      "url_thumbnail": "https://..."
    }
  ],
  "product_metafields": {},
  "retail_prices": { "EUR": 0, "USD": 0 },
  "sales_prices": { "EUR": 0, "USD": 0 },
  "calculated_prices": { "EUR": 0, "USD": 0 },
  "sku": "MAP00001",
  "url": "/my-awesome-product/",
  "variant_id": 1,
  "variant_metafields": {},
  "upc": "123456789",
  "mpn": "123456789",
  "gtin": "123456789"
}

Changes to your BigCommerce inventory

Algolia’s BigCommerce integration monitors inventory changes and updates the isInStock attribute for each affected SKU. isInStock is set to true if inventory_level is greater than zero for that SKU.

Prices

The prices attribute is an object with currency codes as keys and product prices as values.