Patch a zipcode list

PATCH /company/shops/@id/zipcode-lists/@zipcode_list_id

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
zipcode_list_id Int Promocode ID

Body

Pass the following properties via application/json or form encoding in the body of the 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.

Example request 1

PATCH /company/shops/18/zipcode-lists/13 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.9.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 1527
{
    "country": "BE",
    "zipcodes": [
        "...",
        "...",
        "..."
    ],
    "cost": {
        "d1": 15,
        "d2": 14,
        "d3": 15,
        "d4": 18,
        "d5": 16,
        "d6": 11,
        "d7": 10
    },
    "use_default_price": true,
    "quota_cost": {
        "enable": false,
        "quota": 18,
        "cost": {
            "d1": 16,
            "d2": 15,
            "d3": 12,
            "d4": 10,
            "d5": 13,
            "d6": 18,
            "d7": 13
        }
    },
    "price_deviations": [
        {
            "start_date": "2019-01-31",
            "end_date": "2019-01-31",
            "cost_per_day": {
                "d1": 12,
                "d2": 14,
                "d3": 14,
                "d4": 16,
                "d5": 16,
                "d6": 18,
                "d7": 13
            }
        },
        {
            "start_date": "2019-01-31",
            "end_date": "2019-01-31",
            "cost_per_day": {
                "d1": 17,
                "d2": 18,
                "d3": 17,
                "d4": 15,
                "d5": 16,
                "d6": 13,
                "d7": 11
            }
        },
        {
            "start_date": "2019-01-31",
            "end_date": "2019-01-31",
            "cost_per_day": {
                "d1": 10,
                "d2": 17,
                "d3": 16,
                "d4": 12,
                "d5": 18,
                "d6": 11,
                "d7": 11
            }
        }
    ]
}

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

Example response 1

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

{
    "country": "BE",
    "zipcodes": [
        "...",
        "...",
        "..."
    ],
    "cost": {
        "d1": 19,
        "d2": 11,
        "d3": 13,
        "d4": 16,
        "d5": 15,
        "d6": 17,
        "d7": 12
    },
    "use_default_price": false,
    "quota_cost": {
        "enable": false,
        "quota": 18,
        "cost": {
            "d1": 16,
            "d2": 15,
            "d3": 19,
            "d4": 17,
            "d5": 11,
            "d6": 13,
            "d7": 13
        }
    },
    "price_deviations": [
        {
            "start_date": "2019-01-31",
            "end_date": "2019-01-31",
            "cost_per_day": {
                "d1": 18,
                "d2": 10,
                "d3": 10,
                "d4": 11,
                "d5": 12,
                "d6": 19,
                "d7": 17
            }
        },
        {
            "start_date": "2019-01-31",
            "end_date": "2019-01-31",
            "cost_per_day": {
                "d1": 11,
                "d2": 17,
                "d3": 12,
                "d4": 13,
                "d5": 12,
                "d6": 18,
                "d7": 16
            }
        },
        {
            "start_date": "2019-01-31",
            "end_date": "2019-01-31",
            "cost_per_day": {
                "d1": 12,
                "d2": 17,
                "d3": 13,
                "d4": 19,
                "d5": 19,
                "d6": 16,
                "d7": 14
            }
        }
    ],
    "id": 14,
    "shop_id": 14
}
1.9.0 stable