Batch API json files
Website personalisation
categories.json file
This is the schema for the categories.json file.
Each product record is as defined by the categories data schema.
{
"data": [
{ /* category record (see schema) */ },
{ /* category record (see schema) */ },
{ /* category record (see schema) */ },
{ /* category record (see schema) */ },
{ /* category record (see schema) */ },
{ /* category record (see schema) */ },
{ /* category record (see schema) */ },
{ /* category record (see schema) */ },
{ /* category record (see schema) */ },
{ /* category record (see schema) */ }
]
}
Delta support
See also: Delta updates
There are different use cases:
- Catalogue resync
- Catalogue additions
- Catalogue dependencies, additions/subtractions
You can use the action parameter for these.
products.json file
Each product record is as defined by the products data schema.
{
"data": [
{ /* product record (see schema) */ },
{ /* product record (see schema) */ },
{ /* product record (see schema) */ },
{ /* product record (see schema) */ },
{ /* product record (see schema) */ },
{ /* product record (see schema) */ },
{ /* product record (see schema) */ },
{ /* product record (see schema) */ },
{ /* product record (see schema) */ },
{ /* product record (see schema) */ }
]
}
pages.json file
Each page record is as defined by the pages data schema.
{
"data": [
{ /* page record (see schema) */ },
{ /* page record (see schema) */ },
{ /* page record (see schema) */ },
{ /* page record (see schema) */ },
{ /* page record (see schema) */ },
{ /* page record (see schema) */ },
{ /* page record (see schema) */ },
{ /* page record (see schema) */ },
{ /* page record (see schema) */ },
{ /* page record (see schema) */ }
]
}
definitions.json file
Each product record is as defined by the DITMAP data schema.
This file contains two sets of definitions:
{
"data": {
"product_types": [
{ /* DITMAP record (see schema) */ },
{ /* DITMAP record (see schema) */ },
{ /* DITMAP record (see schema) */ }
],
"attributes": [
{
/* DITMAP record (see schema) */,
"options": [
{ /* DITMAP record (see schema) */ },
{ /* DITMAP record (see schema) */ },
{ /* DITMAP record (see schema) */ }
]
},
{
/* DITMAP record (see schema) */,
"options": [
{ /* DITMAP record (see schema) */ },
{ /* DITMAP record (see schema) */ },
{ /* DITMAP record (see schema) */ }
]
},
{
/* DITMAP record (see schema) */,
"options": [
{ /* DITMAP record (see schema) */ },
{ /* DITMAP record (see schema) */ },
{ /* DITMAP record (see schema) */ }
]
}
]
}
}
Example:
{
"data": {
"product_types": [
{
"id": "tops",
"enabled": true,
"titles": {
"en-us": {
"default": "Running Top",
"alt_title": "Sports Top"
}
},
"media": null,
"abstracts": null,
"properties": null
},
{
"id": "dresses",
"enabled": true,
"titles": {
"en-us": {
"default": "Dresses",
"sub_title": "All Dresses"
}
},
"media": {
"default": {
"src": "https://mysite.com/images/dresses.jpg"
}
},
"abstracts": {
"en-us": {
"default": "<p>Dresses for all occasions</p>",
"occasion": "<p>Formal or casual dresses</p>"
}
},
"properties": null
}
],
"attributes": [
{
"id": "color",
"enabled": true,
"titles": {
"en-us": {
"default": "Color"
}
},
"options": [
{
"id": "red",
"enabled": true,
"titles": {
"en-us": {
"default": "Red"
}
},
"media": {
"default": {
"src": "https://mysite.com/images/red.jpg"
}
},
"properties": {
"color": {
"hex": "#ff0000"
}
}
},
{
"id": "green",
"enabled": true,
"titles": {
"en-us": {
"default": "Green"
}
},
"media": {
"default": {
"src": "https://mysite.com/images/green.jpg"
}
},
"properties": {
"color": {
"hex": "#00ff00"
}
}
}
]
},
{
"id": "size",
"enabled": true,
"titles": {
"en-us": {
"default": "Size"
}
},
"options": [
{
"id": "small",
"enabled": true,
"titles": {
"en-us": {
"default": "Small"
}
}
},
{
"id": "medium",
"enabled": true,
"titles": {
"en-us": {
"default": "Medium"
}
}
},
{
"id": "large",
"enabled": true,
"titles": {
"en-us": {
"default": "Large"
}
}
}
]
}
]
}
}
Updated 2 days ago