Specifications for the files generated by the eCommerce plateform.
Orders from the customers.
doc-<DOCUMENT_ID>.json
doc-co-24-007.340.json
Document
| field | type | description |
|---|---|---|
| code | string | unique identifier of the document |
| date | ISO date | date of the document |
| options | object | options of the document |
| source_created | ISO timestamp | timestamp of the document creation |
| interface | string | SHOP or APP |
| state | string | state |
| type | string | type |
| contact | object | information about the customer |
| address | object | information about the customer's address |
| tenant_user | object | information about the user |
| remark_external | string | customer's remark |
| lines | array of objects | document's lines |
Line
| field | type | description |
|---|---|---|
| sequence | integer | line's sequence in the document |
| code | string | product SKU |
| flag | integer | 0->normal, 1->free |
| label | string | product's label |
| price | object | line's price |
| quantity | decimal | line's quantity |
| product | object | line's product |
price
| field | type | description |
|---|---|---|
| amount | integer | amount in currency * 100 |
| currency | string | currency |
product
| field | type | description |
|---|---|---|
| code | string | product's SKU |
| sequence | integer | product's sequence |
| taxon | string | product's taxon |
| state | string | product's state |
| type | string | product's type |
{
"code": "CO/24/007.349",
"date": "2024-09-30",
"options": {},
"source_created_at": "2024-09-30T14:37:44Z",
"interface": "SHOP",
"source_label": null,
"state": "published",
"type": "CO",
"contact": {
"code": "E1000",
"company": null,
"first_name": null,
"last_name": "Mayfair Deer"
},
"address": {
"street1": "Bahnhofstrasse 17",
"street2": null,
"city": "Zug",
"zip": "6300",
"country_iso": "CH"
},
"tenant_user": {
"id": 999,
"code_user": "A299"
},
"remark_external": null,
"lines": [
{
"sequence": 1,
"code": "75BB46",
"flags": 0,
"label": null,
"price": {
"amount": 494,
"currency": "CHF"
},
"quantity": "60",
"product": {
"code": "75BB46",
"sequence": 10,
"taxon": "t.product",
"state": "0",
"type": "1",
}
},
{
"sequence": 2,
...
},
]
}