История продаж

Получить пробитые в торговых точках заказы можно методом /order/list

POST https://api.ytimes.ru/ex/order/list

Path Parameters

Name	Type	Description
page	number	Номер страницы списка. За один раз можно получить не более 100 позиций

Headers

Name	Type	Description
Authorization	string	Ключ авторизации

Request Body

В запросе необходимо передать JSON фильтра: { "dateFrom": "01.01.2024", //обязательное поле "dateTo": "31.01.2024", //обязательное поле "shopGuid": "46b9eaa1-e594-4af3-a203-35d5a8f9cec0" //обязательное поле }

Идентификатор торговой точки в данном методе обязателен.

Response Body

HTTP 200

{
  "success": true,
  "count": 1,
  "rows": [
    {
      //Идентификатор заказа (счета)
      "guid": "e9a13ec1-6f69-4c24-9d3f-39eb25ead437-1705509830777",
      //Номер продажи внутри смены
      "checkNum": 1,
      "isDeleted": false,
      //Дата и номер смены, к которой относится продажа
      "shiftDate": "17.01.2024",
      "shiftNum": 1,
      //ID и имя кассира, кто принял оплату за этот заказ
      "userId": 59851,
      "userName": "Петров И.О.",
      //ID и имя официанта, кто был указан в заказе
      "tableStaffId": null,
      "tableStaffName": null,
      //Дата открытия и закрытия заказа (счета)
      "startDateTime": "17.01.2024 19:43:50",
      "endDateTime": "17.01.2024 19:44:05",
      //Список персон, делавших заказ
      "personList": [
        {
          //Идентификатор и имя персоны 
          "guid": "20270cf9-c57d-4cb4-b813-9b099211c3da-1705509831890",
          "isDeleted": false,
          "name": "Гость 1",
          //Позиции, которые заказала эта персона
          "orderList": [
            {
              //Идентификатор позиции
              "guid": "6bea17a5-034c-4fc7-a389-da83f0ea7c6a-1705509842325",
              "isDeleted": false,
              "number": 1,
              //Какой сотрудник добавил позицию в чек
              "createdUserId": 59851,
              "createdDateTime": "17.01.2024 19:44:05",
              "completedDateTime": "17.01.2024 19:44:05",
              "canceledDateTime": null,
              //Тип позиции меню - тех карте, товар, услуга и прочее
              "menuType": "RECIPE",
              "menuItemName": "Американо",
              "menuTypeName": "250мл с собой",
              "menuOrderType": "TOGO",
              "supplementText": null,
              //Цена позиции
              "itemPrice": 150.0,
              "discountValue": 0.0,
              "discountPercent": 0,
              //Цена с учетом скидки
              "priceWithDiscount": 150.0,
              //Цена с учетом скидки, заданная кассиром вручную
              "manualPriceWithDiscount": null,
              //Использованные на эту позицию бонусы (вычитаются из priceWithDiwcount)
              "usedPoints": 0.0,
              "addPoints": null,
              "orderPromoNum": null,
              "source": null
            }
          ],
          //Сколько всего персона потатила бонусов на все заказы
          "totalUsedPoints": 0.0,
          "comment": null
        }
      ],
      //Сумма оплаты заказа (счета) безналичными
      "paymentCreditValue": 150.0,
      //Сумма оплаты заказа (счета) наличными
      "paymentCashValue": 0.0,
      //Идентификатор и сумма оплаты заказа (счета) иными способами оплаты
      "paymentTypeSettingsId": null,
      "paymentTypeValue": null
    }
  ],
  "error": null
}