სპეციალური კოდების სიის მიღება

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