3 min read

Feed supported fields

For your feed file to be valid for indexing, it needs to be structured based on the following JSON schema.

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
id --- Unique ID for the JSON object related to the product.
Notes:
  • Not empty
  • Can be indexed as __id
  • Alphanumeric Yes
    name --- Product name.
    Notes:
  • Not empty
  • Can be indexed as __name
  • Participates at generating eb_categories & filter_categories at index time
  • Alphanumeric Yes
    categories --- Collection of categories the products relates to.
    Note: not empty.
    Category collection Yes
    category categories Category object.
    Note: not introduced by its label.
    Object collection Yes
    id category Category's unique ID.
    Note: not empty.
    Alphanumeric No
    name category Category name.
    Note: not empty.
    Alphanumeric Yes
    children category Collection of category's children.
    Notes:
  • Not empty
  • Not introduced by its label
  • Participates at generating eb_categories & filter_categories at index time
  • Object collection No
    id children Category child's ID.
    Note: not empty.
    Alphanumeric No
    name children Category child's name.
    Note: not empty.
    Alphanumeric Yes
    children children Category child’s children collection.
    Note: not empty.
    Object collection No
    images --- Collection of product-related images.
    Notes:
  • URI format compliant
  • Can be indexed as __images
  • URLs collection Yes
    url --- Product URL.
    Notes:
  • URI format compliant
  • Can be indexed as __url
  • URL Yes

    Optional fields

    Field Nested in… Description Type Mandatory
    externalId --- Product ID in source catalogue.
    Notes:
  • Not empty
  • Can be indexed as __externalID
  • Alphanumeric No
    description --- Product long description. It displays the exhaustive description of the product. Displayed in product detail pages, for example.
    Note: can be indexed as __description.
    Alphanumeric No
    shortDescription --- Product short description. It displays a summary description of the product, e.g. in result product cards. Alphanumeric No
    type --- Product type description. It consists of one or few words describing the nature of the product. E.g. 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.
    Notes:
  • Greater than 0
  • Alias needed for nested objects
  • Float Yes
    previous price Previous price Object No
    value previous Previous price quantity.
    Notes:
  • Greater than 0
  • Alias needed for nested objects
  • Float Yes
    future price Future price Object No
    value future Future price value.
    Notes:
  • Greater than 0
  • Alias needed for nested objects
  • Float Yes
    stock ---- Product units available.
    Note: greater or equal than 0.
    Integer No
    colours --- Collection of product colors available.
    Note: not empty.
    Array No
    colour colours Product color.
    Note: not introduced by its label.
    Object No
    id colour Color identification code Alphanumeric No
    name colour Color name Alphanumeric Yes
    sizes --- Product size.
    Note: unique values.
    Alphanumeric collection No
    dimensions --- Product dimensions.
    Note: at least two dimensions set (see width, height, depth).
    Object No
    width dimensions Product physical width.
    Note: alias needed for nested objects.
    Alphanumeric Yes
    height dimensions Product physical height.
    Note: alias needed for nested objects.
    Alphanumeric Yes
    depth dimensions Product physical depth.
    Note: alias needed for nested objects.
    Alphanumeric No
    brand --- Product trademark Alphanumeric No
    collection --- Unusual product grouping. E.g. temporary collections (seasons, Black Friday...) Alphanumeric No
    tags --- Collection of tags that qualify the product, mostly consumed by the Search microservice. Note: to be merged into an array. Object collection No
    name tags Tag name Alphanumeric Yes
    icon tags Icon displayed for the tag.
    Note: URI format compliant.
    URL No
    stores --- Collection of stores where the product is available Alphanumeric collection No