Ottenere l'elenco delle promozioni

GET/api/crm/v2/special_offers_listv2

operationId: specialOffersList.default

Autorizzazione

api-token + language + role

Parametri della richiesta

branch_idinteger

Filiale in base alla quale viene filtrato l'elenco. Senza questo parametro, la risposta contiene solo i filtri, senza l'elenco. Per il partner con una sola filiale, il server la imposta automaticamente.

Esempio: 8778

page_numberinteger

Esempio: 1

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

listarray of object

idintegerobbligatorio

Esempio: 1

namestringobbligatorio

Esempio: Free delivery

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

operating_modestring (TypeOperatingMode) obbligatorio

Valori:informingpromo_codeinforming_and_promo_codeautomatic_actioninforming_and_automatic_action

Esempio: informing

sortintegerobbligatorio

Esempio: -1714739780

publishedbooleanobbligatorio

Esempio: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

descriptionstring

Esempio: informing description

imagestring

Esempio: https://cdn.foodsoul.test/zones/ru/branches/8810/images/special_offers/medium/ec17cfe9697ff2e301cba7736a5d329b.jpg?v1726243373

branch_idinteger

Esempio: 1

authorized_users_enabledbooleanobbligatorio

Esempio: true

work_with_pay_bonuses_enabledbooleanobbligatorio

Esempio: true

accrual_bonuses_enabledbooleanobbligatorio

Esempio: true

first_purchase_enabledbooleanobbligatorio

Esempio: true

first_purchase_platformstring (Platform)

Valori:androidiosallmobile_appssitesocial_apps

Esempio: all

subcategories_include_in_categories_enabledbooleanobbligatorio

Esempio: true

reuse_enabledbooleanobbligatorio

Esempio: true

delivery_methodstring (DeliveryMethodUpdate) obbligatorio

Valori:allcourierpickup

days_of_weekarray of integer

time_periodsarray of array of string (TimePeriods)

Periodo di tempo

ignore_in_minimum_sum_enabledbooleanobbligatorio

Esempio: true

from_sumnumber

Esempio: 100

to_sumnumber

Esempio: 1000

multiple_sumnumber

Esempio: 100

from_to_sums_for_items_from_conditions_enabledbooleanobbligatorio

Esempio: true

automatic_old_cost_for_items_enabledbooleanobbligatorio

Esempio: true

push_titlestring

Esempio: Free delivery

push_messagestring

Esempio: Free delivery today from 18:00

platformstring (Platform) obbligatorio

Valori:androidiosallmobile_appssitesocial_apps

Esempio: all

typestring (TypeWorkOperatingMode)

Valori: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

Esempio: free_delivery

count_items_for_conditioninteger

Esempio: 10

count_items_for_actioninteger

Esempio: 10

one_item_from_conditions_enabledbooleanobbligatorio

Esempio: true

actions_itemsarray of integer

conditions_itemsarray of integer

actions_categoriesarray of integer

conditions_categoriesarray of integer

discountnumber

Esempio: 10

use_only_one_time_in_cart_enabledbooleanobbligatorio

Esempio: true

use_only_in_birthday_enabledbooleanobbligatorio

Esempio: true

birthday_validity_beforeinteger

Esempio: 10

birthday_validity_afterinteger

Esempio: 10

bonuses_sumnumber

Esempio: 100

bonuses_validitynumber

Esempio: 100

count_activate_offerintegerobbligatorio

Esempio: 0

paginationobject (Pagination)

max_countintegerobbligatorio

Numero di elementi per pagina

Esempio: 30

page_numberintegerobbligatorio

Numero della pagina corrente; limitato in modo che l'offset non superi 1000

Esempio: 1

has_nextbooleanobbligatorio

Esiste una pagina successiva

Esempio: true

has_previousbooleanobbligatorio

C'è una pagina precedente

Esempio: false

timezonestring

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