Сервис интеграции с iiko

Общая информация

Сервис "iiko" отвечает за интеграцию с iiko API, включая получение номенклатуры, обработку заказов и другие связанные операции.


POST /calculate-checkin-result

Описание: Расчет результата регистрации в программе лояльности.

Теги: iiko

Summary: Выполняет расчет по заказу для применения программы лояльности.

Предварительная проверка: Требуется аутентификация пользователя (user role).

Тело запроса (body):

{
  "order": {
    // Информация о заказе
  }
}

Ответ:

  • 200 OK:
    {
        "discountTotal": 0,
        "discounts": [],
        "loyaltyProgramErrors": [],
        "freeProducts": [],
        "lostGift": []
    }
    
  • discountTotal: (number) - Общая сумма скидки.
  • discounts: (array) - Примененные скидки (массив объектов).
  • loyaltyProgramErrors: (array) - Ошибки программы лояльности (массив строк).
  • freeProducts: (array) - Бесплатные продукты (массив строк - productCodes).
  • lostGift: (array) - Потерянные подарки (массив строк - productCodes).
  • 500 Internal Server Error:
    {
        "success": false,
        "message": "Internal Server Error"
    }
    

POST /orders/check-create

Описание: Проверка возможности создания заказа.

Теги: iiko

Summary: Проверяет, можно ли создать заказ.

Предварительная проверка: Требуется аутентификация пользователя (user role).

Тело запроса (body):

{
  "order": {
    // Информация о заказе
  }
}

Ответ:

  • 200 OK:
    {
        "success": true,
        "message": "Заказ может быть создан"
    }
    
  • success: (boolean) - Успешность проверки.
  • message: (string) - Сообщение о результате проверки.
  • 500 Internal Server Error:
    {
        "success": false,
        "message": "Internal Server Error"
    }
    

POST /orders/checkAddress

Описание: Проверка корректности адреса доставки.

Теги: iiko

Summary: Проверяет корректность адреса для доставки.

Предварительная проверка: Требуется аутентификация пользователя (user role).

Тело запроса (body):

{
    "city": "Самара",
    "street": "Улица 1",
    "home": "123"
}
  • city: (string) - Название города.
  • street: (string) - Название улицы.
  • home: (string) - Номер дома.

Ответ:

  • 200 OK:
    {
        "success": true,
        "message": "Адрес проверен и валиден"
    }
    
  • success: (boolean) - Успешность проверки.
  • message: (string) - Сообщение о результате проверки.
  • 500 Internal Server Error:
    {
        "success": false,
        "message": "Internal Server Error"
    }
    
    Примечания:
  • Все запросы требуют авторизации с ролью user.
  • Все запросы возвращают 500 Internal Server Error в случае внутренней ошибки на сервере.