CreateOrder

Назначение	Создать заказ или забронировать стол в ресторане по objectId
PluggetSystemType	RKMid

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

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

ЗАПРОС

{
  "taskType": "CreateOrder",
  "params": {
    "sync": {
      "objectId": number,
       "timeout": number,
       "systemName": "string"
     },
    "cashStationId": number,
    "order": {
        "withRkId": "GUID",
        "rkFriendsAnchor": "GUID"
        "originalOrderId": "string",
        "sourceOrderId": "string",
        "payMethod": "string",
        "booking":{
            "time": "string",
            "duration":{
                "hours": number,
                "minutes": number
            },
            "remindTime": "string"
        },
        "expectedStartTime": "string",
        "customer": {
           "name": "string",
           "phone": "string",
           "email": "string",
           "loyalty":{
               "clientId": number,
               "cardCode": "string"
               "interfaceCode": number
           }
        },
        "pickup": {
          "courier": {
              "name": "string",
              "phone": "string"            
           },
           "expectedTime": "2019-10-17T00:00:00+03:00",
           "taker": "customer"
        },
        "payment": {
          "type": "string",
          "nettingPayment": boolean,
          "deliveryFee": number
         },
        "expeditionType": "string",
        "delivery": {
           "expectedTime": "2008-10-17T00:00:00+03:00",
           "address": {
              "fullAddress": "string",
              "subway": "string",
              "region": "string",
              "city": {
                "name": "string"
              },
              "street": {
                "name": "string"
              },
              "houseNumber": "string",
              "flatNumber": "string",
              "entrance": "string",
              "intercom": "string",
              "floor": "string",
              "coordinates": {
                "latitude": "string",
                "longitude": "string"
              },
             "comment":"string"
           },
           "courier": {
              "name": "string",
              "phone": "string"           
           }
        },
        "changeBackFrom": number,
        "products": [
           { // простой вариант
             "id": number,
             "name": "string",
             "price": "string", // в кассе смотрят на цену из кассы, параметр не обязателен
             "quantity": number,
             "comment": "string",
             "discountIds": [
                {
                  "id": number,
                  "value":number
                }
             ],
             "yandexPromos": [
                {
                   "type": "string",
                   "discount: number
                }
             ]
          },
          { // вариант с модификаторами или комбо
             "id": number,
             "name": "string",
             "price": number, // в кассе смотрят на цену из кассы, параметр не обязателен
             "quantity": number,
             "comment": "string"
             "ingredients": [ //массив модификаторов или элементов комбо
               {
                  "id": number,
                  "name": "string",
                  "quantity": number,
                  "price": number, // в кассе смотрят на цену из кассы, параметр не обязателен
                  "comment": string,
                  "yandexPromos": [
                    {
                       "type": "string",
                       "discount: number
                    }
                  ],
                  "ingredients": [ //массив модификаторов для комбо-компонетов. Только с версии агента 2.7.9.1
                   {
                     "id": number,
                     "name": "string",
                     "quantity": number,
                     "price": number // в кассе смотрят на цену из кассы, параметр не обязателен
                   }
                  ]
               }
             ]
          }
        ],
        "platform": "string",
        "comment": "string",
        "price": {
           "total": number
        },
        "personsQuantity": number,
        "tableCode": number,
        "extraTableCodes": [
           1,
           2
        ],
        "orderCategoryCode": number,
        "orderTypeCode": number,
        "prePayments": [
         {
            "amount": number,
            "currency": "guid",
            "cardCode": "string",
            "promised": bool
          }
        ],
        "guestTypeId": number,
        "discountIds": [
           number,
           number
        ],
// или
        "discountIds": [
            {
                "id": number,
                "value":number
            }
        ],
        "source": "string",
        "yandexPromos": [
           {
              "type": "string",
              "discount: number
           }
        ],
        "deliveryManager": "string",
        "deliveryOperator": "string",       
        "isDeferred": "string",
        "site": "string",
        "isCalcInInternet": boolean,
        "yndexEatsPartnerName": "string",
        "yndexEatsAuthorization": "string",
        "yndexEatsOrderId": "string",
 }

CODE

Параметр

Тип

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

Описание

Значение по умолчанию

sync

-

Синхронный вызов метода (либо синхронный, либо асинхронный. Для этого изменить на "async")

|-timeout

int

-

Время ожидания ответа от агента в секундах

120 секунд

|-objectId

int

да

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

|-systemName

string

нет

Указание конкретной подключенной системы для которой выполняется запрос

cashStationId

int

-

ID кассовой станции, если не указан, берется из параметров ресторана установленных в админке WS

При указании кассовой станции с мида, отличного от выбранного в Параметрах создания заказа, указываем этот мид в поле systemName

order

да

withRkId	GUID	-	Если указан, то заказ создается в r_keeper с заданным значением guid. Только с версии агента 2.5.4.10 и далее. Если поле указано, а версия агента ниже, то заказ будет создан со случайным Guid? указанным r_keeper
rkFriendsAnchor	Guid	-	Идентификатор лояльности r_k Friend
originalOrderId	string	-	Внешний номер заказа
sourceOrderId	string	-	Изначальный идентификатор заказа (например идентификатор в системе Yandex). Необязательный. Сохраняется в r_keeper в одноименное расширенное поле
booking	object	-	Бронирование заказа(стола) на указное время. Важно! Если настроено подключение к KDS PRO - требуется донастроить на стороне KDS PRO - выставить Показывать, когда пора готовить. 1. Начало тут https://docs.rkeeper.ru/kds/latest/nastrojki-profilya-dejstviya-vozmoyonye-na-etom-kliente-26515663.html#:~:text=По%20наступлению%20времени%20готовки 2. Ещё такой же параметр в Параметрах отображения заказа
\|-time	dateTime	+	Время начала брони в формате ГГГГ-ММ-ДДTЧЧ:ММ:СС (2024-06-26T21:00:00)
\|-duration	object	+	Продолжительность брони (например 2 часа 30 минут)
\|-hours	number	+	Продолжительность в часах (например 2)
\|-minutes	number	+	Продолжительность в минутах (например 30)
\|-remindTime	dateTime	-	Время начала готовки блюд пакета (и первой печати сервис-чеков) (в формате ГГГГ-ММ-ДДTЧЧ:ММ:СС '2024-06-26T21:00:00') Если не задано, то используется текущее время
expectedStartTime	string	-	Плановое время начала приготовления заказа. Не обязательный. Сохраняется в кипере в одноименное расширенное поле
payment	object	-
\|- type	string	да	Тип оплаты, cash — оплата наличными, card — оплата картой, online — онлайн оплата. В случае варианта online считаем, что заказ оплачен
\|- nettingPayment	boolean	-	Если True, то заказ по взаиморасчету от яндекс
\|- deliveryFee	decimal	-	Стоимость доставки. Только для мультиагента доставки
customer	object	-	Гость
\|- name	string	-	Имя гостя
\|- phone	string	-	Телефон гостя
\|- email³	string	-	Email гостя
\|- loyalty	object	-	Информация по карте лояльности гостя
\|- clientId	long	-	Идентификатор клиента в системе лояльности
\|- cardCode	string	-	Карта лояльности клиента
\|- interfaceCode	int	+	Код PDS-интерфейса кипера
expeditionType	string	-	Тип доставки. Варианты: delivery, pickup. Можно сохранить значение через тип и категорию заказа
pickup	object	-	Самовывоз (если expeditionType = pickup)
\|- courier	object	-	информация о курьере
\|- name	string	-	Имя курьера (если taker = courier)
\|- phone	string	-	Телефон курьера (если taker = courier)
\|- expectedTime	DateTime	да	К какому времени приготовить заказ
\|- taker	string	да	Кто заберет заказ из ресторана. Варианты: courier, customer. Можно сохранить значение через тип и категорию заказа
delivery	object	-	Доставка курьером ресторана (если expeditionType = delivery)
\|- address	object	-	Адрес
\|- fullAddress	string	-	полный адрес
\|- subway	string	-	Метро
\|- region	string	-	Регион
\|- city	object	-
\|- name	string	-	Город
\|- street	object	-
\|- name	string	-	Улица
\|- houseNumber	string	-	Номер дома
\|- flatNumber	string	-	Номер квартиры
\|- entrance¹	string	-	Подъезд
\|- intercom¹	string	-	Домофон
\|- floor	string	-	Этаж
\|- coordinates		-	Координаты
\|- latitude	string	-	Широта
\|- longitude	string	-	Долгота
\|- comment	string	-	Комментарий к адресу
\|- courier	object	-	информация о курьере
\|- name	string	-	Имя курьера
\|- phone	string	-	Телефон курьера
changeBackFrom	decimal?	-	С какой суммы нужна сдача
products	array	-	Состав заказа (может быть не указанным при бронировании стола)
\|- id	int	да	Идентификатор блюда
\|- name	string	-	Название блюда
\|- price	money	-	Цена за одно блюдо. Разделителем целой и дробной части суммы должна быть точка.
\|- quantity	money	да	Количество блюд
\|- discountIds	array	-	Массив идентификаторов кассовых скидок для блюд
\|- id	int	-	Идентификатор скидки
\|- value	decimal	-	Значение скидки. Указывается сумма или процент. 0 — полное применение скидки. Можно задавать как положительное, так и отрицательные значения
\|- yandexPromos	array	-	Список промоакций сервиса Яндекс.Еда для блюда. Обслуживается только мультиагентом доставки
\|- type	string	+	Тип промо (GIFT/PERCENTAGE/FIXED/COFINANCE)
\|- discount	number	+	Значение промо скидки
\|- partnerDiscount	number	-	поля partnerDiscount и yandexDiscount появляются, если тип скидки COFINANCE
\|- yandexDiscount	number	-	поля partnerDiscount и yandexDiscount появляются, если тип скидки COFINANCE
\|- comment	string	-	Комментарий к блюду. Только с версии агента 2.6.7.1
\|- ingredients	array	-	Ингредиенты или состав комбо-блюда
\|- id	int	да	Идентификатор ингредиента
\|- name	string	-	Название модификатора или комбо-компонета
\|- quantity	money	-	Количество
\|- price	money	-	Цена
\|- comment	string	-	Комментарий к комбо-компоненту
\|- ingredients	array	-	Массив модификаторов для комбо-компонетов. Только с версии агента 2.7.9.1
\|- id	int	да	Идентификатор модификатора
\|- name	string	-	Название модификатора
\|- quantity	money	-	Количество
\|- price	money	-	Цена
tableCode³	int	-	Код стола (агент v2 только)
extraTableCodes³	int[]	-	Доп. столы для бронирования (агент v2 только)
orderCategoryCode⁴	int	-	Код категории заказа (агент v2 только). Если не указан, берется из настроек по умолчанию
orderTypeCode⁴	int	-	Код типа заказа (агент v2 только). Если не указан, берется из настроек по умолчанию
price	array	-	Данные по оплате. Используемое как сумма оплаты при оплате онлайн если указано prePayments, то берется значение из поля prePayments Поле price.total работает только при типе оплаты payment.type = online, тогда оплата валютой по умолчанию суммы price.total иначе оплата не добавляется к заказу (price.total игнорируется при добавлении оплат).
\|- total	money	-	Значение суммы на оплату онлайн. Разделителем целой и дробной части суммы должна быть точка.
prePayments	array	-	(необязательный) массив данных по предоплате если указан, то применяются только эти оплаты (price.total и payment.type игнорируется при добавлении оплат) если не указан, то КАК И РАНЬШЕ: если payment.type = online, то оплата валютой по умолчанию суммы price.total иначе оплата не добавляется к заказу (price.total игнорируется при добавлении оплат). Только WSA2 ( >= 2.6.7.3 )
\|- amount	money	-	Значение суммы на оплату. Разделителем целой и дробной части суммы должна быть точка. Может быть не указанно при бронировании стола
\|- currency	guid	+	guid валюты (см. например список валют из PayOrder)
\|- cardCode	string	-	Карта лояльности, к которой привязана валюта
\|- promised	bool	-	false - обещанный платеж, true - предоплата
guestTypeId³	int	-	Идентификатор типа гостя. Если не указан, берется из настроек Параметры создания заказа на ресторане
discountIds^2,3	int[]/ object[]	-	Массив идентификаторов кассовых скидок. GetRefData(DISCOUNTS).Ident Только с версии агента 2.7.3.20
\|- id	int		Идентификатор скидки
\|- value	decimal		Значение скидки. Указывается сумма или процент. 0 — полное применение скидки. Можно задавать как положительное, так и отрицательные значения
source	string	-	Расширенное свойство Источник заказа GetRefData(ENUMSTYPESDATAS).EnumValue
platform	string	-	Только для заказов из Я.Се. Тип платформы (YA, DC), откуда пришел заказ
yandexPromos	array	-	Список промоакций сервиса Яндекс.Еда для всего заказа. Обслуживается только мультиагентом доставки
\|- type	string	+	Тип промо (GIFT/PERCENTAGE/FIXED/COFINANCE)
\|- discount	number	+	Значение промо скидки
\|- partnerDiscount	number	-	поля partnerDiscount и yandexDiscount появляются, если тип скидки COFINANCE
\|- yandexDiscount	number	-	поля partnerDiscount и yandexDiscount появляются, если тип скидки COFINANCE
payMethod	string	-	Способ оплаты
deliveryManager	string	-	Менеджер доставки — менеджер, который является основным менеджером по заказу
deliveryOperator	string	-	Доставка - оператор — оператор КЦ, который является основным оператором по заказу
isDeferred	string	-	Отложенный заказ — это признак в явном виде того, что заказ является отложенным
site	string	-	Место расчета
isCalcInInternet	boolean	-	Признак расчета в интернете
yndexEatsPartnerName	string	-	Имя партнёра
yndexEatsAuthorization	string	-	Токен, сформированный на стороне Яндекс Еды
yndexEatsOrderId	string	-	Идентификатор заказа во внешней системе

Примечания
1	На текущий момент игнорируется WSA2 (опечатки в названии полей на стороне WSA)
2	На текущий момент игнорируется DTO WS (полей нет в DTO)
3	Поле отсутствует в DTO мультиагента (сервис доставки)
4	Поле присутствует в DTO мультиагента (сервис доставки) но не используется в логике

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

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

Успешный ответ, заказ принят на кассе

{
  "taskResponse": {
     "order": {
        "orderGuid": "guid",
        "status":{
            "value": "string"
        },
        "substate": "string",
        "waiterId": number,
        "tableCode": number,
        "queuePosition": "string"
      }
  },
  "responseCommon": {
    "taskGuid": "guid",
    "taskType": "CreateOrder",
    "objectId": number
  }
}

CODE

Успешный ответ, заказ не принят на кассе

{
  "taskResponse": {
     "order": {
        "status": {
            "value": "string"
        },
        "rejectingReason": {
            "code": "string",
            "message": "string"
        }
      }
  },
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "CreateOrder",
    "objectId": number
  }
}

CODE

Параметр	Тип параметра	Обязательный	Описание
orderGuid	guid	+	Полученный из r_keeper Guid созданного заказа
tableCode	int	+	Код стола
status	object	+
\|- value	string	+	Статус заказа.
\|- isBillPrinted	bool	-	Флаг, показывающий, распечатан ли пречек заказа.
substate	string	+	Расширенный статус заказа
waiterId	number	-	Код официанта
rejectingReason		-
\|- code	string	-	Код отмены на кассе .
\| -message	string	-	Причина отмены заказа на кассе
error	string enum	-	Контейнер ошибок, см Описание ошибок
queuePosition	string?	-	Номер очереди, который генерирует RK7. WSA 2.7.7.1, RK7 7.06.05.459. Формируется по правилу: код кассы транслируется латинскую букву + последние цифры номера заказа
modifierStopList		-
-dishes	array		Массив модификаторов в стоп-листе.
– id	integer		Идентификатор блюда
– name	string		Название блюда
– type	string		Тип товара. ingredient

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

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

CODE

Параметр

Тип

Описание

taskGuid

guid

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

taskType

string

Тип задачи

objectId

int

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

error

string enum

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

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

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

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

{
    "taskType": "CreateOrder",
    "params": {
        "sync": {
            "objectId": "199990246",
            "timeout": 120
        },
        "order": {
            "booking":{
                "time": "2026-03-26T21:00:00",
                "duration":{
                    "hours": 2,
                    "minutes": 50
                }
            },
            "tableCode": 247,
            "personsQuantity": 1
        }
    }
}

{
  "taskType": "CreateOrder",
  "params": {
    "sync": {
      "objectId": 199995826,
      "timeout": 120
    },
    "order": {
      "originalOrderId": "string",
      "customer": {
        "name": "string",
        "phone": "string"
      },
      "payment": {
        "type": "string"
      },
      "expeditionType": "string",
      "delivery": {
        "expectedTime": "2008-10-17T00:00:00+0300",
        "address": {
          "subway": "string",
          "region": "string",
          "city": {
            "name": "string"
          },
          "street": {
            "name": "string"
          },
          "houseNumber": "string",
          "flatNumber": "string",
          "entrance": "string",
          "intercom": "string",
          "floor": "string",
          "coordinates": {
            "latitude": "string",
            "longitude": "string"
          },
          "comment":"string"
        }
      },
      "products": [
        {
          "id": "string",
          "name": "string",
          "price": "string",
          "quantity": 0,
          "ingredients": [
            {
              "id": "string",
              "name": "string",
              "quantity": 0,
              "price": "string"
            },
            {
              "id": "string",
              "name": "string",
              "quantity": 0,
              "price": "string"
            }
          ]
        },
        {
          "id": "string",
          "name": "string",
          "price": "string",
          "quantity": 0,
          "ingredients": [
            {
              "id": "string",
              "name": "string",
              "quantity": 0,
              "price": "string"
            },
            {
              "id": "string",
              "name": "string",
              "quantity": 0,
              "price": "string"
            }
          ]
        }
       ],
      "comment": "string",
      "price": {
        "total": 0
      },
      "personsQuantity": 0,
      "discountIds": [1000032],
// или
      "discountIds": [
                {
                    "id": 1000032,
                    "value": 11.50
                }
          ],
       "source": "kiosk"  
      }
  }
}

{
    "taskType": "CreateOrder",
    "params": {
        "sync": {
            "objectId": "199990377",
            "timeout": 120
        },
        "order": {
            "originalOrderId": "string",
            "customer": {
                "name": "string",
                "phone": "string"
             },
            "pickup": {
                "courier": {
                    "name": "string",
                    "phone": "string"
                 },
                "expectedTime": "{{currentdate}}T21:00:00+03:00",
                "taker": "customer"
            },
            "payment": {
                "type": "online"
            },
            "expeditionType": "pickup",
            "delivery": {
                "expectedTime": "2022-06-07T21:00:00+03:00",
                "address": {
                    "fullAddress": "string",
                    "subway": "string",
                    "region": "string",
                    "city": {
                        "name": "string"
                     },
                    "street": {
                        "name": "string"
                    },
                    "houseNumber": "string",
                    "flatNumber": "string",
                    "entrance": "string",
                    "intercom": "string",
                    "floor": "string",
                    "coordinates": {
                        "latitude": "string",
                        "longitude": "string"
                     }
                }
            },
            "products": [
                {
                    "id": "string",
                    "name": "string",
                    "price": number,
                    "quantity": "string"
                 }
            ],
            "comment": "Тестовый заказ. Оплата онлайн. Предоплата",
            "price": {
                "total": number
             },
            "personsQuantity": 0,
            "orderCategoryCode": 0,
            "orderTypeCode": 0
        }
    }
}

{
    "taskType": "CreateOrder",
    "params": {
        "sync": {
            "objectId": "199990377",
            "timeout": 120
        },
        "order": {
            "originalOrderId": "string",
            "customer": {
                "name": "string",
                "phone": "string"
            },
            "pickup": {
                "courier": {
                    "name": "string",
                    "phone": "string"
                },
                "expectedTime": "{{currentdate}}T21:00:00+03:00",
                "taker": "customer"
            },
            "payment": {
                "type": "card"
            },
            "expeditionType": "pickup",
            "delivery": {
                "expectedTime": "2022-06-07T21:00:00+03:00",
                "address": {
                    "fullAddress": "string",
                    "subway": "string",
                    "region": "53",
                    "city": {
                        "name": "string"
                    },
                    "street": {
                        "name": "string"
                    },
                    "houseNumber": "string",
                    "flatNumber": "string",
                    "entrance": "string",
                    "intercom": "string",
                    "floor": "string",
                    "coordinates": {
                        "latitude": "string",
                        "longitude": "string"
                    }
                }
            },
            "products": [
                {
                    "id": "string",
                    "name": "string",
                    "price": number,
                    "quantity": 1
                }
            ],
            "comment": "Тестовый заказ. Оплата картой",
            "price": {
                "total": number
            },
            "personsQuantity": 1,
            "orderCategoryCode": 1,
            "orderTypeCode": 4
        }
    }
}