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
display one specific product in a grid or a slider
{
"title": "Product",
"type": "object",
"properties": {
"accessor": {
"type": "string",
"description": "hits accessor (typically leave empty)"
}
}
}
Complete Layout Block:
product_slider
display a container of products as a slider (children blocks should be product Layout Blocks)
localized properties must be adapted to match your e-shop languages.
{
"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:
product_list
display a container of products as a list or grid (children blocks should be product Layout Blocks)
localized properties must be adapted to match your e-shop languages.
{
"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:
autocomplete_product
display one specific product in a search autocomplete overlay
{
"title": "Product",
"type": "object",
"properties": {
"accessor": {
"type": "string",
"description": "hits accessor (typically leave empty)"
}
}
}
Complete Layout Block:
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.
{
"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:
0 Comments