Get all promo codes from a shop

GET /company/shops/@id/promocode-groups

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/16/promocode-groups HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.9.0
Accept-Language: en-US,en;q=0.5

Response

Array of company.PromoCodeGroup: [company.PromoCodeGroup]

company.PromoCodeGroup

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

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