Λήψη λίστας προωθητικών κωδικών

GET/api/crm/v2/special_offers_promo_codesv2

operationId: specialOffersPromoCodes.default

Εξουσιοδότηση

api-token + language + role

Παράμετροι ερωτήματος

branch_idinteger

Το υποκατάστημα με βάση το οποίο φιλτράρεται η λίστα. Χωρίς αυτό, η απάντηση περιέχει μόνο τα φίλτρα, χωρίς τη λίστα. Για συνεργάτη με ένα μόνο υποκατάστημα, ο διακομιστής το ορίζει αυτόματα.

Παράδειγμα: 8778

special_offer_idinteger

Παράδειγμα: 1

page_numberinteger

Παράδειγμα: 1

Απαντήσεις

object

statusstringυποχρεωτικό

Τιμές:successerror

Παράδειγμα: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Παράδειγμα: 8920

typestringυποχρεωτικό

Παράδειγμα: select

optionarray of object

valueintegerυποχρεωτικό

Παράδειγμα: 8920

namestringυποχρεωτικό

Παράδειγμα: Green Basket | Kaliningrad

modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

special_offer_idobject (FilterSelect)

valuestring

Παράδειγμα: example

typestringυποχρεωτικό

Παράδειγμα: select

optionarray of object

valuestringυποχρεωτικό

Παράδειγμα: example

namestringυποχρεωτικό

Παράδειγμα: All

modestring (FilterMode)

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

listarray of object

idintegerυποχρεωτικό

Παράδειγμα: 1

codestringυποχρεωτικό

Παράδειγμα: CODE1933

countinteger

Παράδειγμα: 2

count_activationsintegerυποχρεωτικό

Παράδειγμα: 0

date_availablestring (DataTimeFormatSQL)

Παράδειγμα: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Παράδειγμα: 2024-05-02 08:31:16

bonuses_sumnumber

Παράδειγμα: 2.02

bonuses_validityinteger

Παράδειγμα: 3

branch_idintegerυποχρεωτικό

Παράδειγμα: 8778

special_offer_idinteger

Παράδειγμα: 152410

paginationobject (Pagination)

max_countintegerυποχρεωτικό

Αριθμός στοιχείων ανά σελίδα

Παράδειγμα: 30

page_numberintegerυποχρεωτικό

Αριθμός τρέχουσας σελίδας· περιορίζεται ώστε η μετατόπιση να μην υπερβαίνει το 1000

Παράδειγμα: 1

has_nextbooleanυποχρεωτικό

Υπάρχει επόμενη σελίδα

Παράδειγμα: true

has_previousbooleanυποχρεωτικό

Υπάρχει προηγούμενη σελίδα

Παράδειγμα: false

timezonestring

Παράδειγμα: 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' => 'el', '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": "el", "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": "el", "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" } }