Получить список промокодов

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' => 'ru', '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": "ru", "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": "ru", "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" } }