Добавить ссылку на команды RK7 XML API

1 Описание

НазначениеОтмена заказа на доставку
Тип запросаАсинхронный

2 Формат запросов

2.1 Формат запроса

<?xml version="1.0" encoding="utf-8"?>
<RQ cmd="cancel_order_delivery" callback="http://domain.ru/page.php?param1=1&amp;param2=2" timeout="int">
   <PARAM name="object_id" val="int" />
   <CHECK qrid="QRid" taskguid="guid" />
   <CANCELREASON code="int" extcode="int" text="Нет терминала у курьера" />
</RQ>

Описание параметров


ПараметрТипОбязательныйОписаниеЗначение по умолчанию
object_idint+Код ресторана в системе лицензирования
groupguidguid-Необязательный guid для группировки запросов в рамках одного пользовательского сценария. Если создаётся серия запросов (создан заказ, сохранён, оплачен), то лучше группировать их в один сценарий для упрощения диагностики проблем.
callbackstring+HTTP адрес, по которому WhiteServer отправит запрос после выполнения команды
сodeint+Код причины удаления RK (маппится по табличке (4.1)), может отличаться в разных сетях (редактируется на уровне сервера справочников сети)
extcodeint+Код причины у агрегатора (возможно будем хранить в расширенном свойстве)
qridstring
Идентификатор заказа, который будет отменен на кассе
taskguidguid
Guid заказа для отмены, который передан на агент, но еще не подтвержден на кассе менеджером/официантом


2.2 Формат ответа

<?xml version="1.0" encoding="utf-8"?>
<RP taskguid="6774b0bc-dd5e-4eca-a1f9-d982607feb2e" code="0" version="1.5.0.7155" />

Описание параметров

ПараметрТипОписание
taskguidguidУникальный код этой задачи. При отправке callback будет использован этот код, чтобы вызывающий сервис мог сопоставить запрос и ответ


2.3 Формат callback (асинхронного ответа)

<RP taskguid="guid">
<Error code="0" Text="OK" />
</RP>

Описание параметров

ПараметрТипОписание
taskguidguidСовпадает с taskguid в ответе

3 Таблица ошибок метода

<?xml version="1.0" encoding="utf-8"?>
<RP taskguid="guid">
   <ERROR code="кодОтАгента" text="ТекстОтАгента" />
</RP>

4 Примеры вызовов

4.1 Пример

4.1.1 Запрос

<?xml version="1.0" encoding="utf-8"?>
<RQ cmd="cancel_order_delivery" callback="http://domain.ru/page.php?param1=1&amp;param2=2">
   <PARAM name="object_id" val="199990053" />
   <CHECK qrid="90ef4c1b358e44088b4de2bc799a0688dddsgfhsfh454634dff335v" taskguid="faa717f1-4f41-4daa-aa54-6c10b75475aa" />
   <CANCELREASON code="1" extcode="1" text="Нет терминала у курьера" />
</RQ>

4.1.2 Ответ

<?xml version="1.0" encoding="utf-8"?>
<RP taskguid="0a85447e-f4da-4424-8c36-d20c63fe6b89" code="0" version="1.7.0.8215" />

4.1.3 Callback (асинхронный ответ)

<RP taskguid="0a85447e-f4da-4424-8c36-d20c63fe6b89" posid="797C3E3B-3C33-4D97-87F8-25578FE48BE6">
<Error code="0" Text="OK" />
</RP>

V2 CancelOrderDelivery