API

Get special offers list

GET/api/crm/v2/special_offers_listv2
operationId: specialOffersList.default

Authorization

api-token + language + role

Query parameters

branch_idinteger

Branch to filter the list by. Without it, only filters are returned, without the list. For partners with a single branch, the server sets it automatically.

Example: 8778

page_numberinteger

Example: 1

Responses

OK

object
statusstringrequired

Values:successerror

Example: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object
valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

listarray of object
idintegerrequired

Example: 1

namestringrequired

Example: Free delivery

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

operating_modestring (TypeOperatingMode) required

Values:informingpromo_codeinforming_and_promo_codeautomatic_actioninforming_and_automatic_action

Example: informing

sortintegerrequired

Example: -1714739780

publishedbooleanrequired

Example: true

hide_for_districts_idsarray of integer
hide_for_pickups_idsarray of integer
descriptionstring

Example: informing description

imagestring

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

branch_idinteger

Example: 1

authorized_users_enabledbooleanrequired

Example: true

work_with_pay_bonuses_enabledbooleanrequired

Example: true

accrual_bonuses_enabledbooleanrequired

Example: true

first_purchase_enabledbooleanrequired

Example: true

first_purchase_platformstring (Platform)

Values:androidiosallmobile_appssitesocial_apps

Example: all

subcategories_include_in_categories_enabledbooleanrequired

Example: true

reuse_enabledbooleanrequired

Example: true

delivery_methodstring (DeliveryMethodUpdate) required

Values:allcourierpickup

days_of_weekarray of integer
time_periodsarray of array of string (TimePeriods)

Time period

ignore_in_minimum_sum_enabledbooleanrequired

Example: true

from_sumnumber

Example: 100

to_sumnumber

Example: 1000

multiple_sumnumber

Example: 100

from_to_sums_for_items_from_conditions_enabledbooleanrequired

Example: true

automatic_old_cost_for_items_enabledbooleanrequired

Example: true

push_titlestring

Example: Free delivery

push_messagestring

Example: Free delivery today from 18:00

platformstring (Platform) required

Values:androidiosallmobile_appssitesocial_apps

Example: all

typestring (TypeWorkOperatingMode)

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

Example: free_delivery

count_items_for_conditioninteger

Example: 10

count_items_for_actioninteger

Example: 10

one_item_from_conditions_enabledbooleanrequired

Example: true

actions_itemsarray of integer
conditions_itemsarray of integer
actions_categoriesarray of integer
conditions_categoriesarray of integer
discountnumber

Example: 10

use_only_one_time_in_cart_enabledbooleanrequired

Example: true

use_only_in_birthday_enabledbooleanrequired

Example: true

birthday_validity_beforeinteger

Example: 10

birthday_validity_afterinteger

Example: 10

bonuses_sumnumber

Example: 100

bonuses_validitynumber

Example: 100

count_activate_offerintegerrequired

Example: 0

paginationobject (Pagination)
max_countintegerrequired

Number of items per page

Example: 30

page_numberintegerrequired

Current page number; limited so that the offset does not exceed 1000

Example: 1

has_nextbooleanrequired

Is there a next page

Example: true

has_previousbooleanrequired

Is there a previous page

Example: false

timezonestring

Example: Europe/Kaliningrad