Sonderangebotsliste abrufen

GET/api/crm/v2/special_offers_listv2

operationId: specialOffersList.default

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Die Filiale, nach der die Liste gefiltert wird. Ohne diesen Parameter enthält die Antwort nur Filter, aber keine Liste. Für Partner mit nur einer Filiale wird diese vom Server automatisch gesetzt.

Beispiel: 8778

page_numberinteger

Beispiel: 1

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

listarray of object

idintegererforderlich

Beispiel: 1

namestringerforderlich

Beispiel: Free delivery

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

operating_modestring (TypeOperatingMode) erforderlich

Werte:informingpromo_codeinforming_and_promo_codeautomatic_actioninforming_and_automatic_action

Beispiel: informing

sortintegererforderlich

Beispiel: -1714739780

publishedbooleanerforderlich

Beispiel: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

descriptionstring

Beispiel: informing description

imagestring

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

branch_idinteger

Beispiel: 1

authorized_users_enabledbooleanerforderlich

Beispiel: true

work_with_pay_bonuses_enabledbooleanerforderlich

Beispiel: true

accrual_bonuses_enabledbooleanerforderlich

Beispiel: true

first_purchase_enabledbooleanerforderlich

Beispiel: true

first_purchase_platformstring (Platform)

Werte:androidiosallmobile_appssitesocial_apps

Beispiel: all

subcategories_include_in_categories_enabledbooleanerforderlich

Beispiel: true

reuse_enabledbooleanerforderlich

Beispiel: true

delivery_methodstring (DeliveryMethodUpdate) erforderlich

Werte:allcourierpickup

days_of_weekarray of integer

time_periodsarray of array of string (TimePeriods)

Zeitraum

ignore_in_minimum_sum_enabledbooleanerforderlich

Beispiel: true

from_sumnumber

Beispiel: 100

to_sumnumber

Beispiel: 1000

multiple_sumnumber

Beispiel: 100

from_to_sums_for_items_from_conditions_enabledbooleanerforderlich

Beispiel: true

automatic_old_cost_for_items_enabledbooleanerforderlich

Beispiel: true

push_titlestring

Beispiel: Free delivery

push_messagestring

Beispiel: Free delivery today from 18:00

platformstring (Platform) erforderlich

Werte:androidiosallmobile_appssitesocial_apps

Beispiel: all

typestring (TypeWorkOperatingMode)

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

Beispiel: free_delivery

count_items_for_conditioninteger

Beispiel: 10

count_items_for_actioninteger

Beispiel: 10

one_item_from_conditions_enabledbooleanerforderlich

Beispiel: true

actions_itemsarray of integer

conditions_itemsarray of integer

actions_categoriesarray of integer

conditions_categoriesarray of integer

discountnumber

Beispiel: 10

use_only_one_time_in_cart_enabledbooleanerforderlich

Beispiel: true

use_only_in_birthday_enabledbooleanerforderlich

Beispiel: true

birthday_validity_beforeinteger

Beispiel: 10

birthday_validity_afterinteger

Beispiel: 10

bonuses_sumnumber

Beispiel: 100

bonuses_validitynumber

Beispiel: 100

count_activate_offerintegererforderlich

Beispiel: 0

paginationobject (Pagination)

max_countintegererforderlich

Anzahl der Elemente pro Seite

Beispiel: 30

page_numberintegererforderlich

Nummer der aktuellen Seite; begrenzt, sodass der Offset 1000 nicht überschreitet

Beispiel: 1

has_nextbooleanerforderlich

Gibt es eine nächste Seite

Beispiel: true

has_previousbooleanerforderlich

Gibt es eine vorherige Seite

Beispiel: false

timezonestring

Beispiel: Europe/Kaliningrad

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/special_offers_list', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'de', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/special_offers_list", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "de", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/special_offers_list", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "de", "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" } }