Промокодтар тізімін алу

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.ru/api/crm/v2/special_offers_promo_codes', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'kk', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

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

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/special_offers_promo_codes", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "kk", "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" } }