List promotions

Returns discount promotions. Promotions apply percentage or fixed-amount discounts via coupon codes or automatic rules.

GET/promotions

Authorization

AuthorizationBearer token (JWT) · headerrequired

Query parameters

shop_idinteger

ID of the shop whose promotions to list.

statusstring

Filter by promotion status.

default: "all"

Allowed:activeexpiredall

qstring

Search by promotion name or code.

pageinteger

min 1 · default: 1

per_pageinteger

min 1 · max 200 · default: 20

Responses

200

Paginated promotions list

403

Access denied

422

shop_id required

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

shop_idqueryID of the shop whose promotions to list.statusqueryFilter by promotion status.qquerySearch by promotion name or code.pagequeryper_pagequery

Request

curl -X GET 'https://api.onbolder.com/v2/promotions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.onbolder.com/v2/promotions", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/promotions",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "_class": [
    "results",
    "promotions"
  ],
  "total_items": 1,
  "per_page": 20,
  "page": 1,
  "_links": {
    "self": {
      "href": "https://api.onbolder.com/v2/promotions?shop_id=1"
    }
  },
  "_embedded": {
    "items": [
      {
        "id": 20,
        "name": "Summer Sale 20%",
        "code": "SUMMER20",
        "activation_mode": "code",
        "discount_type": "percentage",
        "discount": 20,
        "status": "active",
        "starts_at": "2024-06-01T00:00:00Z",
        "expires_at": "2024-08-31T23:59:59Z",
        "_links": {
          "self": {
            "href": "https://api.onbolder.com/v2/promotions/20"
          }
        }
      }
    ]
  }
}