Skip to content

Field Mapping ​

When your product feed doesn't follow the native Videobot format, use field mapping to transform your data. This guide explains how to configure custom field mappings.

When You Need Field Mapping ​

Use custom field mapping when your feed:

  • Uses different field names (e.g., name instead of title)
  • Has nested data structures
  • Stores images in arrays
  • Uses different JSON paths

Standard Product Fields ​

Videobot products require these five fields:

FieldTypeDescription
idStringUnique product identifier
titleStringProduct name/title
imageURLProduct image URL
descriptionHTMLProduct description (supports basic HTML)
urlURLLink to product page

Configuring Field Mapping ​

  1. Create or edit a feed
  2. Select Custom format
  3. Expand Field Mapping section
  4. Enter paths for each field

Path Syntax ​

Use dot notation to navigate nested structures:

Simple Paths ​

json
{ "name": "Product Name" }

Path: name

Nested Paths ​

json
{
  "details": {
    "title": "Product Name"
  }
}

Path: details.title

Array Index Paths ​

json
{
  "images": [
    { "url": "https://example.com/image1.jpg" },
    { "url": "https://example.com/image2.jpg" }
  ]
}

Path to first image: images.0.url

Deep Nesting ​

json
{
  "data": {
    "product": {
      "media": {
        "primary": {
          "src": "https://example.com/image.jpg"
        }
      }
    }
  }
}

Path: data.product.media.primary.src

Example Mapping ​

Given this custom feed structure:

json
{
  "data": {
    "items": [
      {
        "sku": "SKU-12345",
        "name": "Running Shoes",
        "media": {
          "images": [
            { "src": "https://example.com/shoe.jpg" }
          ]
        },
        "pricing": {
          "amount": 129.99,
          "currency": "USD"
        },
        "info": "Lightweight mesh with cushioning",
        "link": "https://example.com/products/12345"
      }
    ]
  }
}

Configure these settings:

SettingValue
Products Pathdata.items
IDsku
Titlename
Imagemedia.images.0.src
Descriptioninfo
URLlink

Using Test Connection for Field Discovery ​

When testing your feed, the response shows the structure of your products which helps identify the correct field paths:

  1. Click Test Connection
  2. Check if products were found
  3. Review any field mapping errors
  4. Use field names from your API documentation to build paths

HTML in Description ​

The description field supports basic HTML tags:

  • <strong>, <b> - Bold text
  • <em>, <i> - Italic text
  • <br> - Line break
  • <p> - Paragraph
  • <span> - Inline container
  • <s>, <del> - Strikethrough

Price Formatting Example ​

json
{
  "description": "<strong>$129.99</strong><br>Free shipping on orders over $50"
}

Displays as:

$129.99 Free shipping on orders over $50

Numeric Values ​

Numeric fields are automatically converted:

Original ValueConverted To
129"129"
129.99"$129.99" (for description fields)

Validation Errors ​

If field mapping fails, test results show specific errors:

ErrorCauseSolution
Missing field: titleField not found at pathVerify the path in raw data
Empty value for: imagePath exists but value is emptyCheck for alternate image fields
Invalid URL for: urlValue isn't a valid URLEnsure the field contains full URLs

Tips for Complex Feeds ​

  1. Start with Products Path: Get products array working first
  2. Use Test Connection: Verify each field as you configure it
  3. Check Raw Data: Refer to actual field names, not documentation
  4. Handle Arrays: Remember 0-based indexing for array positions
  5. Test Edge Cases: Verify products with missing optional data