Ottenere l'elenco dei codici promozionali

GET/api/crm/v2/special_offers_promo_codesv2

operationId: specialOffersPromoCodes.default

Autorizzazione

api-token + language + role

Parametri della richiesta

branch_idinteger

Filiale in base alla quale viene filtrato l'elenco. Senza questo parametro, la risposta contiene solo i filtri, senza l'elenco. Per il partner con una sola filiale, il server la imposta automaticamente.

Esempio: 8778

special_offer_idinteger

Esempio: 1

page_numberinteger

Esempio: 1

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

special_offer_idobject (FilterSelect)

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of object

valuestringobbligatorio

Esempio: example

namestringobbligatorio

Esempio: All

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

listarray of object

idintegerobbligatorio

Esempio: 1

codestringobbligatorio

Esempio: CODE1933

countinteger

Esempio: 2

count_activationsintegerobbligatorio

Esempio: 0

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

bonuses_sumnumber

Esempio: 2.02

bonuses_validityinteger

Esempio: 3

branch_idintegerobbligatorio

Esempio: 8778

special_offer_idinteger

Esempio: 152410

paginationobject (Pagination)

max_countintegerobbligatorio

Numero di elementi per pagina

Esempio: 30

page_numberintegerobbligatorio

Numero della pagina corrente; limitato in modo che l'offset non superi 1000

Esempio: 1

has_nextbooleanobbligatorio

Esiste una pagina successiva

Esempio: true

has_previousbooleanobbligatorio

C'è una pagina precedente

Esempio: false

timezonestring

Esempio: 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' => 'it', '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": "it", "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": "it", "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" } }