Назначение

Завершает заказ, если внесенная предоплата равна сумме заказа.

После выполнения этой команды оплаченный заказ становится недоступным для редактирования.

Тип запросаасинхронный/синхронный
Поддерживаемая версия агентаv2
PluggetSystemTypeRKMid

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

{
  "taskType": "CompleteOrder",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
   "orderGuid": "guid"
  }
}
JSON

Параметр

Тип

Обязательный

Описание

taskTypestringдаТип задачи
-async

Асинхронный вызов метода: либо синхронный, либо асинхронный
-sync

Синхронный вызов метода: либо синхронный, либо асинхронный
--timeoutintнетВремя ожидания ответа от агента в секундах, по умолчанию — 120 секунд
--objectIdintдаКод ресторана в системе лицензирования
-orderGuidguidдаGuid заказа, по которому требуется провести оплату

Формат синхронного ответа

{ 
   "responseCommon":{ 
      "taskGuid":"guid",
      "taskType":"CompleteOrder",
      "objectId": number
   },
   "error":{ 
      "wsError":{ 
         "code":"string",
         "desc":"string"
      }
   }
}
JSON

Параметр

Тип

Описание

-taskGuidguidУникальный код этой задачи, используется при получении задачи через очередь
-taskTypestring enumТип задачи
-objectIdintКод ресторана в системе лицензирования
error
Контейнер ошибок, подробнее читайте в статье Описание ошибок

Формат асинхронного ответа

// Успешный ответ - значит, оплаченный заказ проверен и завершён; теперь его изменять нельзя.
{
  "taskResponse": {
     "order": {
        "price": {
           "total": number,
        }
     }
  },
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "CompleteOrder",
    "objectId": number
  }
}
 
// Ответ с ошибкой
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "CompleteOrder",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}
CODE

Параметр

Тип параметра

Обязательный

Описание

order
да
price.totalmoneyдаПолная стоимость заказа
errorstring enum
Контейнер ошибок, подробнее читайте в статье Описание ошибок
-wsErrorstring enum
Ошибка Whiteserver
--codestring
Код ошибки
--descstring
Описание ошибки
-agentErrorstring enum
Ошибка от агента
--codestring

Кроме существующих, появятся такие коды ошибок (в старом агенте — цифрами):

значение

описание

OrderIsLockedзаказ заблокирован
OrderIsClosedзаказ закрыт

PaymentIsMoreThanTotalPrice

оплата передана больше, чем стоимость заказа
--descstring
Описание ошибки