Saņemt promo kodu sarakstu

GET/api/crm/v2/special_offers_promo_codesv2

operationId: specialOffersPromoCodes.default

Autorizācija

api-token + language + role

Vaicājuma parametri

branch_idinteger

Filiale, pēc kuras tiek filtrēts saraksts. Bez tās atbildē būs tikai filtri, bez saraksta. Partnerim ar vienu filiāli serveris to iestata automātiski.

Piemērs: 8778

special_offer_idinteger

Piemērs: 1

page_numberinteger

Piemērs: 1

Atbildes

object

statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

special_offer_idobject (FilterSelect)

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of object

valuestringobligāts

Piemērs: example

namestringobligāts

Piemērs: All

modestring (FilterMode)

Vērtības:force_shownvalue_required

Piemērs: value_required

listarray of object

idintegerobligāts

Piemērs: 1

codestringobligāts

Piemērs: CODE1933

countinteger

Piemērs: 2

count_activationsintegerobligāts

Piemērs: 0

date_availablestring (DataTimeFormatSQL)

Piemērs: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Piemērs: 2024-05-02 08:31:16

bonuses_sumnumber

Piemērs: 2.02

bonuses_validityinteger

Piemērs: 3

branch_idintegerobligāts

Piemērs: 8778

special_offer_idinteger

Piemērs: 152410

paginationobject (Pagination)

max_countintegerobligāts

Elementu skaits lapā

Piemērs: 30

page_numberintegerobligāts

Pašreizējās lapas numurs; ierobežots tā, lai nobīde nepārsniegtu 1000

Piemērs: 1

has_nextbooleanobligāts

Vai ir nākamā lapa

Piemērs: true

has_previousbooleanobligāts

Vai ir iepriekšējā lapa

Piemērs: false

timezonestring

Piemērs: 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' => 'lv', '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": "lv", "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": "lv", "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" } }