Получение списка доступных для клиента промоакций

Набор шагов

Описание метода

Операция выводит список активных и действующих для клиента (покупателя) промоакций.

Для промоакций с пулом промокодов в условиях доступности - в ответе операции будут перечислены персональные промокоды, которые можно применить к этой промоакции.
Пул промокодов должен быть с включенной функцией "Проверять выдачу перед использованием".

Алгоритм получения промокодов для центра уведомлений:

1. Получаем через операцию все промоакции доступные покупателю;
2. Обрабатываем полученный список промоакций.
   В данных по каждой промоакции ищем узел promoCodes . Если у покупателя есть активные персональные промокоды - они будут перечислены в этом узле.
   В promoCodes будет не более 5 промокодов для одной промоакции, в порядке от старых к новым;
3. Выводим полученные промокоды в ЦУ.
   Если нужно, выводим информацию о промоакции для которой работает промокод, ее название, срок работы, лимиты и т.п.

• В ответе могут быть промоакции, которые действуют для клиента, но у него нет промокодов для них.
  Такие промоакции будут без узла promoCodes .
• Многоразовые промокоды не возвращаются в ответе операции. Их значения можно прописать в дополнительное поле акции и выводить из узла customFields/{доп поле}, но в таком случае значение нужно будет актуализировать вручную.

Запрос

Запрос
POST https://api.mindbox.ru/v3/operations/sync?endpointId={уникальный идентификатор сайта/мобильного приложения/и т.п.}&operation={название операции}

Content-Type: application/json; charset=utf-8
Accept: application/json
Authorization: SecretKey {Секретный ключ}

{
  "customer": {
    "ids": {
      "mindboxId": "<Id клиента в Mindbox>"
    }
  }
}

Пример запроса

Получить список промоакций действующих для клиента с mindbox id 2305.

Получение списка промокодов
POST https://api.mindbox.ru/v3/operations/sync?endpointId=MindboxRu&operation=GetPromoCodeList

Content-Type: application/json; charset=utf-8
Accept: application/json
Authorization: SecretKey {Секретный ключ}

{
  "customer": {
    "ids": {
      "mindboxId": "2305"
    }
  }
}

Ответ

JSON
{
  "status": "<Результат выполнения запроса: Success в случае успеха, ValidationError в случае ошибки пользователя, ProtocolError в случае ошибки интеграции, InternalServerError в случае недоступности сервера.>",
  "promoActions": [
    {
      "description": "<Описание промоакции>",
      "endDateTimeUtc": "<Дата окончания промоакции>",
      "name": "<Название промоакции>",
      "startDateTimeUtc": "<Дата старта промоакции>",
      "ids": {
        "externalId": "<Внешний идентификатор промоакции>"
      },
      "customFields": {
        "testCustomField": "<Тестовое дополнительное поле>",
      },
      "limits": [
        {
          "type": "<Способ агрегации (по акции, по клиенту)>",
          "untilDateTimeUtc": "<Дата завершения срока действия лимита>",
          "amount": {
            "type": "<Тип значения лимита (количество применений, размер скидки)>",
            "value": "<Значение лимита>"
          },
          "used": {
            "usageServiceStatus": "<Доступность сервиса лимитов>",
            "amount": "<Использование лимита>"
          }
        },
        {
          "type": "<Способ агрегации (по акции, по клиенту)>",
          "untilDateTimeUtc": "<Дата завершения срока действия лимита>",
          "amount": {
            "type": "<Тип значения лимита (количество применений, размер скидки)>",
            "value": "<Значение лимита>"
          },
          "used": {
            "usageServiceStatus": "<Доступность сервиса лимитов>",
            "amount": "<Использование лимита>"
          }
        }
      ],
      "promoCodes": [
        {
          "ids": {
            "value": "<Значение промокода>"
          }
        },
        {
          "ids": {
            "value": "<Значение промокода>"
          }
        }
      ]
    },
    {
      "description": "<Описание промоакции>",
      "endDateTimeUtc": "<Дата окончания промоакции>",
      "name": "<Название промоакции>",
      "startDateTimeUtc": "<Дата старта промоакции>",
      "ids": {
        "externalId": "<Внешний идентификатор промоакции>"
      },
      "customFields": {
        "testCustomField": "<Тестовое дополнительное поле>",
      },
      "limits": [
        {
          "type": "<Способ агрегации (по акции, по клиенту)>",
          "untilDateTimeUtc": "<Дата завершения срока действия лимита>",
          "amount": {
            "type": "<Тип значения лимита (количество применений, размер скидки)>",
            "value": "<Значение лимита>"
          },
          "used": {
            "usageServiceStatus": "<Доступность сервиса лимитов>",
            "amount": "<Использование лимита>"
          }
        },
        {
          "type": "<Способ агрегации (по акции, по клиенту)>",
          "untilDateTimeUtc": "<Дата завершения срока действия лимита>",
          "amount": {
            "type": "<Тип значения лимита (количество применений, размер скидки)>",
            "value": "<Значение лимита>"
          },
          "used": {
            "usageServiceStatus": "<Доступность сервиса лимитов>",
            "amount": "<Использование лимита>"
          }
        }
      ],
      "promoCodes": [
        {
          "ids": {
            "value": "<Значение промокода>"
          }
        },
        {
          "ids": {
            "value": "<Значение промокода>"
          }
        }
      ]
    }
  ]
}

Пример ответа

JSON
{
    "status": "Success",
    "promoActions": [
        {
            "ids": {
                "externalId": "promotion-51"
            },
            "name": "1 балл за 2 потраченных рубля",
            "startDateTimeUtc": "2024-10-13T12:28:53.2885146Z"
        },
        {
            "ids": {
                "externalId": "promotion-53"
            },
            "name": "Округление",
            "startDateTimeUtc": "2024-10-13T13:19:11.653112Z"
        },
        {
            "ids": {
                "externalId": "promotion-46"
            },
            "name": "Тестовая скидка за промокод",
            "promoCodes": [
                {
                    "ids": {
                        "value": "AA006"
                    }
                },
                {
                    "ids": {
                        "value": "AA017"
                    }
                },
                {
                    "ids": {
                        "value": "AA011"
                    }
                },
                {
                    "ids": {
                        "value": "AA010"
                    }
                },
                {
                    "ids": {
                        "value": "AA001"
                    }
                }
            ],
            "startDateTimeUtc": "2024-10-08T14:16:37.7943206Z"
        }
    ]
}