Promokodların siyahısını əldə et

GET/api/crm/v2/special_offers_promo_codesv2

operationId: specialOffersPromoCodes.default

Avtorizasiya

api-token + language + role

Sorğu parametrləri

branch_idinteger

Filial üzrə siyahının filtrasiyası üçün istifadə olunur. Olmadıqda, cavabda yalnız filtrlər qaytarılır, siyahı olmur. Bir filialı olan partnyor üçün server onu avtomatik təyin edir.

Nümunə: 8778

special_offer_idinteger

Nümunə: 1

page_numberinteger

Nümunə: 1

Cavablar

object

statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object

valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

special_offer_idobject (FilterSelect)

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of object

valuestringmütləq

Nümunə: example

namestringmütləq

Nümunə: All

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

listarray of object

idintegermütləq

Nümunə: 1

codestringmütləq

Nümunə: CODE1933

countinteger

Nümunə: 2

count_activationsintegermütləq

Nümunə: 0

date_availablestring (DataTimeFormatSQL)

Nümunə: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Nümunə: 2024-05-02 08:31:16

bonuses_sumnumber

Nümunə: 2.02

bonuses_validityinteger

Nümunə: 3

branch_idintegermütləq

Nümunə: 8778

special_offer_idinteger

Nümunə: 152410

paginationobject (Pagination)

max_countintegermütləq

Səhifədəki elementlərin sayı

Nümunə: 30

page_numberintegermütləq

Cari səhifənin nömrəsi; offset 1000-dən çox olmamaqla məhdudlaşdırılıb

Nümunə: 1

has_nextbooleanmütləq

Növbəti səhifə varmı

Nümunə: true

has_previousbooleanmütləq

Əvvəlki səhifə mövcuddurmu

Nümunə: false

timezonestring

Nümunə: 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' => 'az', '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": "az", "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": "az", "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" } }