Ստանալ պրոմոկոդների ցանկը

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.pro/api/crm/v2/special_offers_promo_codes', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'hy', '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": "hy", "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": "hy", "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" } }