Ստանալ ակցիաների ցանկը

GET/api/crm/v2/special_offers_listv2

operationId: specialOffersList.default

Հավաստագրում

api-token + language + role

Հարցման պարամետրեր

branch_idinteger

Մասնաճյուղը, ըստ որի ֆիլտրացվում է ցուցակը։ Առանց դրա պատասխանն ունի միայն ֆիլտրեր, առանց ցուցակի։ Միայն մեկ մասնաճյուղ ունեցող գործընկերոջ համար սերվերը ինքն է ավելացնում այն։.

Օրինակ: 8778

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

listarray of object

idintegerպարտադիր

Օրինակ: 1

namestringպարտադիր

Օրինակ: Free delivery

date_availablestring (DataTimeFormatSQL)

Օրինակ: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Օրինակ: 2024-05-02 08:31:16

operating_modestring (TypeOperatingMode) պարտադիր

Արժեքներ:informingpromo_codeinforming_and_promo_codeautomatic_actioninforming_and_automatic_action

Օրինակ: informing

sortintegerպարտադիր

Օրինակ: -1714739780

publishedbooleanպարտադիր

Օրինակ: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

descriptionstring

Օրինակ: informing description

imagestring

Օրինակ: https://cdn.foodsoul.test/zones/ru/branches/8810/images/special_offers/medium/ec17cfe9697ff2e301cba7736a5d329b.jpg?v1726243373

branch_idinteger

Օրինակ: 1

authorized_users_enabledbooleanպարտադիր

Օրինակ: true

work_with_pay_bonuses_enabledbooleanպարտադիր

Օրինակ: true

accrual_bonuses_enabledbooleanպարտադիր

Օրինակ: true

first_purchase_enabledbooleanպարտադիր

Օրինակ: true

first_purchase_platformstring (Platform)

Արժեքներ:androidiosallmobile_appssitesocial_apps

Օրինակ: all

subcategories_include_in_categories_enabledbooleanպարտադիր

Օրինակ: true

reuse_enabledbooleanպարտադիր

Օրինակ: true

delivery_methodstring (DeliveryMethodUpdate) պարտադիր

Արժեքներ:allcourierpickup

days_of_weekarray of integer

time_periodsarray of array of string (TimePeriods)

Ժամանակահատված

ignore_in_minimum_sum_enabledbooleanպարտադիր

Օրինակ: true

from_sumnumber

Օրինակ: 100

to_sumnumber

Օրինակ: 1000

multiple_sumnumber

Օրինակ: 100

from_to_sums_for_items_from_conditions_enabledbooleanպարտադիր

Օրինակ: true

automatic_old_cost_for_items_enabledbooleanպարտադիր

Օրինակ: true

push_titlestring

Օրինակ: Free delivery

push_messagestring

Օրինակ: Free delivery today from 18:00

platformstring (Platform) պարտադիր

Արժեքներ:androidiosallmobile_appssitesocial_apps

Օրինակ: all

typestring (TypeWorkOperatingMode)

Արժեքներ:fixed_discount_on_all_orderpercent_discount_on_all_orderfixed_discount_on_items_from_categoriespercent_discount_on_items_from_categoriesfixed_discount_on_itemspercent_discount_on_itemsfree_item_to_choose_if_buy_itemsfree_item_to_choose_if_buy_items_from_categoriesfixed_discount_on_next_itempercent_discount_on_next_itemfixed_discount_on_next_item_from_categoriespercent_discount_on_next_item_from_categoriesfree_item_to_choosepercent_discount_on_item_with_minimum_cost_in_cartfixed_discount_on_item_with_minimum_cost_in_cartpercent_discount_on_item_with_minimum_cost_from_itemsfixed_discount_on_item_with_minimum_cost_from_itemspercent_discount_on_item_with_minimum_cost_from_categoriesfixed_discount_on_item_with_minimum_cost_from_categoriesbonusesfree_delivery

Օրինակ: free_delivery

count_items_for_conditioninteger

Օրինակ: 10

count_items_for_actioninteger

Օրինակ: 10

one_item_from_conditions_enabledbooleanպարտադիր

Օրինակ: true

actions_itemsarray of integer

conditions_itemsarray of integer

actions_categoriesarray of integer

conditions_categoriesarray of integer

discountnumber

Օրինակ: 10

use_only_one_time_in_cart_enabledbooleanպարտադիր

Օրինակ: true

use_only_in_birthday_enabledbooleanպարտադիր

Օրինակ: true

birthday_validity_beforeinteger

Օրինակ: 10

birthday_validity_afterinteger

Օրինակ: 10

bonuses_sumnumber

Օրինակ: 100

bonuses_validitynumber

Օրինակ: 100

count_activate_offerintegerպարտադիր

Օրինակ: 0

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_list', [ '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_list", { 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_list", 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" } }, "list": [ { "id": 1, "name": "Free delivery", "date_available": "2024-05-02 08:31:16", "date_expiration": "2024-05-02 08:31:16", "operating_mode": "informing", "sort": -1714739780, "published": true, "hide_for_districts_ids": [ 1 ], "hide_for_pickups_ids": [ 1 ], "description": "informing description", "image": "https://cdn.foodsoul.test/zones/ru/branches/8810/images/special_offers/medium/ec17cfe9697ff2e301cba7736a5d329b.jpg?v1726243373", "branch_id": 1, "authorized_users_enabled": true, "work_with_pay_bonuses_enabled": true, "accrual_bonuses_enabled": true, "first_purchase_enabled": true, "first_purchase_platform": "all", "subcategories_include_in_categories_enabled": true, "reuse_enabled": true, "delivery_method": "all", "days_of_week": [ 6, 7 ], "time_periods": [ [ "13:12 - 13:15" ] ], "ignore_in_minimum_sum_enabled": true, "from_sum": 100, "to_sum": 1000, "multiple_sum": 100, "from_to_sums_for_items_from_conditions_enabled": true, "automatic_old_cost_for_items_enabled": true, "push_title": "Free delivery", "push_message": "Free delivery today from 18:00", "platform": "all", "type": "free_delivery", "count_items_for_condition": 10, "count_items_for_action": 10, "one_item_from_conditions_enabled": true, "actions_items": [ 94061047 ], "conditions_items": [ 94061047 ], "actions_categories": [ 3387030 ], "conditions_categories": [ 3387030 ], "discount": 10, "use_only_one_time_in_cart_enabled": true, "use_only_in_birthday_enabled": true, "birthday_validity_before": 10, "birthday_validity_after": 10, "bonuses_sum": 100, "bonuses_validity": 100, "count_activate_offer": 0 } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false }, "timezone": "Europe/Kaliningrad" } }