Patch a promo code

PATCH /company/shops/@id/promocode-groups/@promocode_group_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
promocode_group_id	Int	Promocode ID

Body

Pass the following properties via application/json or form encoding in the body of the request.

Field	Type	Description
codes	[String]	Array of String
discount_type	String	String enumarion of 'PERCENT', 'FIXED'
usage_type	String	String enumarion of 'X_USES_TOTAL', 'X_USES_PER_PERSON'
fixed_discount	Int	An integer value
percent_discount	Int	An integer value
minimum_order_price	Int	An integer value
expiry_date	Date?	Nullable. Date in YYYY-MM-DD
max_uses	Int	An integer value
max_uses_per_user	Int	An integer value
applicable_on	Dictionary	A dictionary with fields

Example request 1

PATCH /company/shops/18/promocode-groups/14 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: 600

{
    "codes": [
        "...",
        "...",
        "..."
    ],
    "discount_type": "PERCENT",
    "usage_type": "X_USES_TOTAL",
    "fixed_discount": 17,
    "percent_discount": 13,
    "minimum_order_price": 17,
    "expiry_date": "2019-01-31",
    "max_uses": 10,
    "max_uses_per_user": 11,
    "applicable_on": {
        "all": false,
        "products": [
            17,
            18,
            19
        ],
        "categories": [
            11,
            13,
            14
        ],
        "product_prices": [
            11,
            12,
            12
        ]
    }
}

Response

Field	Type	Description
codes	[String]	Array of String
discount_type	String	String enumarion of 'PERCENT', 'FIXED'
usage_type	String	String enumarion of 'X_USES_TOTAL', 'X_USES_PER_PERSON'
fixed_discount	Int	An integer value
percent_discount	Int	An integer value
minimum_order_price	Int	An integer value
expiry_date	Date?	Nullable. Date in YYYY-MM-DD
max_uses	Int	An integer value
max_uses_per_user	Int	An integer value
applicable_on	Dictionary	A dictionary with fields
id	Int	An integer value
shop_id	Int	An integer value
times_used	Int	An integer value

Example response 1

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


{
    "codes": [
        "...",
        "...",
        "..."
    ],
    "discount_type": "PERCENT",
    "usage_type": "X_USES_TOTAL",
    "fixed_discount": 12,
    "percent_discount": 17,
    "minimum_order_price": 18,
    "expiry_date": "2019-01-31",
    "max_uses": 11,
    "max_uses_per_user": 13,
    "applicable_on": {
        "all": false,
        "products": [
            17,
            14,
            16
        ],
        "categories": [
            13,
            16,
            16
        ],
        "product_prices": [
            18,
            14,
            11
        ]
    },
    "id": 19,
    "shop_id": 18,
    "times_used": 17
}

1.9.0 stable