Hangi promokoodide loendi

GET/api/crm/v2/special_offers_promo_codesv2

operationId: specialOffersPromoCodes.default

Autoriseerimine

api-token + language + role

Päringu parameetrid

branch_idinteger

Filiaal, mille alusel nimekirja filtreeritakse. Ilma selleta sisaldab vastus ainult filtreid, ilma nimekirjata. Partnerile, kellel on ainult üks filiaal, määrab server selle automaatselt.

Näide: 8778

special_offer_idinteger

Näide: 1

page_numberinteger

Näide: 1

Vastused

object

statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

special_offer_idobject (FilterSelect)

valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of object

valuestringkohustuslik

Näide: example

namestringkohustuslik

Näide: All

modestring (FilterMode)

Väärtused:force_shownvalue_required

Näide: value_required

listarray of object

idintegerkohustuslik

Näide: 1

codestringkohustuslik

Näide: CODE1933

countinteger

Näide: 2

count_activationsintegerkohustuslik

Näide: 0

date_availablestring (DataTimeFormatSQL)

Näide: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Näide: 2024-05-02 08:31:16

bonuses_sumnumber

Näide: 2.02

bonuses_validityinteger

Näide: 3

branch_idintegerkohustuslik

Näide: 8778

special_offer_idinteger

Näide: 152410

paginationobject (Pagination)

max_countintegerkohustuslik

Elementide arv lehel

Näide: 30

page_numberintegerkohustuslik

Praeguse lehekülje number; piiratud nii, et nihe ei ületaks 1000

Näide: 1

has_nextbooleankohustuslik

Kas on järgmine lehekülg

Näide: true

has_previousbooleankohustuslik

Kas eelmine lehekülg on olemas

Näide: false

timezonestring

Näide: 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' => 'et', '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": "et", "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": "et", "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" } }