RemovePrepayOrder

Назначение	Удаляет предоплаты в указанном заказе
Поддерживаемая версия агента, SH	WSA v2.8.5.8
PluggetSystemType	RKMid

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

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

{
    "taskType": "RemovePrepayOrder",
    "params": {
        "sync": {
            "objectId": number,
            "timeout": number
        },
 
        "cashStationId": number,
        "orderGuid": "string",
        "prepayId": "string"
    }
}

CODE

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

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

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

Успешный ответ

{
    "taskResponse": {
        "deletedIds": [
            "guid",
            "guid"
        ]
    },
    "responseCommon": {
        "taskGuid": "string",
        "taskType": "RemovePrepayOrder",
        "objectId": number,
        "agentGuid": "string"
    }
}

CODE

Параметр	Тип параметра	Обязательный	Описание
deletedIds	array of string (guid)	+	Идентификатор удаленной предоплаты / предоплат (line_guid в rkeeper)

Ответ с ошибкой

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "AddPrepayOrder",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

JSON

Параметр

Тип

Описание

taskGuid

guid

Уникальный код этой задачи используется при получении задачи через очередь

taskType

string

Тип задачи

objectId

int

Код ресторана в системе лицензирования

error

string enum

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

wsError		Ошибка от сервера
agentError		Ошибка от агента

Примеры структуры запросов

Примеры структуры запросов

{
    "taskType": "RemovePrepayOrder",
    "params": {
        "sync": {
            "objectId": "199990246",
            "timeout": 120
        },
        "orderGuid": "8fcf1323-a26c-4afc-a8a4-7023372b4ebb",
        "orderGuid": "8fcf1323-a26c-4afc-a8a4-7023372b4ebb"
    }
}

{
    "taskResponse": {
        "deletedIds": [
            "0cb956ac-6c1c-4c58-89b8-a409d8a6efcd",
            "3bb6be07-2c4f-43f8-8a2d-f1b684779b62"
        ]
    },
    "responseCommon": {
        "taskGuid": "c7e07507-277d-43f5-ba4f-98e0ad1cbb63",
        "taskType": "RemovePrepayOrder",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}