CompleteOrder

Назначение	Завершает заказ, если внесенная предоплата равна сумме заказа. После выполнения этой команды оплаченный заказ становится недоступным для редактирования.
Тип запроса	асинхронный/синхронный
Поддерживаемая версия агента	v2
PluggetSystemType	RKMid

ФОРМАТ ЗАПРОСА

Запрос

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

Параметр	Тип	Обязательный	Описание
taskType	string	+	Тип задачи
sync			Синхронный вызов метода (либо синхронный, либо асинхронный. Для этого изменить на "async")
timeout	int	-	Время ожидания ответа от агента в секундах, по умолчанию 120 секунд
objectId	int	+	Код ресторана в системе лицензирования
orderGuid	guid	+	Guid заказа по которому требуется провести оплату
cashStationId	int	-	Id кассовой станции, если не указан, берется из параметров ресторана установленных в административной панели WS. При указании кассовой станции с mid, отличного от выбранного в "параметрах создания заказа", указываем этот mid в поле systemName Маршрутизация запросов

ФОРМАТ ОТВЕТА

Успешный ответ - значит, оплаченный заказ проверен и завершён. Теперь его изменять нельзя

{
  "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"
    }
  }
}

Параметр

Тип

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

Описание

order

да

price.total

money

да

Полная стоимость заказа

error

string enum

Контейнер ошибок, см Описание ошибок

- wsError

string enum

Ошибка WhiteServer

– code

string

Код ошибки

– desc

string

Описание ошибки

- agentError

string enum

Ошибка от агента

– code

string

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

OrderIsLocked	заказ заблокирован
OrderIsClosed	заказ закрыт
PaymentIsMoreThanTotalPrice	оплата передана больше, чем стоимость заказа

– desc

string

Описание ошибки

ПРИМЕРЫ СТРУКТУРЫ ЗАПРОСОВ

{
  "taskType": "CompleteOrder",
  "params": {
    "sync": {
      "objectId": 199990232,
      "timeout": 120
    },
    "orderGuid": "490d292e-99ce-491d-bb0b-c137a76ef5e4"
  }
}

{
  "taskResponse": {
    "order": {
      "originalOrderId": "3594339753138336",
      "orderGuid": "490d292e-99ce-491d-bb0b-c137a76ef5e4",
      "status": {
        "value": "Complited",
        "isBillPrinted": true,
        "isAutoAccepted": true
      },
      "substate": "None",
      "products": [
        {
          "id": 1024545,
          "name": "Суп с пряностями",
          "price": 300,
          "quantity": 1,
          "ingredients": [],
          "kdsState": "None",
          "discountIds": []
        }
      ],
      "price": {
        "total": 300,
        "sumToPay": 0
      },
      "totalPieces": 0,
      "createdAt": "2026-04-17T08:33:20",
      "readyTime": "2026-04-17T00:00:00",
      "comment": "string",
      "personsQuantity": 1,
      "waiterId": 9012,
      "waiter": "WSA",
      "tableName": "WSA2",
      "tableCode": 6,
      "extraTableCodes": [],
      "appliedPayments": [
        {
          "amount": 300,
          "currency": "16d72549-14d8-4f31-9e2a-0a833d4f5eed",
          "guid": "1d640fd1-7c31-4a02-8549-4186b9a27695",
          "payType": "Cash"
        },
        {
          "amount": 0,
          "currency": "16d72549-14d8-4f31-9e2a-0a833d4f5eed",
          "guid": "4cde4a3a-95b6-4d08-919d-64ab61d322ea",
          "payType": "Cash"
        }
      ],
      "discountIds": [],
      "queuePosition": "A46",
      "restaurantGuid": "fc1bbb36-4d7f-4ef9-80c2-33b78adbdb6a",
      "categoryGuid": "1e113335-9f76-4cdf-a860-96adb5d33e77"
    }
  },
  "responseCommon": {
    "taskGuid": "41fd6c03-ffdd-4307-8e7d-9cbf1c0f9e6b",
    "taskType": "CompleteOrder",
    "objectId": 199990232,
    "agentGuid": "62225260-c097-4c75-abef-106c7207f9ff"
  }
}

{
  "responseCommon": {
    "taskGuid": "29c744ed-946f-4e6f-85dd-b02e97e4bcf3",
    "taskType": "CompleteOrder",
    "objectId": 199990232,
    "agentGuid": "62225260-c097-4c75-abef-106c7207f9ff"
  },
  "error": {
    "agentError": {
      "code": "WsaOrderError",
      "desc": "RkInternal: Касса [3071] Невозможно закрыть  заказ WSA2, он не оплачен полностью."
    }
  }
}