Передать отзыв клиента по заказу.

Передать отзыв клиента по заказу.

Примечание

Метод доступен только по подписке.

Метод для предоставления ответа на отзыв находится в блоке Vendor Management Integration API.

Request

POST

/v1/feedback

Body

application/json
{
  "feedback": {
    "id": "example",
    "createdAt": "1937-01-01T12:00:27.870000+00:20",
    "eatsId": "190330-12345678",
    "orderId": "example",
    "predefinedComment": "example",
    "comment": "example",
    "restaurantId": "example",
    "rating": 5,
    "takenAt": "1937-01-01T12:00:27+00:20",
    "deliveredAt": "1937-01-01T12:00:27+00:20"
  },
  "orderInfo": {
    "createdAt": "1937-01-01T12:00:27.870000+00:20",
    "platform": "YE",
    "discriminator": "marketplace",
    "deliveryInfo": {
      "clientName": "Иванов Иван Иванович"
    },
    "paymentInfo": {
      "total": 200.99
    },
    "items": [
      {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "name": "Пицца Пепперони",
        "quantity": 3.5,
        "price": 100,
        "modifications": [
          {}
        ]
      }
    ],
    "comment": "Дополнительная информация о заказе: ..."
  }
}

Name

Description

feedback

Type: Feedback

Информация об отзыве клиента

Example
{
  "id": "example",
  "createdAt": "1937-01-01T12:00:27.870000+00:20",
  "eatsId": "190330-12345678",
  "orderId": "example",
  "predefinedComment": "example",
  "comment": "example",
  "restaurantId": "example",
  "rating": 5,
  "takenAt": "1937-01-01T12:00:27+00:20",
  "deliveredAt": "1937-01-01T12:00:27+00:20"
}

orderInfo

Type: OrderInfo

Информация о заказе

Example
{
  "createdAt": "1937-01-01T12:00:27.870000+00:20",
  "platform": "YE",
  "discriminator": "marketplace",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович"
  },
  "paymentInfo": {
    "total": 200.99
  },
  "items": [
    {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "name": "Пицца Пепперони",
      "quantity": 3.5,
      "price": 100,
      "modifications": [
        {
          "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
          "name": "Европейские приборы",
          "quantity": 3,
          "price": 100
        }
      ]
    }
  ],
  "comment": "Дополнительная информация о заказе: ..."
}

Feedback

Информация об отзыве клиента

Name

Description

createdAt

Type: string<date-time>

Дата создания отзыва в формате RFC3339 с дробной частью секунд (Y-m-d\TH:i:s.uP)

Example: 1937-01-01T12:00:27.870000+00:20

deliveredAt

Type: string<date-time>

Дата, когда заказ был доставлен в формате ISO 8601 без дробной части секунд (Y-m-d\TH:i:s+hh:ss)

Example: 1937-01-01T12:00:27+00:20

eatsId

Type: string

Сквозной идентификатор заказа на стороне Яндекс.Еды в формате DDDDDD-DDDDDDDD

Example: 190330-12345678

orderId

Type: string

Идентификатор заказа в системе партнера

Example: example

rating

Type: integer

Оценка клиента по заказу от 1 до 5

restaurantId

Type: string

Идентификатор ресторана в системе партнера

Example: example

comment

Type: string

Текстовый отзыв клиента по заказу

Example: example

id

Type: string

Идентификатор отзыва на стороне Яндекс.Еды

Example: example

predefinedComment

Type: string

Предопредленные комметарии на стороне Яндекс.Еды, выбранные клиентом

Example: example

takenAt

Type: string<date-time>

Дата, когда курьер забрал заказ из ресторана, в формате ISO 8601 без дробной части секунд (Y-m-d\TH:i:s+hh:ss)

Example: 1937-01-01T12:00:27+00:20
Example
{
  "id": "example",
  "createdAt": "1937-01-01T12:00:27.870000+00:20",
  "eatsId": "190330-12345678",
  "orderId": "example",
  "predefinedComment": "example",
  "comment": "example",
  "restaurantId": "example",
  "rating": 5,
  "takenAt": "1937-01-01T12:00:27+00:20",
  "deliveredAt": "1937-01-01T12:00:27+00:20"
}

DeliveryInfo

Name

Description

clientName

Type: string

Имя клиента в сервисе Яндекс Еда

Example: Иванов Иван Иванович
Example
{
  "clientName": "Иванов Иван Иванович"
}

PaymentInfo

Name

Description

total

Type: number

Общая стоимость заказа
Example
{
  "total": 200.99
}

ModificationsItem

Name

Description

id

Type: string

ID модификатора в системе партнера

Example: 937c57f6-4508-4858-be7f-20691a16fbb0

price

Type: number

Цена модификатора для пункта меню (например - дополнительный соус)

quantity

Type: integer

Количество в заказе

name

Type: string

Наименование модификатора

Example: Европейские приборы
Example
{
  "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "name": "Европейские приборы",
  "quantity": 3,
  "price": 100
}

OrderInfoItem

Name

Description

id

Type: string

ID позиции меню в системе партнера

Example: 937c57f6-4508-4858-be7f-20691a16fbb0

modifications

Type: ModificationsItem[]

Список выбранных модификаций. Может быть пустым, передаётся
явно для каждой отдельной позиции в заказе. При заказе двух позиций
одного и того же блюда с разным набором модификаций передаются разные
позиции с разными списками modifications.

Example
[
  {
    "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "name": "Европейские приборы",
    "quantity": 3,
    "price": 100
  }
]

price

Type: number

Стоимость одной позиции вместе со стоимостью модификаций. В следующей версии будет исправлено на чистую цену позиции без модификаций

quantity

Type: number

Количество позиции в заказе

name

Type: string

Наименование позиции меню

Example: Пицца Пепперони
Example
{
  "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "name": "Пицца Пепперони",
  "quantity": 3.5,
  "price": 100,
  "modifications": [
    {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "name": "Европейские приборы",
      "quantity": 3,
      "price": 100
    }
  ]
}

OrderInfo

Информация о заказе

Name

Description

comment

Type: string

Дополнительная информация о заказе

Example: Дополнительная информация о заказе: ...

createdAt

Type: string<date-time>

Дата создания отзыва в формате RFC3339 с дробной частью секунд (Y-m-d\TH:i:s.uP)

Example: 1937-01-01T12:00:27.870000+00:20

deliveryInfo

Type: DeliveryInfo

Информация о доставке

Example
{
  "clientName": "Иванов Иван Иванович"
}

discriminator

Type: string

Тип доставки заказа:

yandex - доставка курьерами Яндекс Еда
marketplace - доставка курьерами ресторана
pickup - самовывоз клиентом из ресторана

Enum: marketplace, yandex, pickup

items

Type: OrderInfoItem[]

Example
[
  {
    "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "name": "Пицца Пепперони",
    "quantity": 3.5,
    "price": 100,
    "modifications": [
      {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "name": "Европейские приборы",
        "quantity": 3,
        "price": 100
      }
    ]
  }
]

paymentInfo

Type: PaymentInfo

Example
{
  "total": 200.99
}

platform

Type: string

Идентификатор платформы. YE - Yandex Eda, DC - Delivery club

Enum: YE, DC
Example
{
  "createdAt": "1937-01-01T12:00:27.870000+00:20",
  "platform": "YE",
  "discriminator": "marketplace",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович"
  },
  "paymentInfo": {
    "total": 200.99
  },
  "items": [
    {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "name": "Пицца Пепперони",
      "quantity": 3.5,
      "price": 100,
      "modifications": [
        {
          "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
          "name": "Европейские приборы",
          "quantity": 3,
          "price": 100
        }
      ]
    }
  ],
  "comment": "Дополнительная информация о заказе: ..."
}

Responses

200 OK

Отзыв успешно обработан внутренней системой ресторана.

Body

application/json
{
  "result": "OK"
}

Name

Description

result

Type: string

Example: OK

400 Bad Request

Bad request. Ошибка в параметрах, В теле ответа ожидается массив с объектом из списка ошибок

Body

application/json
[
  {
    "code": 100,
    "description": "Description of error"
  }
]

Type: ErrorItem[]

ErrorItem

Name

Description

code

Type: integer

Согласованный с Яндекс.Еда числовой код ошибки

description

Type: string

Сообщение об ошибке

Example: Description of error
Example
{
  "code": 100,
  "description": "Description of error"
}

401 Unauthorized

Не пройдена авторизация - истек токен, либо не был передан в
запросе. Будет сделан ретрай.

Body

application/json
{
  "reason": "Access token has been expired. You should request a new one"
}

Name

Description

reason

Type: string

Причина, по которой не прошла авторизация

Example: Access token has been expired. You should request a new one

500 Internal Server Error

Внутренние ошибки сервера.

Body

application/json
[
  {
    "code": 100,
    "description": "Description of error"
  }
]

Type: ErrorItem[]

Предыдущая
Overview
Следующая
Overview