Отримати список промокодів

GET/api/crm/v2/special_offers_promo_codesv2

operationId: specialOffersPromoCodes.default

Авторизація

api-token + language + role

Параметри запиту

branch_idinteger

Філія, за якою фільтрується список. Без неї у відповіді лише фільтри, без списку. Партнеру з однією філією сервер підставляє її автоматично.

Приклад: 8778

special_offer_idinteger

Приклад: 1

page_numberinteger

Приклад: 1

Відповіді

object

statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

special_offer_idobject (FilterSelect)

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of object

valuestringобов’язковий

Приклад: example

namestringобов’язковий

Приклад: All

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

listarray of object

idintegerобов’язковий

Приклад: 1

codestringобов’язковий

Приклад: CODE1933

countinteger

Приклад: 2

count_activationsintegerобов’язковий

Приклад: 0

date_availablestring (DataTimeFormatSQL)

Приклад: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Приклад: 2024-05-02 08:31:16

bonuses_sumnumber

Приклад: 2.02

bonuses_validityinteger

Приклад: 3

branch_idintegerобов’язковий

Приклад: 8778

special_offer_idinteger

Приклад: 152410

paginationobject (Pagination)

max_countintegerобов’язковий

Кількість елементів на сторінці

Приклад: 30

page_numberintegerобов’язковий

Номер поточноï сторінки; обмежено так, щоб зсув не перевищував 1000

Приклад: 1

has_nextbooleanобов’язковий

Чи є наступна сторінка

Приклад: true

has_previousbooleanобов’язковий

Чи є попередня сторінка

Приклад: false

timezonestring

Приклад: Europe/Kaliningrad

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/special_offers_promo_codes', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'uk', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/special_offers_promo_codes", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/special_offers_promo_codes", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "special_offer_id": { "value": "example", "type": "select", "option": [ { "value": "example", "name": "All" } ], "mode": "value_required" } }, "list": [ { "id": 1, "code": "CODE1933", "count": 2, "count_activations": 0, "date_available": "2024-05-02 08:31:16", "date_expiration": "2024-05-02 08:31:16", "bonuses_sum": 2.02, "bonuses_validity": 3, "branch_id": 8778, "special_offer_id": 152410 } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false }, "timezone": "Europe/Kaliningrad" } }