Obtenir la liste des offres spéciales

GET/api/crm/v2/special_offers_listv2

operationId: specialOffersList.default

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

La succursale selon laquelle la liste est filtrée. Sans ce paramètre, seules les options de filtrage sont renvoyées, sans la liste. Pour un partenaire avec une seule succursale, le serveur la renseigne automatiquement.

Exemple: 8778

page_numberinteger

Exemple: 1

Réponses

object

statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object

valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

listarray of object

idintegerobligatoire

Exemple: 1

namestringobligatoire

Exemple: Free delivery

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

operating_modestring (TypeOperatingMode) obligatoire

Valeurs:informingpromo_codeinforming_and_promo_codeautomatic_actioninforming_and_automatic_action

Exemple: informing

sortintegerobligatoire

Exemple: -1714739780

publishedbooleanobligatoire

Exemple: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

descriptionstring

Exemple: informing description

imagestring

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

branch_idinteger

Exemple: 1

authorized_users_enabledbooleanobligatoire

Exemple: true

work_with_pay_bonuses_enabledbooleanobligatoire

Exemple: true

accrual_bonuses_enabledbooleanobligatoire

Exemple: true

first_purchase_enabledbooleanobligatoire

Exemple: true

first_purchase_platformstring (Platform)

Valeurs:androidiosallmobile_appssitesocial_apps

Exemple: all

subcategories_include_in_categories_enabledbooleanobligatoire

Exemple: true

reuse_enabledbooleanobligatoire

Exemple: true

delivery_methodstring (DeliveryMethodUpdate) obligatoire

Valeurs:allcourierpickup

days_of_weekarray of integer

time_periodsarray of array of string (TimePeriods)

Période de temps

ignore_in_minimum_sum_enabledbooleanobligatoire

Exemple: true

from_sumnumber

Exemple: 100

to_sumnumber

Exemple: 1000

multiple_sumnumber

Exemple: 100

from_to_sums_for_items_from_conditions_enabledbooleanobligatoire

Exemple: true

automatic_old_cost_for_items_enabledbooleanobligatoire

Exemple: true

push_titlestring

Exemple: Free delivery

push_messagestring

Exemple: Free delivery today from 18:00

platformstring (Platform) obligatoire

Valeurs:androidiosallmobile_appssitesocial_apps

Exemple: all

typestring (TypeWorkOperatingMode)

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

Exemple: free_delivery

count_items_for_conditioninteger

Exemple: 10

count_items_for_actioninteger

Exemple: 10

one_item_from_conditions_enabledbooleanobligatoire

Exemple: true

actions_itemsarray of integer

conditions_itemsarray of integer

actions_categoriesarray of integer

conditions_categoriesarray of integer

discountnumber

Exemple: 10

use_only_one_time_in_cart_enabledbooleanobligatoire

Exemple: true

use_only_in_birthday_enabledbooleanobligatoire

Exemple: true

birthday_validity_beforeinteger

Exemple: 10

birthday_validity_afterinteger

Exemple: 10

bonuses_sumnumber

Exemple: 100

bonuses_validitynumber

Exemple: 100

count_activate_offerintegerobligatoire

Exemple: 0

paginationobject (Pagination)

max_countintegerobligatoire

Nombre d'éléments par page

Exemple: 30

page_numberintegerobligatoire

Numéro de la page actuelle ; limité pour que le décalage ne dépasse pas 1000

Exemple: 1

has_nextbooleanobligatoire

Indique s'il existe une page suivante

Exemple: true

has_previousbooleanobligatoire

Y a-t-il une page précédente

Exemple: false

timezonestring

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