In this document, we provide a resource of the basis JSON Schemas to be used for your project.

These schemas are provided for references and they don’t have to be used as provided and are only provided as a helper for your project.

product

display one specific product in a grid or a slider

...

title	JSON Schema

...

You can also download the provided Complete Layout Block and import them directly as new Layout Block in the Boxalino Intelligence Admin > Marketing > Layout Blocks.

Download all the separate Complete Layout Block files (zip):

View file

name	basis_layout_blocks.zip

Download all the Complete Layout Blocks in one importable list:

View file

name	basis_layout_blocks_all.json

product

display one specific product in a grid or a slider

Expand

title	JSON Schema

Code Block

language	json

{
  "title": "Product",
  "type": "object",
  "properties": {
    "accessor": {
      "type": "string",
      "description": "hits accessor (typically leave empty)"
    }
  }
}

Complete Layout Block:

View file

name	product.json

product_slider

display a container of products as a slider (children blocks should be product Layout Blocks)

Expand

title	JSON Schema

localized properties must be adapted to match your e-shop languages.

Code Block

language	json

{
  "title": "Label",
  "type": "object",
  "properties": {
    "title": {
      "type": "object",
      "title": "Label",
      "properties": {
        "de": {
          "type": "string",
          "description": "label in German"
        },
        "fr": {
          "type": "string",
          "description": "label in French"
        }
      }
    },
    "see_all_label": {
      "type": "object",
      "title": "See all link label",
      "properties": {
        "de": {
          "type": "string",
          "description": "see all link label in German"
        },
        "fr": {
          "type": "string",
          "description": "see all link label in French"
        }
      }
    },
    "see_all_link": {
      "type": "object",
      "title": "See all link",
      "properties": {
        "de": {
          "type": "string",
          "description": "see all link in German"
        },
        "fr": {
          "type": "string",
          "description": "see all link in French"
        }
      }
    },
    "accessor": {
      "type": "string",
      "description": "hits accessor (typically leave empty)"
    }
  }
}

Complete Layout Block:

View file

name	product_slider.json

product_list

display a container of products as a list or grid (children blocks should be product Layout Blocks)

Expand

title	JSON Schema

localized properties must be adapted to match your e-shop languages.

Code Block

language	json

{
  "title": "Label",
  "type": "object",
  "properties": {
    "title": {
      "type": "object",
      "title": "Label",
      "properties": {
        "de": {
          "type": "string",
          "description": "label in German"
        },
        "fr": {
          "type": "string",
          "description": "label in French"
        }
      }
    },
    "see_all_label": {
      "type": "object",
      "title": "See all link label",
      "properties": {
        "de": {
          "type": "string",
          "description": "see all link label in German"
        },
        "fr": {
          "type": "string",
          "description": "see all link label in French"
        }
      }
    },
    "see_all_link": {
      "type": "object",
      "title": "See all link",
      "properties": {
        "de": {
          "type": "string",
          "description": "see all link in German"
        },
        "fr": {
          "type": "string",
          "description": "see all link in French"
        }
      }
    },
    "accessor": {
      "type": "string",
      "description": "hits accessor (typically leave empty)"
    }
  }
}

Complete Layout Block:

View file

name	product_list.json

autocomplete_product

display one specific product in a search autocomplete overlay

Expand

title	JSON Schema

Code Block

language	json

{
  "title": "Product",
  "type": "object",
  "properties": {
    "accessor": {
      "type": "string",
      "description": "hits accessor (typically leave empty)"
    }
  }
}

Complete Layout Block:

View file

name	autocomplete_product.json

In this document, we provide a resource of JSON Schemas to be used for your project.

These schemas are provided for references and they don’t have to be used as provided and are only provided as a helper for your project.

product

...

autocomplete_product_list

display a container of products as a list in a search autocomplete overlay (children blocks should be autocomplete_product Layout Blocks)

localized properties must be adapted to match your e-shop languages.

Expand

title	JSON Schema

Code Block

language

Code Block

language	json

{
  "title": "ProductLabel",
  "type": "object",
  "properties": {
    "accessortitle": {
      "type": "stringobject",
      "descriptiontitle": "hits accessor (typically leave empty)"
Label",
      "properties": {
   }    }
}

Complete Layout Block:

View file

name	product.json

product_slider

display a container of products as a slider (children blocks should be product Layout Blocks)

Expand

title	JSON Schema

localized properties must be adapted to match your e-shop languages.

Code Block

language	json

{ "de": {
          "titletype": "Labelstring",
  "type": "object",   "properties": {     "description"title": {"label       "type": "object",in German"
       "title": "Label" },
      "properties": {         "de"fr": {
          "type": "string",
          "description": "label in German"French"
        }
      },
    },
    "frsee_all_label": {
  
       "type": "stringobject",
          "descriptiontitle": "labelSee all inlink Frenchlabel",
      "properties": {
}       } "de": {
  },     "see_all_label": {       "type": "objectstring",
          "titledescription": "Seesee all link label in German",
       "properties": { },
        "defr": {
          "type": "string",
          "description": "see all link label in German"French"
        }
      },
    },
    "frsee_all_link": {
          "type": "stringobject",
          "descriptiontitle": "seeSee all link",
label in French"    "properties": {
   }     "de": {
}     },     "see_all_linktype": {"string",
        "type": "object",
      "titledescription": "Seesee all link in German",
       "properties": { },
        "defr": {
          "type": "string",
          "description": "see all link in GermanFrench"
        },

      }
    },
    "fraccessor": {
   
      "type": "string",

         "description": "seehits allaccessor link(typically inleave Frenchempty)"
    }
   }
      }
    },
 }

Complete Layout Block:

View file

name	autocomplete_product_list.json

autocomplete_text

display one specific textual suggestion in a search autocomplete overlay

Expand

title	JSON Schema

Code Block

language	json

{
  "title": "Autocomplete Text",
  "accessortype": "object",
  "properties": {
    "accessor": {
      "type": "string",
      "description": "hitsautocomplete accessor (typically leave empty)"
    }
  }
}

Complete Layout Block:

View file

name	productautocomplete_slidertext.json

...

autocomplete_text_list

display a container of products text as a list or grid in a search autocomplete overlay (children blocks should be product autocomplete_text Layout Blocks)

localized properties must be adapted to match your e-shop languages.

Expand

title	JSON Schema

Code Block

language	json

{
  "title": "LabelAutocomplete Text List",
  "type": "object",
  "properties": {
    "titleaccessor": {
      "type": "objectstring",
      "titledescription": "Label",
      "properties": {ac-queries accessor (typically leave empty)"
    }
    "de": {
          "type": "string",
          "description": "label in German"
        },
        "fr}
}

Complete Layout Block:

View file

name	autocomplete_text_list.json

product_list_bar

a bar appearing before or after the product list to indicate the number of results, offer pagination and change of sort order

Expand

title	JSON Schema

Code Block

language	json

{
  "title": "Product",
  "type": "object",
  "properties": {
    "accessor": {
          "type": "string",
          "description": "labelhits inaccessor French"(typically leave  empty)"
     }
      }
    },
    "see_all_label": {
   }

Complete Layout Block:

View file

name	product_list_bar.json

pagination

a component to appear as a child element of a product_list_bar Layout Block and which displays the pagination controls to the user

Expand

title	JSON Schema

Code Block

language	json

{
  "title": "Pagination",
  "type": "object",
  "properties": {
    "titleaccessor": "See{
all link label",       "properties": {
        "de": {
          "type": "string",
          "description": "seehits allaccessor link(typically label in Germanleave empty)"
    }
   },
        "fr": {
          "}
}

Complete Layout Block:

View file

name	pagination.json

title

a simple title element showing a title H1 on the whole width of the page

Expand

title	JSON Schema

localized properties must be adapted to match your e-shop languages.

Code Block

language	json

{
  "title": "Title (H1)",
  "type": "stringobject",
     "properties": {
    "descriptiontitle": "see{
  all link label in French"type": "object",
       }"title": "Title",
      }"properties": {
   },     "see_all_linkde": {
          "type": "objectstring",
          "titledescription": "Seetitle allin linkGerman",
       "properties": { },
        "defr": {
          "type": "string",
          "description": "seetitle all link in GermanFrench"
        },
      }
 "fr": {  }
        "type": "string",
          "description": "see all link in French"
        }
      }
    }}
}

Complete Layout Block:

View file

name	title.json

subtitle

a simple title element showing a sub-title H3 on the whole width of the page

Expand

title	JSON Schema

localized properties must be adapted to match your e-shop languages.

Code Block

language	json

{
  "title": "Subtitle (H3)",
  "type": "object",
  "properties": {
    "title": {
      "type": "object",
      "title": "Title",
      "accessorproperties": {
        "typede": "string", {
          "descriptiontype": "hitsstring",
accessor (typically leave empty)"     }   "description": "Subtitle in German"
        }
}

Complete Layout Block:

View file

name	product_list.json

autocomplete_product_list

display a container of products as a list in a search autocomplete overlay (children blocks should be autocomplete_product Layout Blocks)

Expand

title	JSON Schema

localized properties must be adapted to match your e-shop languages.

Code Block

language	json

{
  "title": "Label,
        "fr": {
          "type": "string",
  "type": "object",   "properties": {     "titledescription": {"Subtitle in      "type": "object",French"
       "title": "Label", }
      "properties":}
{    }
    "de": {
          }
}

Complete Layout Block:

View file

name	subtitle.json

search_title

a simple title element showing a search title H1 on the whole width of the page (very similar template to integrate, but has a different internal behavior in Boxalino due to the parameter bx-search-title.

Expand

title	JSON Schema

localized properties must be adapted to match your e-shop languages.

Code Block

language	json

{
  "title": "Title (H1)",
  "type": "object",
  "properties": {
    "title": {
      "type": "stringobject",
          "descriptiontitle": "labelNormal inSearch GermanTitle",
      "properties": {
},         "frde": {
          "type": "string",
          "description": "labelnormal search intitlein FrenchGerman"
        },
      }  "fr": {
 },     "see_all_label": {       "type": "objectstring",
          "titledescription": "Seenormal search alltitle linkin label",French"
        }
      "properties":}
{    },
    "debx_alternate_title": {
          "type": "stringobject",
  
       "descriptiontitle": "seeCorrected all link label in German"Search Title",
      "properties": {
},
        "frde": {
          "type": "string",
          "description": "seecorrected allsearch link labeltitle in FrenchGerman"
        },
      }  "fr": {
 },     "see_all_link": {       "type": "objectstring",
          "titledescription": "Seecorrected search alltitlein link",French"
        }
      "properties":}
{    },
    "deaccessor": {
          "type": "string",
      "description": "search accessor (typically "description": "see all link in German"
        },
        "fr": {
          "type": "string",
          "description": "see all link in French"
        }
      }
    },
    leave empty)"
    }
  }
}

Complete Layout Block:

View file

name	search_title.json

facet_list

display the facets in a search or navigation page (has no children blocks, all the facets are provided as an array in the response parameter bx-facets)

Expand

title	JSON Schema

Code Block

language	json

{
  "title": "Facets",
  "type": "object",
  "properties": {
    "accessor": {
      "type": "string",
      "description": "hitsfacet accessor (typically leave empty)"
    }
  }
}

Complete Layout Block:

View file

name	autocompletefacet_productlist.json

Versions Compared

Old Version 13

New Version Current

Key

product

product

product_slider

product_list

autocomplete_product

product

autocomplete_product_list

product_slider

autocomplete_text

autocomplete_text_list

product_list_bar

title

subtitle

autocomplete_product_list

search_title

facet_list

Page Comparison

Versions Compared

Old Version 13

New Version Current

Key

product

product

product_slider

product_list

autocomplete_product

product

autocomplete_product_list

product_slider

autocomplete_text

autocomplete_text_list

product_list_bar

pagination

title

subtitle

autocomplete_product_list

search_title

facet_list