Specifications for the files needed to populate the eCommerce site.
Hierarchy of the products groups.
products_groups_t<TENANT_ID>_<EPOCH TIME>.json
products_groups_t22_1726739101.json
| field | type | description |
|---|---|---|
| code | string | unique identifier of the group |
| sequence | integer | display sequence of the group |
| ml | string | labels of the group |
| code_parent | string | identifier of the parent group or "null" for the first level groups |
[
{
"code": "l1-g08",
"sequence": "10",
"ml": {
"de": "Tischbesteck",
"en": "Cutlery",
"fr": "Couverts de table"
},
"code_parent": "l0-g01"
}, {...}
]
products_t<TENANT_ID>_<EPOCH TIME>.json
products_t22_1726739101.json
Product
| field | type | description |
|---|---|---|
| code | string | SKU (Stock keeping unit), unique product identifier |
| category | string | product group identifier. Should exists in the products_groups.json files |
| state | string | product state (user defined) |
| type | string | product type. 1->physical item. |
| sequence | integer | display sequence in the product group |
| webshop | boolean | true if the product should be available on the webshop |
| fields | array of objects | List of fields |
| gtins | array of objects | List of GTIN |
Field
| field | type | description |
|---|---|---|
| name | string | name of a specific field from the list below |
| value | any | value of the field |
GTIN
| field | type | description |
|---|---|---|
| value | string | GTIN value |
| type | string | GTIN type (free) |
| usage | string | GTIN usage (free) |
| valid_at | ISO date | beginning of time range |
| invalid_at | ISO date | end of time range or null |
[{
"code": "99.000-800",
"category": "l1-g08",
"state": "11",
"type": "1",
"sequence": 9999999,
"webshop": true,
"fields": [
{
"name": "wr.logistic.uom.sales.enforce_min",
"value": false
},
{
"name": "wr.logistic.uom.sales.enforce_quantity",
"value": false
},
{
"name": "wr.logistic.uom.sales.min",
"value": 36
},
{
"name": "wr.logistic.uom.sales.quantity",
"value": 1
},
{
"name": "wr.more",
"value": "[{\"key\":\"wr.price.retail_inc_vat\",\"value\":\"15.00\"}]"
},
{...}
],
"gtins": [
{
"value": "7611068990537",
"type": "EAN-13",
"usage": "ART",
"valid_at": "2018-02-21",
"invalid_at": null
}
]
}, {...}]
| field | required | type | description | example |
|---|---|---|---|---|
| wr.logistic.uom.sales.enforce_min | ✅ | boolean | enforce a minimum quantity | true |
| wr.logistic.uom.sales.enforce_quantity | ✅ | boolean | enforce the quantity at a multiple of the increment | false |
| wr.logistic.uom.sales.min | ✅ | integer | minimum quantity | 12 |
| wr.logistic.uom.sales.quantity | ✅ | integer | increment for the quantity | 6 |
| wr.logistic.uom.sales.products_by_unit | integer | number of product by sale unit | 1 | |
| wr.stock.available | ✅ | integer | number of units available in stock - planned out + planned in | 800 |
| wr.stock.planned_out | integer | number of units planned out (unused) | 100 | |
| wr.stock.planned_in | integer | number of units planned in (unused) | 200 | |
| wr.stock.warehouse | integer | number of units available in stock | 700 | |
| wr.tax.swico.currency | decimal | SWICO amount in currency | 1.20 | |
| wr.product.status.code | string | Status identifier of the product | "10" | |
| wr.brand.name | string | Brand name | "Zanneto" | |
| wr.supplier.product.code | string | Supplier SKU of the product | "DS44SF" | |
| wr.text.short.fr | ✅ | string | Short product description in french | "Coffret bois" |
| wr.text.short.de | ✅ | string | Short product description in german | "Holzkassette" |
| wr.text.short.en | ✅ | string | Short product description in english | "Wooden box" |
| wr.text.short.it | string | Short product description in italian | "Scatola di legno" | |
| wr.tax.vat.rate | ✅ | integer | VAT rate * 100 | 810 |
| wr.more | array of objects | Custom informations |
Pricing of the products.
pricing-20_<EPOCH TIME>.json
pricing-20_1726739101.json
| field | type | description |
|---|---|---|
| product_code | string | Product's SKU |
| rules | array of string | calculation rule |
| priority | integer | 20 (fixed) |
| quantity | integer | minimum quantity to apply the rule |
| active_at | integer | Active since DateTime with seconds in Unix Epoch format |
| inactive_at | integer | Active to DateTime with seconds in Unix Epoch format |
| more | object | reserved |
| visible | boolean | true if customer can see the product |
| discount | boolean | true if the price is discounted |
[
{
"product_code": "99.000-800",
"rules": [
"=2355"
],
"priority": 20,
"quantity": 1,
"active_at": 1577836800,
"inactive_at": null,
"visible": true,
"discount": false
}, {...}
]
Pricing of the products for groups of customers.
Pricing of the products for specific customers.
The format to specifiy a price is the following:
["=<PRICE-IN-CURRENCY * 100"]
For a price of CHF 23.55:
["=2355"]