Get a promo code

GET /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

Example request 1 

GET /company/shops/18/promocode-groups/10 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5

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: 654


{
    "codes": [
        "...",
        "...",
        "..."
    ],
    "discount_type": "PERCENT",
    "usage_type": "X_USES_TOTAL",
    "fixed_discount": 16,
    "percent_discount": 11,
    "minimum_order_price": 19,
    "expiry_date": "2019-01-31",
    "max_uses": 14,
    "max_uses_per_user": 18,
    "applicable_on": {
        "all": true,
        "products": [
            10,
            15,
            14
        ],
        "categories": [
            16,
            14,
            14
        ],
        "product_prices": [
            12,
            19,
            19
        ]
    },
    "id": 14,
    "shop_id": 19,
    "times_used": 10
}
This is a development version Do not use this version in production
1.10.0 development