Курьерские нотификации
Метод позволяет Яндекс Еде передавать Партнёру назначение курьера, прибытие курьера в магазин.
Request
POST
/notifications/{placeId}
Path parameters
|
Name |
Description |
|
placeId |
Type: string Уникальный идентификатор магазина в системе Партнёра. Example: `` |
Headers
|
Name |
Description |
|
Authorization |
Type: string Токен, полученный в ответе на запрос Example: `` |
Body
application/json
{
"courierName": "Иван",
"courierPhone": "+74732006745,12099",
"orderId": "03d3b69b-331c-4f84-b2c4-888b30320e63",
"type": "courier_assigned"
}
|
Name |
Description |
|
orderId |
Type: OrderId Идентификатор заказа в системе Партнёра. Формат свободный. Рекомендуется UUID4. Example: |
|
type |
Type: NotificationType Тип нотификации. Enum: |
|
courierName |
Type: string Имя курьера. При назначении робота-курьера будет передаваться значение "Робот-курьер [номер]". Example: |
|
courierPhone |
Type: string Телефонный номер курьера. При назначении робота-курьера поле будет пустым. Example: |
OrderId
Идентификатор заказа в системе Партнёра. Формат свободный. Рекомендуется UUID4.
Type: string
Example: 03d3b69b-331c-4f84-b2c4-888b30320e63
NotificationType
Тип нотификации.
Type: string
Enum: courier_assigned, courier_arrived_to_place
Responses
200 OK
OK
Body
application/json
{
"id": "example",
"orderId": "03d3b69b-331c-4f84-b2c4-888b30320e63",
"type": "courier_assigned"
}
|
Name |
Description |
|
id |
Type: string Идентификатор нотификации. Example: |
|
orderId |
Type: OrderId Идентификатор заказа в системе Партнёра. Формат свободный. Рекомендуется UUID4. Example: |
|
type |
Type: NotificationType Тип нотификации. Enum: |
400 Bad Request
Ошибка в запросе. В ответе ожидается массив с объектом списка ошибок.
ErrorItem
|
Name |
Description |
|
code |
Type: integer Согласованный с Яндекс Едой числовой код ошибки. |
|
description |
Type: string Описание ошибки Example: |
Example
{
"code": 400,
"description": "Description of error"
}
No longer supported, please use an alternative and newer version.