Fields when send to the api inside a request.
| Field | Type | Description |
|---|---|---|
| country | Country | 2 letter ISO representation of a country (string) |
| zipcodes | [String] | Array of String |
| cost | Week | Delivery cost per day of the week (in cents), e.g. make the sunday more/less expensive |
| use_default_price | Bool | A boolean value |
| quota_cost | Dictionary | A different cost once the value of the order reaches a certain quota. Mostly used to offer the customer cheaper delivery prices when their order contains more than ... in value. |
| price_deviations | [Dictionary] | Change the price for certain periods of time. |
Fields when returned by the api in a response.
| Field | Type | Description |
|---|---|---|
| country | Country | 2 letter ISO representation of a country (string) |
| zipcodes | [String] | Array of String |
| cost | Week | Delivery cost per day of the week (in cents), e.g. make the sunday more/less expensive |
| use_default_price | Bool | A boolean value |
| quota_cost | Dictionary | A different cost once the value of the order reaches a certain quota. Mostly used to offer the customer cheaper delivery prices when their order contains more than ... in value. |
| price_deviations | [Dictionary] | Change the price for certain periods of time. |
| id | Int | An integer value |
| shop_id | Int | An integer value |
When used inside a request.
{
"country": "BE",
"zipcodes": [
"...",
"...",
"..."
],
"cost": {
"d1": 16,
"d2": 10,
"d3": 14,
"d4": 18,
"d5": 13,
"d6": 14,
"d7": 17
},
"use_default_price": true,
"quota_cost": {
"enable": true,
"quota": 13,
"cost": {
"d1": 15,
"d2": 10,
"d3": 10,
"d4": 12,
"d5": 18,
"d6": 14,
"d7": 11
}
},
"price_deviations": [
{
"start_date": "2019-01-31",
"end_date": "2019-01-31",
"cost_per_day": {
"d1": 17,
"d2": 11,
"d3": 11,
"d4": 11,
"d5": 18,
"d6": 10,
"d7": 18
}
},
{
"start_date": "2019-01-31",
"end_date": "2019-01-31",
"cost_per_day": {
"d1": 11,
"d2": 14,
"d3": 14,
"d4": 19,
"d5": 10,
"d6": 14,
"d7": 12
}
},
{
"start_date": "2019-01-31",
"end_date": "2019-01-31",
"cost_per_day": {
"d1": 19,
"d2": 17,
"d3": 18,
"d4": 18,
"d5": 12,
"d6": 14,
"d7": 16
}
}
]
}When returned in a response.
{
"country": "BE",
"zipcodes": [
"...",
"...",
"..."
],
"cost": {
"d1": 19,
"d2": 16,
"d3": 16,
"d4": 19,
"d5": 16,
"d6": 11,
"d7": 16
},
"use_default_price": true,
"quota_cost": {
"enable": true,
"quota": 13,
"cost": {
"d1": 12,
"d2": 18,
"d3": 12,
"d4": 12,
"d5": 12,
"d6": 17,
"d7": 15
}
},
"price_deviations": [
{
"start_date": "2019-01-31",
"end_date": "2019-01-31",
"cost_per_day": {
"d1": 18,
"d2": 14,
"d3": 17,
"d4": 19,
"d5": 18,
"d6": 16,
"d7": 15
}
},
{
"start_date": "2019-01-31",
"end_date": "2019-01-31",
"cost_per_day": {
"d1": 15,
"d2": 10,
"d3": 18,
"d4": 18,
"d5": 13,
"d6": 17,
"d7": 12
}
},
{
"start_date": "2019-01-31",
"end_date": "2019-01-31",
"cost_per_day": {
"d1": 18,
"d2": 14,
"d3": 19,
"d4": 17,
"d5": 19,
"d6": 13,
"d7": 17
}
}
],
"id": 11,
"shop_id": 12
}