3.06. Редактирование заказа

Заявка на редактирование заказа.
Для редактирования типа доставки, сроков доставки, адреса доставки необходимо сначала запросить доступные интервалы доставки с помощью метода Получение интервалов доставки для нового места получения заказа.
Если в ответе вернется массив options с доступными интервалами доставки, можно продолжить редактирование заказа с помощью этого же метода 3.06 Редактирование заказа.
Редактировать заказ можно:

  • До момента выезда курьера клиенту (до статуса DELIVERY_TRANSPORTATION_RECIPIENT)
  • До момента отгрузки заказа с СЦ на ПВЗ (до статуса DELIVERY_ARRIVED_PICKUP_POINT)
  • Редактировать можно адрес доставки, тип доставки (с ПВЗ на курьерскую доставку и наоборот), данные по получателю и штрих-код коробки

Request

POST

b2b.taxi.tst.yandex.net/api/b2b/platform/request/edit

Тестовое окружение

POST

b2b-authproxy.taxi.yandex.net/api/b2b/platform/request/edit

Продакшен-окружение

Body

application/json
{
  "request_id": "example",
  "recipient_info": {
    "first_name": "example",
    "last_name": "example",
    "patronymic": "example",
    "phone": "example",
    "email": "example"
  },
  "destination": {
    "type": "platform_station",
    "platform_station": {
      "platform_id": "example"
    },
    "custom_location": {
      "latitude": 0.5,
      "longitude": 0.5,
      "details": {
        "geoId": 213,
        "country": "Россия",
        "region": "Москва",
        "subRegion": "example",
        "locality": "Москва",
        "street": "Пролетарский проспект",
        "house": "19",
        "housing": "example",
        "apartment": "example",
        "building": "example",
        "comment": "example",
        "full_address": "Москва, Пролетарский проспект, 19",
        "postal_code": "example"
      }
    },
    "interval_utc": {
      "from": "2021-10-25T15:00:00.000000Z",
      "to": null
    }
  },
  "last_mile_policy": "time_interval",
  "places": [
    {
      "barcode": "example",
      "place": {
        "physical_dims": {
          "weight_gross": 0,
          "dx": 0,
          "dy": 0,
          "dz": 0,
          "predefined_volume": 0
        },
        "barcode": "example",
        "description": "example"
      }
    }
  ]
}

Name

Description

request_id

Type: string

ID заказа

Example: example

destination

Type: DestinationRequestNode

Информация о точке получения заказа.

Example
{
  "type": "platform_station",
  "platform_station": {
    "platform_id": "example"
  },
  "custom_location": {
    "latitude": 0.5,
    "longitude": 0.5,
    "details": {
      "geoId": 213,
      "country": "Россия",
      "region": "Москва",
      "subRegion": "example",
      "locality": "Москва",
      "street": "Пролетарский проспект",
      "house": "19",
      "housing": "example",
      "apartment": "example",
      "building": "example",
      "comment": "example",
      "full_address": "Москва, Пролетарский проспект, 19",
      "postal_code": "example"
    }
  },
  "interval_utc": {
    "from": "2021-10-25T15:00:00.000000Z",
    "to": null
  }
}

last_mile_policy

Type: LastMilePolicy

Требуемый способ доставки.

Типы полиси доставки последней мили. Может принимать значение только из enum.
time_interval: Доставка до двери в указанный интервал
self_pickup: Доставка до пункта выдачи

Enum: time_interval, self_pickup

places

Type: EditPlace[]

Данные о грузоместах.

Example
[
  {
    "barcode": "example",
    "place": {
      "physical_dims": {
        "weight_gross": 0,
        "dx": 0,
        "dy": 0,
        "dz": 0,
        "predefined_volume": 0
      },
      "barcode": "example",
      "description": "example"
    }
  }
]

recipient_info

Type: Contact

Данные о получателе.

Example
{
  "first_name": "example",
  "last_name": "example",
  "patronymic": "example",
  "phone": "example",
  "email": "example"
}

Contact

Name

Description

first_name

Type: string

Имя

Example: example

phone

Type: string

Номер телефона

Example: example

email

Type: string

Адрес электронной почты

Example: example

last_name

Type: string

Фамилия

Example: example

patronymic

Type: string

Отчество

Example: example
Example
{
  "first_name": "example",
  "last_name": "example",
  "patronymic": "example",
  "phone": "example",
  "email": "example"
}

PlatformStation

Name

Description

platform_id

Type: string

Идентификатор станции в Логистической платформе (например, склад отгрузки или ПВЗ)

Example: example
Example
{
  "platform_id": "example"
}

LocationDetails

Адрес квартиры обязателен при наличии

Name

Description

apartment

Type: string

Номер квартиры

Example: example

building

Type: string

Строение

Example: example

comment

Type: string

Комментарий

Example: example

country

Type: string

Страна

Example: Россия

full_address

Type: string

Полный адрес с указанием города, улицы и номера дома

Example: Москва, Пролетарский проспект, 19

geoId

Type: number

Идентификатор города

house

Type: string

Номер дома

Example: 19

housing

Type: string

Корпус

Example: example

locality

Type: string

Населенный пункт

Example: Москва

postal_code

Type: string

Индекс

Example: example

region

Type: string

Регион

Example: Москва

street

Type: string

Улица

Example: Пролетарский проспект

subRegion

Type: string

Область

Example: example
Example
{
  "geoId": 213,
  "country": "Россия",
  "region": "Москва",
  "subRegion": "example",
  "locality": "Москва",
  "street": "Пролетарский проспект",
  "house": "19",
  "housing": "example",
  "apartment": "example",
  "building": "example",
  "comment": "example",
  "full_address": "Москва, Пролетарский проспект, 19",
  "postal_code": "example"
}

CustomLocation

Информация о произвольной точке. Точка может быть задана либо своими координатами — пара (latitude, longitude), либо адресом

Name

Description

details

Type: LocationDetails

Дополнительная информация о расположении станции

Адрес квартиры обязателен при наличии

Example
{
  "geoId": 213,
  "country": "Россия",
  "region": "Москва",
  "subRegion": "example",
  "locality": "Москва",
  "street": "Пролетарский проспект",
  "house": "19",
  "housing": "example",
  "apartment": "example",
  "building": "example",
  "comment": "example",
  "full_address": "Москва, Пролетарский проспект, 19",
  "postal_code": "example"
}

latitude

Type: number

Широта

longitude

Type: number

Долгота
Example
{
  "latitude": 0.5,
  "longitude": 0.5,
  "details": {
    "geoId": 213,
    "country": "Россия",
    "region": "Москва",
    "subRegion": "example",
    "locality": "Москва",
    "street": "Пролетарский проспект",
    "house": "19",
    "housing": "example",
    "apartment": "example",
    "building": "example",
    "comment": "example",
    "full_address": "Москва, Пролетарский проспект, 19",
    "postal_code": "example"
  }
}

TimestampUTC

Type: string

Example: 2021-10-25T15:00:00.000000Z

TimeIntervalUTC

Интервал времени в формате UTC.

Name

Description

from

Type: TimestampUTC

UTC timestamp для нижней границы интервала

Example: 2021-10-25T15:00:00.000000Z

to

Type: TimestampUTC

UTC timestamp для верхней границы интервала

Example: 2021-10-25T15:00:00.000000Z
Example
{
  "from": "2021-10-25T15:00:00.000000Z",
  "to": null
}

DestinationRequestNode

Name

Description

type

Type: string

Тип целевой точки. Для доставки до двери — custom_location (2), для доставки до ПВЗ — platform_station (1)

Enum: platform_station, custom_location

custom_location

Type: CustomLocation

Полное описание целевого адреса доставки

Информация о произвольной точке. Точка может быть задана либо своими координатами — пара (latitude, longitude), либо адресом

Example
{
  "latitude": 0.5,
  "longitude": 0.5,
  "details": {
    "geoId": 213,
    "country": "Россия",
    "region": "Москва",
    "subRegion": "example",
    "locality": "Москва",
    "street": "Пролетарский проспект",
    "house": "19",
    "housing": "example",
    "apartment": "example",
    "building": "example",
    "comment": "example",
    "full_address": "Москва, Пролетарский проспект, 19",
    "postal_code": "example"
  }
}

interval_utc

Type: TimeIntervalUTC

Временной интервал (в UTC)

Интервал времени в формате UTC.

Example
{
  "from": "2021-10-25T15:00:00.000000Z",
  "to": null
}

platform_station

Type: PlatformStation

Описание целевой станции в случае, если она зарегистрирована в платформе

Example
{
  "platform_id": "example"
}
Example
{
  "type": "platform_station",
  "platform_station": {
    "platform_id": "example"
  },
  "custom_location": {
    "latitude": 0.5,
    "longitude": 0.5,
    "details": {
      "geoId": 213,
      "country": "Россия",
      "region": "Москва",
      "subRegion": "example",
      "locality": "Москва",
      "street": "Пролетарский проспект",
      "house": "19",
      "housing": "example",
      "apartment": "example",
      "building": "example",
      "comment": "example",
      "full_address": "Москва, Пролетарский проспект, 19",
      "postal_code": "example"
    }
  },
  "interval_utc": {
    "from": "2021-10-25T15:00:00.000000Z",
    "to": null
  }
}

LastMilePolicy

Типы полиси доставки последней мили. Может принимать значение только из enum.
time_interval: Доставка до двери в указанный интервал
self_pickup: Доставка до пункта выдачи

Type: string

Enum: time_interval, self_pickup

PlacePhysicalDimensions

Весогабаритные характеристики грузомест

Name

Description

dx

Type: integer

Длина, сантиметры

dy

Type: integer

Высота, сантиметры

dz

Type: integer

Ширина, сантиметры

weight_gross

Type: integer

Вес брутто, граммы

predefined_volume

Type: integer

Объем (в см3)
Example
{
  "weight_gross": 0,
  "dx": 0,
  "dy": 0,
  "dz": 0,
  "predefined_volume": 0
}

ResourcePlace

Name

Description

barcode

Type: string

Штрихкод коробки.
По умолчанию штрихкод грузоместа подменяется на уникальный на стороне Яндекс Доставки.
Чтобы использовать собственные штрихкоды или работать с кастомными маркировками, обратитесь к менеджеру.
Для получения актуальных штрихкодов воспользуйтесь методом 3.03. Получение информации о заявке.

Example: example

physical_dims

Type: PlacePhysicalDimensions

Физические параметры места

Весогабаритные характеристики грузомест

Example
{
  "weight_gross": 0,
  "dx": 0,
  "dy": 0,
  "dz": 0,
  "predefined_volume": 0
}

description

Type: string

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

Example: example
Example
{
  "physical_dims": {
    "weight_gross": 0,
    "dx": 0,
    "dy": 0,
    "dz": 0,
    "predefined_volume": 0
  },
  "barcode": "example",
  "description": "example"
}

EditPlace

Редактируемое грузоместо

Name

Description

barcode

Type: string

Старый штрихкод грузоместа

Example: example

place

Type: ResourcePlace

Новое грузоместо

Example
{
  "physical_dims": {
    "weight_gross": 0,
    "dx": 0,
    "dy": 0,
    "dz": 0,
    "predefined_volume": 0
  },
  "barcode": "example",
  "description": "example"
}
Example
{
  "barcode": "example",
  "place": {
    "physical_dims": {
      "weight_gross": 0,
      "dx": 0,
      "dy": 0,
      "dz": 0,
      "predefined_volume": 0
    },
    "barcode": "example",
    "description": "example"
  }
}

Responses

200 OK

Успешный запрос

Body

application/json
{
  "completed_updates": [
    {
      "reason": "example",
      "status": "example",
      "type": "example",
      "error_details": [
        "example"
      ],
      "code": "example"
    }
  ],
  "active_updates": [
    null
  ],
  "ignored_updates": [
    null
  ],
  "edit_id": "example"
}

Name

Description

active_updates

Type: UpdateItem[]

Выполняющиеся изменения заказа

Example
[
  {
    "reason": "example",
    "status": "example",
    "type": "example",
    "error_details": [
      "example"
    ],
    "code": "example"
  }
]

completed_updates

Type: UpdateItem[]

Выполненные изменения заказа

Example
[
  {
    "reason": "example",
    "status": "example",
    "type": "example",
    "error_details": [
      "example"
    ],
    "code": "example"
  }
]

edit_id

Type: string

ID операции редактирования

Example: example

ignored_updates

Type: UpdateItem[]

Невыполненные изменения заказа

Example
[
  {
    "reason": "example",
    "status": "example",
    "type": "example",
    "error_details": [
      "example"
    ],
    "code": "example"
  }
]

UpdateItem

Name

Description

code

Type: string

Код статуса

Example: example

error_details

Type: string[]

Описание ошибок изменения

Example
[
  "example"
]

reason

Type: string

Причины формирования статуса

Example: example

status

Type: string

Статус изменения

Example: example

type

Type: string

Тип изменения

Example: example
Example
{
  "reason": "example",
  "status": "example",
  "type": "example",
  "error_details": [
    "example"
  ],
  "code": "example"
}

No longer supported, please use an alternative and newer version.

Предыдущая
3.05. Получение актуальной информации о доставке
Следующая
3.07. Получение интервалов доставки для текущего места получения заказа.