Pobierz listę kodów promocyjnych

GET/api/crm/v2/special_offers_promo_codesv2

operationId: specialOffersPromoCodes.default

Autoryzacja

api-token + language + role

Parametry zapytania

branch_idinteger

Filia, według której filtrowana jest lista. Bez niej w odpowiedzi znajdują się tylko filtry, bez listy. Partnerowi z jedną filią serwer podstawia ją automatycznie.

Przykład: 8778

special_offer_idinteger

Przykład: 1

page_numberinteger

Przykład: 1

Odpowiedzi

object

statusstringwymagane

Wartości:successerror

Przykład: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

special_offer_idobject (FilterSelect)

valuestring

Przykład: example

typestringwymagane

Przykład: select

optionarray of object

valuestringwymagane

Przykład: example

namestringwymagane

Przykład: All

modestring (FilterMode)

Wartości:force_shownvalue_required

Przykład: value_required

listarray of object

idintegerwymagane

Przykład: 1

codestringwymagane

Przykład: CODE1933

countinteger

Przykład: 2

count_activationsintegerwymagane

Przykład: 0

date_availablestring (DataTimeFormatSQL)

Przykład: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Przykład: 2024-05-02 08:31:16

bonuses_sumnumber

Przykład: 2.02

bonuses_validityinteger

Przykład: 3

branch_idintegerwymagane

Przykład: 8778

special_offer_idinteger

Przykład: 152410

paginationobject (Pagination)

max_countintegerwymagane

Liczba elementów na stronie

Przykład: 30

page_numberintegerwymagane

Numer bieżącej strony; ograniczony tak, aby przesunięcie nie przekraczało 1000

Przykład: 1

has_nextbooleanwymagane

Czy istnieje następna strona

Przykład: true

has_previousbooleanwymagane

Czy istnieje poprzednia strona

Przykład: false

timezonestring

Przykład: 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' => 'pl', '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": "pl", "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": "pl", "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" } }