Работа с заказами
[ Base URL: https://api.plazius.ru/pub ]
- Примеры запросов приведены ниже в Swagger.
- Протестировать запросы через Postman можно с помощью коллекции. В них добавлен раздел Работа с заказами.
О сценариях использования запросов API читайте в отдельном разделе.
Запрос loyalty/orders/calculate считает лояльность для указанного в запросе заказа.
Если не передавать и скидку и наценку, а значения price и cost будут отличаться, то скидка или наценка рассчитается автоматически.
Запрос loyalty/orders/confirm подтверждает применение скидки в указанном заказе.
Для подтверждения заказа укажите значение для ключа ID — UUID заказа.
- Если в запросе не передавать скидку, но price и cost будут отличаться, то скидка рассчитается автоматически.
- Если применять лояльность не нужно, укажите в параметре loyalty значение null
Запрос loyalty/orders/reset сбрасывает заказ и отменяет подтверждение расчета лояльности.
Замороженные привилегии возвращаются гостю, а гость отвязывается от заказа. Затем заказ можно изменить, подтвердить без оплаты бонусами или без лояльности вообще.
Запрос loyalty/orders/abort отменяет заказ.
Переводит заказ в терминальный статус Отменен. Дальнейшие операции с заказом запрещены, замороженные привилегии возвращаются гостю, а гость отвязывается от заказа.
Запрос loyalty/orders/close закрывает заказ.
Списываются привилегии и начисляются бонусы за совершенный заказ.
Запрос loyalty/orders/refund возвращает заказ.
Для возврата заказа укажите значение для ключа refundId — uuid возврата заказа.
В зависимости от запроса будет возвращен закрытый заказ целиком или некоторые позиции закрытого заказа. Списанные привилегии возвращаются гостю и отменяются начисления бонусов.
Запрос loyalty/orders/get получает информацию о заказе заказа.
Проверка прав на получение информации о заказе осуществляется по организациям, на которые имеются права доступа для используемого ApiKey.
Возможные ошибки и их решения
Код ошибки | Описание | Возможные причины |
---|---|---|
1001 | Ошибка работы с закрытым заказом. | Заказ закрыт. |
1002 | Заказ в статусе Отменен. | Заказ отменен. |
1013 | Возвращаемый заказ не закрыт. | Невозможно вернуть заказ, который не закрыт. Выполните запрос Отмена заказа. |
1014 | Список блюд для возврата содержит некорректные данные. | Причины могут быть разные. Например, количество единиц блюда, которые необходимо вернуть, больше, чем количество единиц в заказе. Или такого блюда вообще не существует. |
2004 | Организация не найдена. | Данные в запросе содержат ошибку. Проверьте лицензию Plazius API в Системе лицензирования. Если ее нет, то организации либо не существует в Plazius, либо она отключена и сервис лояльности для нее недоступен. |
9004 | Ошибка валидации входных данных. | Не все обязательные данные переданы в запросе или данные в запросе содержат ошибку |