Obține lista codurilor promoționale

GET/api/crm/v2/special_offers_promo_codesv2

operationId: specialOffersPromoCodes.default

Autorizare

api-token + language + role

Parametri de interogare

branch_idinteger

Filiala după care se filtrează lista. Fără acest parametru, răspunsul conține doar filtrele, fără listă. Pentru partenerii cu o singură filială, serverul o setează automat.

Exemplu: 8778

special_offer_idinteger

Exemplu: 1

page_numberinteger

Exemplu: 1

Răspunsuri

object

statusstringobligatoriu

Valori:successerror

Exemplu: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object

valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

special_offer_idobject (FilterSelect)

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of object

valuestringobligatoriu

Exemplu: example

namestringobligatoriu

Exemplu: All

modestring (FilterMode)

Valori:force_shownvalue_required

Exemplu: value_required

listarray of object

idintegerobligatoriu

Exemplu: 1

codestringobligatoriu

Exemplu: CODE1933

countinteger

Exemplu: 2

count_activationsintegerobligatoriu

Exemplu: 0

date_availablestring (DataTimeFormatSQL)

Exemplu: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Exemplu: 2024-05-02 08:31:16

bonuses_sumnumber

Exemplu: 2.02

bonuses_validityinteger

Exemplu: 3

branch_idintegerobligatoriu

Exemplu: 8778

special_offer_idinteger

Exemplu: 152410

paginationobject (Pagination)

max_countintegerobligatoriu

Numărul de elemente pe pagină

Exemplu: 30

page_numberintegerobligatoriu

Numărul paginii curente; limitat astfel încât offset-ul să nu depășească 1000

Exemplu: 1

has_nextbooleanobligatoriu

Există o pagină următoare

Exemplu: true

has_previousbooleanobligatoriu

Există o pagină anterioară

Exemplu: false

timezonestring

Exemplu: 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' => 'ro', '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": "ro", "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": "ro", "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" } }