API

Créer une offre spéciale

POST/api/crm/v2/special_offers_list.addv2
operationId: specialOffersList.add

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

La succursale dans laquelle la requête est effectuée. Un partenaire disposant de plusieurs succursales doit obligatoirement la transmettre, sinon la requête échoue. Pour un partenaire avec une seule succursale, le serveur la renseigne automatiquement.

Exemple: 8778

Corps de la requête multipart/form-data

object

Les règles de fonctionnement sont masquées lorsque operating_mode = informing

namestringobligatoire

Exemple: Free delivery

operating_modestring (TypeOperatingMode) obligatoire

Valeurs:informingpromo_codeinforming_and_promo_codeautomatic_actioninforming_and_automatic_action

Exemple: informing

platformstring (Platform) obligatoire

Valeurs:androidiosallmobile_appssitesocial_apps

Exemple: all

descriptionstring

Affiché et obligatoire pour operating_mode : informing, informing_and_promo_code, informing_and_automatic_action

Exemple: informing description

imageobject (ImageSource)

Affiché et obligatoire pour operating_mode: informing, informing_and_promo_code, informing_and_automatic_action

binarystring · binary
cropobject

Coordonnées de découpe de l'image

offsetsobject
xintegerobligatoire

Exemple: 100

yintegerobligatoire

Exemple: 50

sizesobject
widthintegerobligatoire

Exemple: 800

heightintegerobligatoire

Exemple: 600

push_titlestring

Affiché lorsque operating_mode : informing, informing_and_promo_code, informing_and_automatic_action

Exemple: the push title

push_messagestring

Affiché lorsque operating_mode : informing, informing_and_promo_code, informing_and_automatic_action

Exemple: the push message

date_availablestring (DataTimeFormat)

Exemple: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Exemple: 17:45 06/05/2024

days_of_weekarray of integer (DaysWeek)

Jours de la semaine

time_periodsarray of array of string (TimePeriods)

Période de temps

hide_for_districts_idsarray of integer
hide_for_pickups_idsarray of integer
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

subcategories_include_in_categories_enabledboolean

Affiché lorsque type : fixed_discount_on_items_from_categories, percent_discount_on_items_from_categories, free_item_to_choose_if_buy_items_from_categories, percent_discount_on_next_item_from_categories, fixed_discount_on_next_item_from_categories, percent_discount_on_item_with_minimum_cost_from_categories, fixed_discount_on_item_with_minimum_cost_from_categories

Exemple: true

authorized_users_enabledboolean

Affiché pour type : free_item_to_choose_if_buy_items, free_item_to_choose_if_buy_items_from_categories, free_item_to_choose, free_delivery, fixed_discount_on_all_order, percent_discount_on_all_order, fixed_discount_on_items, percent_discount_on_items, fixed_discount_on_items_from_categories, percent_discount_on_items_from_categories, fixed_discount_on_next_item, percent_discount_on_next_item, fixed_discount_on_next_item_from_categories, percent_discount_on_next_item_from_categories, percent_discount_on_item_with_minimum_cost_in_cart, fixed_discount_on_item_with_minimum_cost_in_cart, percent_discount_on_item_with_minimum_cost_from_items, fixed_discount_on_item_with_minimum_cost_from_items, percent_discount_on_item_with_minimum_cost_from_categories, fixed_discount_on_item_with_minimum_cost_from_categories

Exemple: true

work_with_pay_bonuses_enabledboolean

Affiché lorsque type : free_item_to_choose_if_buy_items, free_item_to_choose_if_buy_items_from_categories, free_item_to_choose, free_delivery, fixed_discount_on_all_order, percent_discount_on_all_order, fixed_discount_on_items, percent_discount_on_items, fixed_discount_on_items_from_categories, percent_discount_on_items_from_categories, fixed_discount_on_next_item, percent_discount_on_next_item, fixed_discount_on_next_item_from_categories, percent_discount_on_next_item_from_categories, percent_discount_on_item_with_minimum_cost_in_cart, fixed_discount_on_item_with_minimum_cost_in_cart, percent_discount_on_item_with_minimum_cost_from_items, fixed_discount_on_item_with_minimum_cost_from_items, percent_discount_on_item_with_minimum_cost_from_categories, fixed_discount_on_item_with_minimum_cost_from_categories

Exemple: true

accrual_bonuses_enabledboolean

Affiché pour type : free_item_to_choose_if_buy_items, free_item_to_choose_if_buy_items_from_categories, free_item_to_choose, free_delivery, fixed_discount_on_all_order, percent_discount_on_all_order, fixed_discount_on_items, percent_discount_on_items, fixed_discount_on_items_from_categories, percent_discount_on_items_from_categories, fixed_discount_on_next_item, percent_discount_on_next_item, fixed_discount_on_next_item_from_categories, percent_discount_on_next_item_from_categories, percent_discount_on_item_with_minimum_cost_in_cart, fixed_discount_on_item_with_minimum_cost_in_cart, percent_discount_on_item_with_minimum_cost_from_items, fixed_discount_on_item_with_minimum_cost_from_items, percent_discount_on_item_with_minimum_cost_from_categories, fixed_discount_on_item_with_minimum_cost_from_categories

Exemple: true

first_purchase_enabledboolean

Affiché pour tous les types

Exemple: true

first_purchase_platformstring (Platform)

Valeurs:androidiosallmobile_appssitesocial_apps

Exemple: all

reuse_enabledboolean

Affiché pour tous les types

Exemple: true

use_only_in_birthday_enabledboolean

Affiché pour tous les types

Exemple: true

birthday_validity_beforeinteger

Affiché pour tous les types lorsque use_only_in_birthday_enabled est activé

Exemple: 10

birthday_validity_afterinteger

Affiché pour tous les types lorsque use_only_in_birthday_enabled est activé

Exemple: 10

ignore_in_minimum_sum_enabledboolean

Affiché lorsque type : fixed_discount_on_all_order, percent_discount_on_all_order, fixed_discount_on_items, percent_discount_on_items, fixed_discount_on_items_from_categories, percent_discount_on_items_from_categories, fixed_discount_on_next_item, percent_discount_on_next_item, fixed_discount_on_next_item_from_categories, percent_discount_on_next_item_from_categories, percent_discount_on_item_with_minimum_cost_in_cart, fixed_discount_on_item_with_minimum_cost_in_cart, percent_discount_on_item_with_minimum_cost_from_items, fixed_discount_on_item_with_minimum_cost_from_items, percent_discount_on_item_with_minimum_cost_from_categories, fixed_discount_on_item_with_minimum_cost_from_categories

Exemple: true

delivery_methodstring (DeliveryMethodUpdate)

Valeurs:allcourierpickup

from_sumnumber

Affiché pour type: free_item_to_choose_if_buy_items, free_item_to_choose_if_buy_items_from_categories, free_item_to_choose, free_delivery, fixed_discount_on_all_order, percent_discount_on_all_order, fixed_discount_on_items, percent_discount_on_items, fixed_discount_on_items_from_categories, percent_discount_on_items_from_categories, fixed_discount_on_next_item, percent_discount_on_next_item, fixed_discount_on_next_item_from_categories, percent_discount_on_next_item_from_categories, percent_discount_on_item_with_minimum_cost_in_cart, fixed_discount_on_item_with_minimum_cost_in_cart, percent_discount_on_item_with_minimum_cost_from_items, fixed_discount_on_item_with_minimum_cost_from_items, percent_discount_on_item_with_minimum_cost_from_categories, fixed_discount_on_item_with_minimum_cost_from_categories

Exemple: 100

to_sumnumber

Affiché pour type: free_item_to_choose_if_buy_items, free_item_to_choose_if_buy_items_from_categories, free_item_to_choose, free_delivery, fixed_discount_on_all_order, percent_discount_on_all_order, fixed_discount_on_items, percent_discount_on_items, fixed_discount_on_items_from_categories, percent_discount_on_items_from_categories, fixed_discount_on_next_item, percent_discount_on_next_item, fixed_discount_on_next_item_from_categories, percent_discount_on_next_item_from_categories, percent_discount_on_item_with_minimum_cost_in_cart, fixed_discount_on_item_with_minimum_cost_in_cart, percent_discount_on_item_with_minimum_cost_from_items, fixed_discount_on_item_with_minimum_cost_from_items, percent_discount_on_item_with_minimum_cost_from_categories, fixed_discount_on_item_with_minimum_cost_from_categories

Exemple: 1000

multiple_sumnumber

Affiché lorsque type : free_item_to_choose

Exemple: 100

from_to_sums_for_items_from_conditions_enabledboolean

Affiché lorsque type : free_item_to_choose_if_buy_items, free_item_to_choose_if_buy_items_from_categories

Exemple: true

discountnumber

Affiché pour type: fixed_discount_on_all_order, percent_discount_on_all_order, fixed_discount_on_items, percent_discount_on_items, fixed_discount_on_items_from_categories, percent_discount_on_items_from_categories, fixed_discount_on_next_item, percent_discount_on_next_item, fixed_discount_on_next_item_from_categories, percent_discount_on_next_item_from_categories, percent_discount_on_item_with_minimum_cost_in_cart, fixed_discount_on_item_with_minimum_cost_in_cart, percent_discount_on_item_with_minimum_cost_from_items, fixed_discount_on_item_with_minimum_cost_from_items, percent_discount_on_item_with_minimum_cost_from_categories, fixed_discount_on_item_with_minimum_cost_from_categories

Exemple: 10

count_items_for_conditioninteger

Affiché lorsque type : fixed_discount_on_items, percent_discount_on_items, free_item_to_choose_if_buy_items, free_item_to_choose_if_buy_items_from_categories, fixed_discount_on_items_from_categories, percent_discount_on_items_from_categories, fixed_discount_on_next_item, percent_discount_on_next_item, fixed_discount_on_next_item_from_categories, percent_discount_on_next_item_from_categories, percent_discount_on_item_with_minimum_cost_from_items, fixed_discount_on_item_with_minimum_cost_from_items, percent_discount_on_item_with_minimum_cost_from_categories, fixed_discount_on_item_with_minimum_cost_from_categories

Exemple: 10

count_items_for_actioninteger

Affiché lorsque type : free_item_to_choose, free_item_to_choose_if_buy_items, free_item_to_choose_if_buy_items_from_categories

Exemple: 10

one_item_from_conditions_enabledboolean

Affiché lorsque type : fixed_discount_on_items, percent_discount_on_items, free_item_to_choose_if_buy_items, free_item_to_choose_if_buy_items_from_categories, fixed_discount_on_items_from_categories, percent_discount_on_items_from_categories, percent_discount_on_item_with_minimum_cost_from_items, fixed_discount_on_item_with_minimum_cost_from_items, percent_discount_on_item_with_minimum_cost_from_categories, fixed_discount_on_item_with_minimum_cost_from_categories

Exemple: true

use_only_one_time_in_cart_enabledboolean

Affiché lorsque type : fixed_discount_on_items_from_categories, percent_discount_on_items_from_categories, fixed_discount_on_items, percent_discount_on_items, free_item_to_choose_if_buy_items, free_item_to_choose_if_buy_items_from_categories, fixed_discount_on_next_item, percent_discount_on_next_item, fixed_discount_on_next_item_from_categories, percent_discount_on_next_item_from_categories, percent_discount_on_item_with_minimum_cost_from_items, fixed_discount_on_item_with_minimum_cost_from_items, percent_discount_on_item_with_minimum_cost_from_categories, fixed_discount_on_item_with_minimum_cost_from_categories

Exemple: true

automatic_old_cost_for_items_enabledboolean

Affiché pour type: percent_discount_on_all_order, percent_discount_on_items_from_categories, percent_discount_on_items

Exemple: true

bonuses_sumnumber

Affiché et obligatoire si type : bonuses

Exemple: 100

bonuses_validitynumber

Affiché lorsque type : bonuses

Exemple: 100

actions_itemsarray of integer

Affiché et obligatoire pour type : percent_discount_on_item_with_minimum_cost_from_items, fixed_discount_on_item_with_minimum_cost_from_items, percent_discount_on_next_item, fixed_discount_on_next_item, percent_discount_on_items, fixed_discount_on_items, free_item_to_choose, free_item_to_choose_if_buy_items, free_item_to_choose_if_buy_items_from_categories

conditions_itemsarray of integer

Affiché et obligatoire si type : free_item_to_choose_if_buy_items

actions_categoriesarray of integer

Affiché et obligatoire pour type: percent_discount_on_item_with_minimum_cost_from_categories, fixed_discount_on_item_with_minimum_cost_from_categories, percent_discount_on_items_from_categories, fixed_discount_on_items_from_categories, percent_discount_on_next_item_from_categories, fixed_discount_on_next_item_from_categories

conditions_categoriesarray of integer

Affiché et obligatoire si type : free_item_to_choose_if_buy_items_from_categories

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject