3 min read
Feed supported fields
For your feed file to be valid for indexing, it needs to be structured following the schema explained below based in JSON format.
note
- The fields in the Required fields table define product categories and identify products, and the fields in the Optional fields table provide business information about the products.
- Within each table, nested fields might be mandatory or not regardless of the required/optional nature of the field they belong to.
- Some object collection-type fields require not to be introduced by their field label. Refer to the Notes column in the tables below for detail about the specific object.
Required fields
Field | Nested in… | Description | Type | Mandatory | Notes |
---|---|---|---|---|---|
id | --- | Unique ID for the JSON object related to the product. | Alphanumeric | Yes | __id . |
name | --- | Product name. | Alphanumeric | Yes | __name . eb_categories & filter_categories at index time. |
categories | --- | Collection of categories the products relates to. | Category collection | Yes | Not empty. |
category | categories | Category object. | Object collection | Yes | Not introduced by its label. |
id | category | Category's unique ID. | Alphanumeric | No | Not empty. |
name | category | Category name. | Alphanumeric | Yes | Not empty. |
children | category | Collection of category's children. | Object collection | No | eb_categories & filter_categories at index time. |
id | children | Category child's ID. | Alphanumeric | No | Not empty. |
name | children | Category child's name. | Alphanumeric | Yes | Not empty. |
children | children | Category child’s children collection. | Object collection | No | Not empty. |
images | --- | Collection of product-related images. | URLs collection | Yes | __images . |
url | --- | Product URL. | URL | Yes | __url . |
Optional fields
Field | Nested in… | Description | Type | Mandatory | Notes |
---|---|---|---|---|---|
externalId | --- | Product ID in source catalog. | Alphanumeric | No | __externalID . |
description | --- | Product long description. It displays the exhaustive description of the product. Displayed in product detail pages, for example. | Alphanumeric | No | Can be indexed as __description . |
shortDescription | --- | Product short description. It displays a summary description of the product, for example, in result product cards. | Alphanumeric | No | |
type | --- | Product type description. It consists of one or few words describing the nature of the product, for example, digital or physical book. | Alphanumeric | No | |
price | --- | Product price. | Object | No | |
currency | price | Price currency. | Alphanumeric | No | |
current | price | Current price. | Object | Yes | |
value | current | Current price quantity. | Float | Yes | 0 . |
previous | price | Previous price. | Object | No | |
value | previous | Previous price quantity. | Float | Yes | 0 . |
future | price | Future price. | Object | No | |
value | future | Future price value. | Float | Yes | 0 . |
stock | ---- | Product units available. | Integer | No | Greater or equal than 0 . |
colours | --- | Collection of product colors available. | Array | No | Not empty. |
colour | colours | Product color. | Object | No | Not introduced by its label. |
id | colour | Color identification code. | Alphanumeric | No | |
name | colour | Color name. | Alphanumeric | Yes | |
sizes | --- | Product size. | Alphanumeric collection | No | Unique values. |
dimensions | --- | Product dimensions. | Object | No | At least two dimensions set (see width , height , depth ). |
width | dimensions | Product physical width. | Alphanumeric | Yes | Alias needed for nested objects. |
height | dimensions | Product physical height. | Alphanumeric | Yes | Alias needed for nested objects. |
depth | dimensions | Product physical depth. | Alphanumeric | No | Alias needed for nested objects. |
brand | --- | Product trademark | Alphanumeric | No | |
collection | --- | Unusual product grouping. For example, temporary collections (seasons, Black Friday...) | Alphanumeric | No | |
tags | --- | Collection of tags that qualify the product, mostly consumed by the Search microservice. | Object collection | No | To be merged into an array. |
name | tags | Tag name. | Alphanumeric | Yes | |
icon | tags | Icon displayed for the tag. | URL | No | URI format compliant. |
stores | --- | Collection of stores where the product is available | Alphanumeric collection | No |