---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
alternate:
  - https://yandex.ru/support/retail/ru/ref/send.notification.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/retail/ru/llms.txt

<div class="openapi">

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

<!-- markdownlint-disable-file -->

Метод позволяет Яндекс Еде передавать Партнёру назначение курьера, прибытие курьера в магазин.


## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-post);margin-bottom: 12px">

<div class="openapi__request">

POST {.openapi__method}
```text translate=no
/notifications/{placeId}
```

</div>

</div>

</div>

### Path parameters

#|
|| **Name** | **Description** ||
||

_placeId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

### Headers

#|
|| **Name** | **Description** ||
||

_Authorization_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

<div class="openapi-entity">

### Body

{% cut "application/json" %}

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

{% endcut %}

#|
|| **Name** | **Description** ||
||

_orderId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrderId](#entity-OrderId)

Идентификатор заказа в системе Партнёра. Формат свободный. Рекомендуется UUID4.

_Example:_{.json-schema-reset .json-schema-example} `03d3b69b-331c-4f84-b2c4-888b30320e63`
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [NotificationType](#entity-NotificationType)

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

_Enum:_{.json-schema-reset .json-schema-value} `courier_assigned`, `courier_arrived_to_place`
{.table-cell}
||
||

_courierName_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Имя курьера. При назначении робота-курьера будет передаваться значение "Робот-курьер [номер]".

_Example:_{.json-schema-reset .json-schema-example} `Иван`
{.table-cell}
||
||

_courierPhone_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Телефонный номер курьера. При назначении робота-курьера поле будет пустым.

_Example:_{.json-schema-reset .json-schema-example} `+74732006745,12099`
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### OrderId {#entity-OrderId}

Идентификатор заказа в системе Партнёра. Формат свободный. Рекомендуется UUID4.

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `03d3b69b-331c-4f84-b2c4-888b30320e63`

</div>

<div class="openapi-entity">

### NotificationType {#entity-NotificationType}

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

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `courier_assigned`, `courier_arrived_to_place`

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "id": "example",
  "orderId": "03d3b69b-331c-4f84-b2c4-888b30320e63",
  "type": "courier_assigned"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Идентификатор нотификации.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_orderId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrderId](#entity-OrderId)

Идентификатор заказа в системе Партнёра. Формат свободный. Рекомендуется UUID4.

_Example:_{.json-schema-reset .json-schema-example} `03d3b69b-331c-4f84-b2c4-888b30320e63`
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [NotificationType](#entity-NotificationType)

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

_Enum:_{.json-schema-reset .json-schema-value} `courier_assigned`, `courier_arrived_to_place`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
[
  {
    "code": 400,
    "description": "Description of error"
  }
]
```

{% endcut %}

**Type**: [ErrorItem](#entity-ErrorItem)[]

</div>

<div class="openapi-entity">

### ErrorItem {#entity-ErrorItem}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Согласованный с Яндекс Едой числовой код ошибки.
{.table-cell}
||
||

_description_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `Description of error`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "code": 400,
  "description": "Description of error"
}
```

{% endcut %}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.