Promosyon kodlarının listesini al

GET/api/crm/v2/special_offers_promo_codesv2

operationId: specialOffersPromoCodes.default

Yetkilendirme

api-token + language + role

Sorgu parametreleri

branch_idinteger

Filtrelenen şube. Olmazsa, yanıtta yalnızca filtreler olur, liste olmaz. Tek şubesi olan iş ortağı için sunucu bunu otomatik olarak ekler.

Örnek: 8778

special_offer_idinteger

Örnek: 1

page_numberinteger

Örnek: 1

Yanıtlar

object

statusstringzorunlu

Değerler:successerror

Örnek: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

special_offer_idobject (FilterSelect)

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of object

valuestringzorunlu

Örnek: example

namestringzorunlu

Örnek: All

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

listarray of object

idintegerzorunlu

Örnek: 1

codestringzorunlu

Örnek: CODE1933

countinteger

Örnek: 2

count_activationsintegerzorunlu

Örnek: 0

date_availablestring (DataTimeFormatSQL)

Örnek: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Örnek: 2024-05-02 08:31:16

bonuses_sumnumber

Örnek: 2.02

bonuses_validityinteger

Örnek: 3

branch_idintegerzorunlu

Örnek: 8778

special_offer_idinteger

Örnek: 152410

paginationobject (Pagination)

max_countintegerzorunlu

Sayfadaki öğe sayısı

Örnek: 30

page_numberintegerzorunlu

Geçerli sayfa numarası; offset 1000'ü aşmayacak şekilde sınırlandırılmıştır

Örnek: 1

has_nextbooleanzorunlu

Sonraki sayfa var mı

Örnek: true

has_previousbooleanzorunlu

Önceki sayfa var mı

Örnek: false

timezonestring

Örnek: 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' => 'tr', '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": "tr", "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": "tr", "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" } }