Liste der Promo-Codes abrufen

GET/api/crm/v2/special_offers_promo_codesv2

operationId: specialOffersPromoCodes.default

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Die Filiale, nach der die Liste gefiltert wird. Ohne diesen Parameter enthält die Antwort nur Filter, aber keine Liste. Für Partner mit nur einer Filiale wird diese vom Server automatisch gesetzt.

Beispiel: 8778

special_offer_idinteger

Beispiel: 1

page_numberinteger

Beispiel: 1

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

special_offer_idobject (FilterSelect)

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of object

valuestringerforderlich

Beispiel: example

namestringerforderlich

Beispiel: All

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

listarray of object

idintegererforderlich

Beispiel: 1

codestringerforderlich

Beispiel: CODE1933

countinteger

Beispiel: 2

count_activationsintegererforderlich

Beispiel: 0

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

bonuses_sumnumber

Beispiel: 2.02

bonuses_validityinteger

Beispiel: 3

branch_idintegererforderlich

Beispiel: 8778

special_offer_idinteger

Beispiel: 152410

paginationobject (Pagination)

max_countintegererforderlich

Anzahl der Elemente pro Seite

Beispiel: 30

page_numberintegererforderlich

Nummer der aktuellen Seite; begrenzt, sodass der Offset 1000 nicht überschreitet

Beispiel: 1

has_nextbooleanerforderlich

Gibt es eine nächste Seite

Beispiel: true

has_previousbooleanerforderlich

Gibt es eine vorherige Seite

Beispiel: false

timezonestring

Beispiel: 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' => 'de', '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": "de", "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": "de", "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" } }