Obtener la lista de promociones

GET/api/crm/v2/special_offers_listv2

operationId: specialOffersList.default

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Sucursal por la que se filtra la lista. Sin este parámetro, la respuesta solo contiene los filtros, sin la lista. Para un socio con una sola sucursal, el servidor la asigna automáticamente.

Ejemplo: 8778

page_numberinteger

Ejemplo: 1

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

listarray of object

idintegerobligatorio

Ejemplo: 1

namestringobligatorio

Ejemplo: Free delivery

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

operating_modestring (TypeOperatingMode) obligatorio

Valores:informingpromo_codeinforming_and_promo_codeautomatic_actioninforming_and_automatic_action

Ejemplo: informing

sortintegerobligatorio

Ejemplo: -1714739780

publishedbooleanobligatorio

Ejemplo: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

descriptionstring

Ejemplo: informing description

imagestring

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

branch_idinteger

Ejemplo: 1

authorized_users_enabledbooleanobligatorio

Ejemplo: true

work_with_pay_bonuses_enabledbooleanobligatorio

Ejemplo: true

accrual_bonuses_enabledbooleanobligatorio

Ejemplo: true

first_purchase_enabledbooleanobligatorio

Ejemplo: true

first_purchase_platformstring (Platform)

Valores:androidiosallmobile_appssitesocial_apps

Ejemplo: all

subcategories_include_in_categories_enabledbooleanobligatorio

Ejemplo: true

reuse_enabledbooleanobligatorio

Ejemplo: true

delivery_methodstring (DeliveryMethodUpdate) obligatorio

Valores:allcourierpickup

days_of_weekarray of integer

time_periodsarray of array of string (TimePeriods)

Período de tiempo

ignore_in_minimum_sum_enabledbooleanobligatorio

Ejemplo: true

from_sumnumber

Ejemplo: 100

to_sumnumber

Ejemplo: 1000

multiple_sumnumber

Ejemplo: 100

from_to_sums_for_items_from_conditions_enabledbooleanobligatorio

Ejemplo: true

automatic_old_cost_for_items_enabledbooleanobligatorio

Ejemplo: true

push_titlestring

Ejemplo: Free delivery

push_messagestring

Ejemplo: Free delivery today from 18:00

platformstring (Platform) obligatorio

Valores:androidiosallmobile_appssitesocial_apps

Ejemplo: all

typestring (TypeWorkOperatingMode)

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

Ejemplo: free_delivery

count_items_for_conditioninteger

Ejemplo: 10

count_items_for_actioninteger

Ejemplo: 10

one_item_from_conditions_enabledbooleanobligatorio

Ejemplo: true

actions_itemsarray of integer

conditions_itemsarray of integer

actions_categoriesarray of integer

conditions_categoriesarray of integer

discountnumber

Ejemplo: 10

use_only_one_time_in_cart_enabledbooleanobligatorio

Ejemplo: true

use_only_in_birthday_enabledbooleanobligatorio

Ejemplo: true

birthday_validity_beforeinteger

Ejemplo: 10

birthday_validity_afterinteger

Ejemplo: 10

bonuses_sumnumber

Ejemplo: 100

bonuses_validitynumber

Ejemplo: 100

count_activate_offerintegerobligatorio

Ejemplo: 0

paginationobject (Pagination)

max_countintegerobligatorio

Cantidad de elementos por página

Ejemplo: 30

page_numberintegerobligatorio

Número de la página actual; limitado para que el desplazamiento no supere 1000

Ejemplo: 1

has_nextbooleanobligatorio

¿Hay una página siguiente?

Ejemplo: true

has_previousbooleanobligatorio

¿Hay una página anterior?

Ejemplo: false

timezonestring

Ejemplo: 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' => 'es', '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": "es", "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": "es", "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" } }