Obter a lista de promoções

GET/api/crm/v2/special_offers_listv2

operationId: specialOffersList.default

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Filial pelo qual a lista é filtrada. Sem ele, a resposta contém apenas os filtros, sem a lista. Para parceiros com um único filial, o servidor o define automaticamente.

Exemplo: 8778

page_numberinteger

Exemplo: 1

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

listarray of object

idintegerobrigatório

Exemplo: 1

namestringobrigatório

Exemplo: Free delivery

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

operating_modestring (TypeOperatingMode) obrigatório

Valores:informingpromo_codeinforming_and_promo_codeautomatic_actioninforming_and_automatic_action

Exemplo: informing

sortintegerobrigatório

Exemplo: -1714739780

publishedbooleanobrigatório

Exemplo: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

descriptionstring

Exemplo: informing description

imagestring

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

branch_idinteger

Exemplo: 1

authorized_users_enabledbooleanobrigatório

Exemplo: true

work_with_pay_bonuses_enabledbooleanobrigatório

Exemplo: true

accrual_bonuses_enabledbooleanobrigatório

Exemplo: true

first_purchase_enabledbooleanobrigatório

Exemplo: true

first_purchase_platformstring (Platform)

Valores:androidiosallmobile_appssitesocial_apps

Exemplo: all

subcategories_include_in_categories_enabledbooleanobrigatório

Exemplo: true

reuse_enabledbooleanobrigatório

Exemplo: true

delivery_methodstring (DeliveryMethodUpdate) obrigatório

Valores:allcourierpickup

days_of_weekarray of integer

time_periodsarray of array of string (TimePeriods)

Período de tempo

ignore_in_minimum_sum_enabledbooleanobrigatório

Exemplo: true

from_sumnumber

Exemplo: 100

to_sumnumber

Exemplo: 1000

multiple_sumnumber

Exemplo: 100

from_to_sums_for_items_from_conditions_enabledbooleanobrigatório

Exemplo: true

automatic_old_cost_for_items_enabledbooleanobrigatório

Exemplo: true

push_titlestring

Exemplo: Free delivery

push_messagestring

Exemplo: Free delivery today from 18:00

platformstring (Platform) obrigatório

Valores:androidiosallmobile_appssitesocial_apps

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

Exemplo: free_delivery

count_items_for_conditioninteger

Exemplo: 10

count_items_for_actioninteger

Exemplo: 10

one_item_from_conditions_enabledbooleanobrigatório

Exemplo: true

actions_itemsarray of integer

conditions_itemsarray of integer

actions_categoriesarray of integer

conditions_categoriesarray of integer

discountnumber

Exemplo: 10

use_only_one_time_in_cart_enabledbooleanobrigatório

Exemplo: true

use_only_in_birthday_enabledbooleanobrigatório

Exemplo: true

birthday_validity_beforeinteger

Exemplo: 10

birthday_validity_afterinteger

Exemplo: 10

bonuses_sumnumber

Exemplo: 100

bonuses_validitynumber

Exemplo: 100

count_activate_offerintegerobrigatório

Exemplo: 0

paginationobject (Pagination)

max_countintegerobrigatório

Número de itens por página

Exemplo: 30

page_numberintegerobrigatório

Número da página atual; limitado para que o deslocamento não exceda 1000

Exemplo: 1

has_nextbooleanobrigatório

Existe uma próxima página

Exemplo: true

has_previousbooleanobrigatório

Existe uma página anterior

Exemplo: false

timezonestring

Exemplo: 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' => 'pt', '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": "pt", "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": "pt", "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" } }