Обновить информацию про курьера

Передается объект, содержащий актуальную информацию о курьере.

Request

PUT

/order/{orderId}/courier

Path parameters

Name

Description

orderId

Type: string

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

Example: ``

Body

application/json

{
  "courier": {
    "name": "Василий",
    "type": "pedestrian",
    "phone": "+79031111111 доб. 4432",
    "status": "accepted"
  },
  "order": {
    "orderNr": "190330-12345678",
    "batches": [
      "240425-1548210",
      "240425-1548211"
    ]
  },
  "location": {
    "latitude": "55.68195863024231",
    "longitude": "37.58948777728022"
  },
  "maxPlaceArrivalTime": "1937-01-01T12:00:27.870000+00:20"
}

Name	Description
courier	Type: CourierInfoCourier Example `{ "name": "Василий", "type": "pedestrian", "phone": "+79031111111 доб. 4432", "status": "accepted" }`
location	Type: CourierInfoLocation Example `{ "latitude": "55.68195863024231", "longitude": "37.58948777728022" }`
order	Type: CourierInfoOrder Example `{ "orderNr": "190330-12345678", "batches": [ "240425-1548210", "240425-1548211" ] }`
maxPlaceArrivalTime	Type: string<date-time> Рассчетное время прибытия курьера в ресторан в формате RFC3339 с дробной частью секунд (Y-m-d\TH:i:s.uP) Example: `1937-01-01T12:00:27.870000+00:20`

PhoneNumber

Номер телефона для связи с клиентом в международном формате. Состоит из частей "+<код страны><номер>". Может содержать добавочный номер: "+<код страны><номер> доб. <добавочный номер>".

Type: string

Example: +79031111111 доб. 4432

CourierInfoCourier

Name	Description
name	Type: string Имя курьера Example: `Василий`
type	Type: string Тип курьера: pedestrian - пешеход. bicycle - велосипед. vehicle - транспортное средство. motorcycle - мотоцикл. electric_bicycle - электрический велосипед. rover - ровер (робот-доставщик). Default: `pedestrian` Enum: `pedestrian`, `bicycle`, `vehicle`, `motorcycle`, `electric_bicycle`, `rover`
phone	Type: PhoneNumber Номер телефона для связи с клиентом в международном формате. Состоит из частей "+<код страны><номер>". Может содержать добавочный номер: "+<код страны><номер> доб. <добавочный номер>". Example: `+79031111111 доб. 4432`
status	Type: string Статус курьера accepted - принял заказ. arrived_to_source - прибыл на место. Default: `accepted` Enum: `accepted`, `arrived_to_source`

Example

{
  "name": "Василий",
  "type": "pedestrian",
  "phone": "+79031111111 доб. 4432",
  "status": "accepted"
}

CourierInfoOrder

Name

Description

orderNr

Type: string

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

Example: 190330-12345678

batches

Type: string[]

Список идентификаторов заказов в системе Яндекс.Еды, входящих в один батч вместе с текущим заказом. Если заказ не входит в батч — передаётся пустой массив. Если информация о батчах пока недоступна — поле отсутствует.

Example

[
  "240425-1548210",
  "240425-1548211"
]

Example

{
  "orderNr": "190330-12345678",
  "batches": [
    "240425-1548210",
    "240425-1548211"
  ]
}

CourierInfoLocation

Name

Description

latitude

Type: string

Example: 55.68195863024231

longitude

Type: string

Example: 37.58948777728022

Example

{
  "latitude": "55.68195863024231",
  "longitude": "37.58948777728022"
}

Responses

204 No Content

Информация о курьере успешно обновлена

400 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

404 Not Found

Заведение не найдено

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

Обновление статуса заказа со стороны Яндекс.Еды

Overview