Crear promoción

POST/api/crm/v2/special_offers_list.addv2

operationId: specialOffersList.add

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Sucursal en la que se realiza la solicitud. Un socio con varias sucursales debe proporcionarla, de lo contrario la solicitud fallará. Para un socio con una sola sucursal, el servidor la asigna automáticamente.

Ejemplo: 8778

Cuerpo de la solicitud `multipart/form-data`

object

Las reglas de funcionamiento se ocultan cuando operating_mode = informing

namestringobligatorio

Ejemplo: Free delivery

operating_modestring (TypeOperatingMode) obligatorio

Valores:informingpromo_codeinforming_and_promo_codeautomatic_actioninforming_and_automatic_action

Ejemplo: informing

platformstring (Platform) obligatorio

Valores:androidiosallmobile_appssitesocial_apps

Ejemplo: all

descriptionstring

Se muestra y es obligatorio para operating_mode: informing, informing_and_promo_code, informing_and_automatic_action

Ejemplo: informing description

imageobject (ImageSource)

Se muestra y es obligatorio cuando operating_mode es: informing, informing_and_promo_code, informing_and_automatic_action

binarystring · binary

cropobject

Coordenadas de recorte de la imagen

offsetsobject

xintegerobligatorio

Ejemplo: 100

yintegerobligatorio

Ejemplo: 50

sizesobject

widthintegerobligatorio

Ejemplo: 800

heightintegerobligatorio

Ejemplo: 600

push_titlestring

Se muestra cuando operating_mode es: informing, informing_and_promo_code, informing_and_automatic_action

Ejemplo: the push title

push_messagestring

Se muestra cuando operating_mode es: informing, informing_and_promo_code, informing_and_automatic_action

Ejemplo: the push message

date_availablestring (DataTimeFormat)

Ejemplo: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Ejemplo: 17:45 06/05/2024

days_of_weekarray of integer (DaysWeek)

Días de la semana

time_periodsarray of array of string (TimePeriods)

Período de tiempo

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

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

subcategories_include_in_categories_enabledboolean

Se muestra cuando 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

Ejemplo: true

authorized_users_enabledboolean

Se muestra cuando type es: 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

Ejemplo: true

work_with_pay_bonuses_enabledboolean

Se muestra cuando 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

Ejemplo: true

accrual_bonuses_enabledboolean

Ejemplo: true

first_purchase_enabledboolean

Se muestra para todos los tipos

Ejemplo: true

first_purchase_platformstring (Platform)

Valores:androidiosallmobile_appssitesocial_apps

Ejemplo: all

reuse_enabledboolean

Se muestra para todos los tipos

Ejemplo: true

use_only_in_birthday_enabledboolean

Se muestra para todos los tipos

Ejemplo: true

birthday_validity_beforeinteger

Se muestra para todos los tipos cuando use_only_in_birthday_enabled está activado

Ejemplo: 10

birthday_validity_afterinteger

Se muestra para todos los tipos cuando use_only_in_birthday_enabled está activado

Ejemplo: 10

ignore_in_minimum_sum_enabledboolean

Se muestra cuando 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

Ejemplo: true

delivery_methodstring (DeliveryMethodUpdate)

Valores:allcourierpickup

from_sumnumber

Ejemplo: 100

to_sumnumber

Ejemplo: 1000

multiple_sumnumber

Se muestra cuando type: free_item_to_choose

Ejemplo: 100

from_to_sums_for_items_from_conditions_enabledboolean

Se muestra cuando type: free_item_to_choose_if_buy_items, free_item_to_choose_if_buy_items_from_categories

Ejemplo: true

discountnumber

Se muestra cuando type es: 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

Ejemplo: 10

count_items_for_conditioninteger

Se muestra cuando type es: 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

Ejemplo: 10

count_items_for_actioninteger

Se muestra cuando type: free_item_to_choose, free_item_to_choose_if_buy_items, free_item_to_choose_if_buy_items_from_categories

Ejemplo: 10

one_item_from_conditions_enabledboolean

Se muestra cuando type es: 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

Ejemplo: true

use_only_one_time_in_cart_enabledboolean

Se muestra cuando 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

Ejemplo: true

automatic_old_cost_for_items_enabledboolean

Se muestra cuando type: percent_discount_on_all_order, percent_discount_on_items_from_categories, percent_discount_on_items

Ejemplo: true

bonuses_sumnumber

Se muestra y es obligatorio cuando type es bonuses

Ejemplo: 100

bonuses_validitynumber

Se muestra cuando type: bonuses

Ejemplo: 100

actions_itemsarray of integer

Se muestra y es obligatorio para 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

Se muestra y es obligatorio cuando type es: free_item_to_choose_if_buy_items

actions_categoriesarray of integer

Se muestra y es obligatorio cuando type es: 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

Se muestra y es obligatorio cuando type es: free_item_to_choose_if_buy_items_from_categories

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

curl -X POST 'https://foodsoul.ru/api/crm/v2/special_offers_list.add' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: es' \
  -H 'role: partner' \
  -F 'name=Free delivery' \
  -F 'operating_mode=informing' \
  -F 'platform=all' \
  -F 'description=informing description' \
  -F 'image={"binary":"<file>","crop":{"offsets":{"x":100,"y":50},"sizes":{"width":800,"height":600}}}' \
  -F 'push_title=the push title' \
  -F 'push_message=the push message' \
  -F 'date_available=17:45 06/05/2024' \
  -F 'date_expiration=17:45 06/05/2024' \
  -F 'days_of_week=[2,3]' \
  -F 'time_periods=[["13:12 - 13:15"]]' \
  -F 'hide_for_districts_ids=[55311]' \
  -F 'hide_for_pickups_ids=[4925]' \
  -F 'type=free_delivery' \
  -F 'subcategories_include_in_categories_enabled=true' \
  -F 'authorized_users_enabled=true' \
  -F 'work_with_pay_bonuses_enabled=true' \
  -F 'accrual_bonuses_enabled=true' \
  -F 'first_purchase_enabled=true' \
  -F 'first_purchase_platform=all' \
  -F 'reuse_enabled=true' \
  -F 'use_only_in_birthday_enabled=true' \
  -F 'birthday_validity_before=10' \
  -F 'birthday_validity_after=10' \
  -F 'ignore_in_minimum_sum_enabled=true' \
  -F 'delivery_method=all' \
  -F 'from_sum=100' \
  -F 'to_sum=1000' \
  -F 'multiple_sum=100' \
  -F 'from_to_sums_for_items_from_conditions_enabled=true' \
  -F 'discount=10' \
  -F 'count_items_for_condition=10' \
  -F 'count_items_for_action=10' \
  -F 'one_item_from_conditions_enabled=true' \
  -F 'use_only_one_time_in_cart_enabled=true' \
  -F 'automatic_old_cost_for_items_enabled=true' \
  -F 'bonuses_sum=100' \
  -F 'bonuses_validity=100' \
  -F 'actions_items=[94061047]' \
  -F 'conditions_items=[94061047]' \
  -F 'actions_categories=[3387030]' \
  -F 'conditions_categories=[3387030]'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.ru/api/crm/v2/special_offers_list.add', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'es',
        'role' => 'partner',
    ],
    'multipart' => [
        [
            'name' => 'name',
            'contents' => 'Free delivery',
        ],
        [
            'name' => 'operating_mode',
            'contents' => 'informing',
        ],
        [
            'name' => 'platform',
            'contents' => 'all',
        ],
        [
            'name' => 'description',
            'contents' => 'informing description',
        ],
        [
            'name' => 'image',
            'contents' => '{"binary":"<file>","crop":{"offsets":{"x":100,"y":50},"sizes":{"width":800,"height":600}}}',
        ],
        [
            'name' => 'push_title',
            'contents' => 'the push title',
        ],
        [
            'name' => 'push_message',
            'contents' => 'the push message',
        ],
        [
            'name' => 'date_available',
            'contents' => '17:45 06/05/2024',
        ],
        [
            'name' => 'date_expiration',
            'contents' => '17:45 06/05/2024',
        ],
        [
            'name' => 'days_of_week',
            'contents' => '[2,3]',
        ],
        [
            'name' => 'time_periods',
            'contents' => '[["13:12 - 13:15"]]',
        ],
        [
            'name' => 'hide_for_districts_ids',
            'contents' => '[55311]',
        ],
        [
            'name' => 'hide_for_pickups_ids',
            'contents' => '[4925]',
        ],
        [
            'name' => 'type',
            'contents' => 'free_delivery',
        ],
        [
            'name' => 'subcategories_include_in_categories_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'authorized_users_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'work_with_pay_bonuses_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'accrual_bonuses_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'first_purchase_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'first_purchase_platform',
            'contents' => 'all',
        ],
        [
            'name' => 'reuse_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'use_only_in_birthday_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'birthday_validity_before',
            'contents' => '10',
        ],
        [
            'name' => 'birthday_validity_after',
            'contents' => '10',
        ],
        [
            'name' => 'ignore_in_minimum_sum_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'delivery_method',
            'contents' => 'all',
        ],
        [
            'name' => 'from_sum',
            'contents' => '100',
        ],
        [
            'name' => 'to_sum',
            'contents' => '1000',
        ],
        [
            'name' => 'multiple_sum',
            'contents' => '100',
        ],
        [
            'name' => 'from_to_sums_for_items_from_conditions_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'discount',
            'contents' => '10',
        ],
        [
            'name' => 'count_items_for_condition',
            'contents' => '10',
        ],
        [
            'name' => 'count_items_for_action',
            'contents' => '10',
        ],
        [
            'name' => 'one_item_from_conditions_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'use_only_one_time_in_cart_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'automatic_old_cost_for_items_enabled',
            'contents' => 'true',
        ],
        [
            'name' => 'bonuses_sum',
            'contents' => '100',
        ],
        [
            'name' => 'bonuses_validity',
            'contents' => '100',
        ],
        [
            'name' => 'actions_items',
            'contents' => '[94061047]',
        ],
        [
            'name' => 'conditions_items',
            'contents' => '[94061047]',
        ],
        [
            'name' => 'actions_categories',
            'contents' => '[3387030]',
        ],
        [
            'name' => 'conditions_categories',
            'contents' => '[3387030]',
        ],
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const body = new FormData()
body.append("name", "Free delivery")
body.append("operating_mode", "informing")
body.append("platform", "all")
body.append("description", "informing description")
body.append("image", "{\"binary\":\"<file>\",\"crop\":{\"offsets\":{\"x\":100,\"y\":50},\"sizes\":{\"width\":800,\"height\":600}}}")
body.append("push_title", "the push title")
body.append("push_message", "the push message")
body.append("date_available", "17:45 06/05/2024")
body.append("date_expiration", "17:45 06/05/2024")
body.append("days_of_week", "[2,3]")
body.append("time_periods", "[[\"13:12 - 13:15\"]]")
body.append("hide_for_districts_ids", "[55311]")
body.append("hide_for_pickups_ids", "[4925]")
body.append("type", "free_delivery")
body.append("subcategories_include_in_categories_enabled", "true")
body.append("authorized_users_enabled", "true")
body.append("work_with_pay_bonuses_enabled", "true")
body.append("accrual_bonuses_enabled", "true")
body.append("first_purchase_enabled", "true")
body.append("first_purchase_platform", "all")
body.append("reuse_enabled", "true")
body.append("use_only_in_birthday_enabled", "true")
body.append("birthday_validity_before", "10")
body.append("birthday_validity_after", "10")
body.append("ignore_in_minimum_sum_enabled", "true")
body.append("delivery_method", "all")
body.append("from_sum", "100")
body.append("to_sum", "1000")
body.append("multiple_sum", "100")
body.append("from_to_sums_for_items_from_conditions_enabled", "true")
body.append("discount", "10")
body.append("count_items_for_condition", "10")
body.append("count_items_for_action", "10")
body.append("one_item_from_conditions_enabled", "true")
body.append("use_only_one_time_in_cart_enabled", "true")
body.append("automatic_old_cost_for_items_enabled", "true")
body.append("bonuses_sum", "100")
body.append("bonuses_validity", "100")
body.append("actions_items", "[94061047]")
body.append("conditions_items", "[94061047]")
body.append("actions_categories", "[3387030]")
body.append("conditions_categories", "[3387030]")

const response = await fetch("https://foodsoul.ru/api/crm/v2/special_offers_list.add", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "es",
        "role": "partner"
    },
    body,
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.ru/api/crm/v2/special_offers_list.add",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "es",
        "role": "partner",
    },
    files={
        "name": [
            None,
            "Free delivery",
        ],
        "operating_mode": [
            None,
            "informing",
        ],
        "platform": [
            None,
            "all",
        ],
        "description": [
            None,
            "informing description",
        ],
        "image": [
            None,
            "{\"binary\":\"<file>\",\"crop\":{\"offsets\":{\"x\":100,\"y\":50},\"sizes\":{\"width\":800,\"height\":600}}}",
        ],
        "push_title": [
            None,
            "the push title",
        ],
        "push_message": [
            None,
            "the push message",
        ],
        "date_available": [
            None,
            "17:45 06/05/2024",
        ],
        "date_expiration": [
            None,
            "17:45 06/05/2024",
        ],
        "days_of_week": [
            None,
            "[2,3]",
        ],
        "time_periods": [
            None,
            "[[\"13:12 - 13:15\"]]",
        ],
        "hide_for_districts_ids": [
            None,
            "[55311]",
        ],
        "hide_for_pickups_ids": [
            None,
            "[4925]",
        ],
        "type": [
            None,
            "free_delivery",
        ],
        "subcategories_include_in_categories_enabled": [
            None,
            "true",
        ],
        "authorized_users_enabled": [
            None,
            "true",
        ],
        "work_with_pay_bonuses_enabled": [
            None,
            "true",
        ],
        "accrual_bonuses_enabled": [
            None,
            "true",
        ],
        "first_purchase_enabled": [
            None,
            "true",
        ],
        "first_purchase_platform": [
            None,
            "all",
        ],
        "reuse_enabled": [
            None,
            "true",
        ],
        "use_only_in_birthday_enabled": [
            None,
            "true",
        ],
        "birthday_validity_before": [
            None,
            "10",
        ],
        "birthday_validity_after": [
            None,
            "10",
        ],
        "ignore_in_minimum_sum_enabled": [
            None,
            "true",
        ],
        "delivery_method": [
            None,
            "all",
        ],
        "from_sum": [
            None,
            "100",
        ],
        "to_sum": [
            None,
            "1000",
        ],
        "multiple_sum": [
            None,
            "100",
        ],
        "from_to_sums_for_items_from_conditions_enabled": [
            None,
            "true",
        ],
        "discount": [
            None,
            "10",
        ],
        "count_items_for_condition": [
            None,
            "10",
        ],
        "count_items_for_action": [
            None,
            "10",
        ],
        "one_item_from_conditions_enabled": [
            None,
            "true",
        ],
        "use_only_one_time_in_cart_enabled": [
            None,
            "true",
        ],
        "automatic_old_cost_for_items_enabled": [
            None,
            "true",
        ],
        "bonuses_sum": [
            None,
            "100",
        ],
        "bonuses_validity": [
            None,
            "100",
        ],
        "actions_items": [
            None,
            "[94061047]",
        ],
        "conditions_items": [
            None,
            "[94061047]",
        ],
        "actions_categories": [
            None,
            "[3387030]",
        ],
        "conditions_categories": [
            None,
            "[3387030]",
        ],
    },
)
data = response.json()

Respuesta 200

{
  "status": "success",
  "data": {}
}

Las solicitudes se envían a foodsoul.ru, que es el host de este portal; no se puede elegir otro.

Crear promoción

Autorización

Parámetros de consulta

Cuerpo de la solicitud multipart/form-data

Respuestas

Cuerpo de la solicitud `multipart/form-data`