Get zipcode lists

GET /company/shops/@id/zipcode-lists

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

URL parameters

Replace the @ keywords in the URL with their corresponding value.

A dictionary with fields

Field Type Description
id Int Shop ID

Example request 1

GET /company/shops/12/zipcode-lists HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5

Response

Array of company.ZipcodeList: [company.ZipcodeList]

company.ZipcodeList

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

Example response 1

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 5575

[
    {
        "country": "BE",
        "zipcodes": [
            "...",
            "...",
            "..."
        ],
        "cost": {
            "d1": 10,
            "d2": 16,
            "d3": 17,
            "d4": 17,
            "d5": 18,
            "d6": 17,
            "d7": 13
        },
        "use_default_price": true,
        "quota_cost": {
            "enable": true,
            "quota": 16,
            "cost": {
                "d1": 14,
                "d2": 14,
                "d3": 18,
                "d4": 19,
                "d5": 11,
                "d6": 10,
                "d7": 15
            }
        },
        "price_deviations": [
            {
                "start_date": "2019-01-31",
                "end_date": "2019-01-31",
                "cost_per_day": {
                    "d1": 19,
                    "d2": 14,
                    "d3": 10,
                    "d4": 16,
                    "d5": 12,
                    "d6": 12,
                    "d7": 18
                }
            },
            {
                "start_date": "2019-01-31",
                "end_date": "2019-01-31",
                "cost_per_day": {
                    "d1": 10,
                    "d2": 12,
                    "d3": 19,
                    "d4": 16,
                    "d5": 19,
                    "d6": 18,
                    "d7": 17
                }
            },
            {
                "start_date": "2019-01-31",
                "end_date": "2019-01-31",
                "cost_per_day": {
                    "d1": 15,
                    "d2": 18,
                    "d3": 18,
                    "d4": 16,
                    "d5": 10,
                    "d6": 11,
                    "d7": 15
                }
            }
        ],
        "id": 12,
        "shop_id": 18
    },
    {
        "country": "BE",
        "zipcodes": [
            "...",
            "...",
            "..."
        ],
        "cost": {
            "d1": 10,
            "d2": 13,
            "d3": 11,
            "d4": 12,
            "d5": 10,
            "d6": 16,
            "d7": 19
        },
        "use_default_price": false,
        "quota_cost": {
            "enable": true,
            "quota": 16,
            "cost": {
                "d1": 18,
                "d2": 12,
                "d3": 15,
                "d4": 19,
                "d5": 13,
                "d6": 10,
                "d7": 13
            }
        },
        "price_deviations": [
            {
                "start_date": "2019-01-31",
                "end_date": "2019-01-31",
                "cost_per_day": {
                    "d1": 19,
                    "d2": 19,
                    "d3": 15,
                    "d4": 14,
                    "d5": 18,
                    "d6": 18,
                    "d7": 13
                }
            },
            {
                "start_date": "2019-01-31",
                "end_date": "2019-01-31",
                "cost_per_day": {
                    "d1": 18,
                    "d2": 15,
                    "d3": 15,
                    "d4": 19,
                    "d5": 12,
                    "d6": 15,
                    "d7": 16
                }
            },
            {
                "start_date": "2019-01-31",
                "end_date": "2019-01-31",
                "cost_per_day": {
                    "d1": 14,
                    "d2": 19,
                    "d3": 10,
                    "d4": 14,
                    "d5": 16,
                    "d6": 12,
                    "d7": 16
                }
            }
        ],
        "id": 11,
        "shop_id": 17
    },
    {
        "country": "BE",
        "zipcodes": [
            "...",
            "...",
            "..."
        ],
        "cost": {
            "d1": 12,
            "d2": 18,
            "d3": 14,
            "d4": 11,
            "d5": 18,
            "d6": 16,
            "d7": 19
        },
        "use_default_price": false,
        "quota_cost": {
            "enable": true,
            "quota": 19,
            "cost": {
                "d1": 11,
                "d2": 19,
                "d3": 14,
                "d4": 10,
                "d5": 18,
                "d6": 17,
                "d7": 18
            }
        },
        "price_deviations": [
            {
                "start_date": "2019-01-31",
                "end_date": "2019-01-31",
                "cost_per_day": {
                    "d1": 12,
                    "d2": 19,
                    "d3": 15,
                    "d4": 16,
                    "d5": 16,
                    "d6": 18,
                    "d7": 13
                }
            },
            {
                "start_date": "2019-01-31",
                "end_date": "2019-01-31",
                "cost_per_day": {
                    "d1": 12,
                    "d2": 13,
                    "d3": 11,
                    "d4": 13,
                    "d5": 10,
                    "d6": 15,
                    "d7": 14
                }
            },
            {
                "start_date": "2019-01-31",
                "end_date": "2019-01-31",
                "cost_per_day": {
                    "d1": 10,
                    "d2": 19,
                    "d3": 13,
                    "d4": 17,
                    "d5": 14,
                    "d6": 10,
                    "d7": 14
                }
            }
        ],
        "id": 15,
        "shop_id": 19
    }
]
This is a development version Do not use this version in production
1.10.0 development