Перейти к основному содержимому

Передача промокода в запросе

Для применения промокода при расчёте корзины передайте его значение в параметре promocodes.

Важно

Промокод не применится к корзине, если группа промокодов, куда входит промокод из запроса на расчет корзины, не указана в условии какой-либо акции или неактивна.

Пример передачи одного промокода:

&promocodes=["PROMOCODE_VALUE"]

Можно передать несколько промокодов, указав их в массиве:

&promocodes=["PROMO1","PROMO2"]

Получение информации о статусе промокодов​

Для получения расширенной информации о проверке и применении промокодов в запросе к методу расчёта корзины можно дополнительно передать параметр:

&promocodes_info=1

В этом случае в ответе появится массив promocodes с подробной информацией по каждому переданному коду.

Пример ответа с информацией о промокодах​

{
  "promocodes": [
    {
      "purchase_id": null,
      "status": 4,
      "status_description": "Код совпал с одним из условий одной из акций, для которой все остальные условия также выполнены",
      "number": "KEXGA",
      "marketing_actions": [
        {
          "marketing_action_name": "test_calc",
          "marketing_action_id": 6
        }
      ]
    },
    {
      "purchase_id": null,
      "status": 2,
      "status_description": "Код найден",
      "number": "TEST_123",
      "marketing_actions": null
    },
    {
      "purchase_id": null,
      "status": 1,
      "status_description": "Код пришёл с корзиной",
      "number": "EFWFEWf",
      "marketing_actions": null
    }
  ]
}

Статусы промокодов​

Статус промокода отражает этап его обработки и зависит от условий акций и состава корзины.

СтатусКодОписание
ATTACHED1Код пришёл с корзиной
RECOGNIZED2Код найден
RULE_MATCHED3Код совпал с одним из условий одной из акций
MATCHED4Код совпал с одним из условий акции, для которой выполнены все остальные условия
APPLIED5Код использован (возвращается только при создании покупки)
Рекомендация

Используйте promocodes_info=1 на этапе оформления заказа, чтобы показывать пользователю корректные сообщения о статусе промокода: принят, недоступен, применён или требует дополнительных условий.