Курьерские нотификации

Метод для передачи курьерских нотификаций Партнёру.

Request

POST

/notifications/{placeId}

Path parameters

Name

Description

placeId*

Type: string

Уникальный идентификатор магазина в системе Партнёра.

Headers

Name

Description

Authorization*

Type: string

Токен, полученный в ответе на запрос /security/oauth/token

Body

application/json

{
    "courierName": "Иван",
    "courierPhone": "+74732006745,12099",
    "orderId": "03d3b69b-331c-4f84-b2c4-888b30320e63",
    "type": "courier_assigned"
}

Name	Description
orderId*	Type: string Идентификатор заказа в системе Партнёра. Формат свободный. Рекомендуется UUID4. Example: `03d3b69b-331c-4f84-b2c4-888b30320e63`
type*	Type: NotificationType Тип нотификации. Enum: `courier_assigned`, `courier_arrived_to_place`
courierName	Type: string Имя курьера. Для роботов формат - Робот-курьер [номер]. Example: `Иван`
courierPhone	Type: string Телефонный номер курьера (для роботов поле пустое). Example: `+74732006745,12099`

NotificationType

Тип нотификации.

Type	Description
NotificationType	Enum: `courier_assigned`, `courier_arrived_to_place`

Responses

200 OK

Body

application/json

{
    "id": "string",
    "orderId": "03d3b69b-331c-4f84-b2c4-888b30320e63",
    "type": "courier_assigned"
}

Name	Description
id*	Type: string Идентификатор нотификации.
orderId*	Type: string Идентификатор заказа в системе Партнёра. Формат свободный. Рекомендуется UUID4. Example: `03d3b69b-331c-4f84-b2c4-888b30320e63`
type*	Type: NotificationType Тип нотификации. Enum: `courier_assigned`, `courier_arrived_to_place`

400 Bad Request

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

Body

application/json

[
    {
        "code": 400,
        "description": "Description of error"
    }
]

ErrorItem[]

ErrorItem

Name

Description

code*

Type: integer

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

Example: 400

description*

Type: string

Описание ошибки

Example: Description of error

Была ли статья полезна?

❗️Обновление статуса заказа по инициативе Яндекс Еды

Открытие крышки робота-курьера