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": "string",
    "recipient_info": {
        "first_name": "string",
        "last_name": "string",
        "partonymic": "string",
        "phone": "string",
        "email": "string"
    },
    "destination": {
        "type": "platform_station",
        "platform_station": {
            "platform_id": "string"
        },
        "custom_location": {
            "latitude": 0,
            "longitude": 0,
            "details": {
                "geoId": "213",
                "country": "Россия",
                "region": "Москва",
                "subRegion": "string",
                "locality": "Москва",
                "street": "Пролетарский проспект",
                "house": "19",
                "housing": "string",
                "apartment": "string",
                "building": "string",
                "comment": "string",
                "full_address": "Москва, Пролетарский проспект, 19",
                "postal_code": "string"
            }
        },
        "interval": {
            "from": 1635174000,
            "to": 1635174000
        },
        "interval_utc": {
            "from": "2021-10-25T15:00:00.000000Z",
            "to": "2021-10-25T15:00:00.000000Z"
        }
    },
    "last_mile_policy": "time_interval",
    "places": [
        {
            "barcode": "string",
            "place": {
                "physical_dims": {
                    "weight_gross": 0,
                    "dx": 0,
                    "dy": 0,
                    "dz": 0,
                    "predefined_volume": 0
                },
                "barcode": "string",
                "description": "string"
            }
        }
    ]
}

Name	Description
request_id*	Type: string ID заказа
destination	Type: DestinationRequestNode Информация о точке получения заказа.
last_mile_policy	Type: LastMilePolicy Требуемый способ доставки. Enum: `time_interval`, `self_pickup`
places	Type: EditPlace[] Данные о грузоместах. Редактируемое грузоместо
recipient_info	Type: Contact Данные о получателе.

DestinationRequestNode

Name	Description
type*	Type: string Тип целевой точки. Для доставки до двери — `custom_location` (2), для доставки до ПВЗ — `platform_station` (1) Enum: `platform_station`, `custom_location`
custom_location	Type: CustomLocation Полное описание целевого адреса доставки
interval	Type: TimeInterval Временной интервал (в UNIX)
interval_utc	Type: TimeIntervalUTC Временной интервал (в UTC)
platform_station	Type: PlatformStation Описание целевой станции в случае, если она зарегистрирована в платформе

LastMilePolicy

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

Type	Description
LastMilePolicy	Enum: `time_interval`, `self_pickup`

EditPlace

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

Name

Description

barcode*

Type: string

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

place

Type: ResourcePlace

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

Contact

Name	Description
first_name*	Type: string Имя
phone*	Type: string Номер телефона
email	Type: string Адрес электронной почты
last_name	Type: string Фамилия
partonymic	Type: string Отчество

CustomLocation

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

Name	Description
details	Type: LocationDetails Дополнительная информация о расположении станции
latitude	Type: number Широта
longitude	Type: number Долгота

TimeInterval

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

Name

Description

from

Type: integer

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

Example: 1635174000

Type: integer

UNIX timetamp для верхней границы интервала

Example: 1635174000

TimeIntervalUTC

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

Name

Description

from

Type: string

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

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

Type: string

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

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

PlatformStation

Name

Description

platform_id

Type: string

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

ResourcePlace

Name	Description
barcode*	Type: string Штрихкод коробки. По умолчанию штрихкод грузоместа подменяется на уникальный на стороне Яндекс Доставки. Чтобы использовать собственные штрихкоды или работать с кастомными маркировками, обратитесь к менеджеру. Для получения актуальных штрихкодов возмользуйтесь методом 3.03. Получение информации о заявке.
physical_dims*	Type: PlacePhysicalDimensions Физические параметры места
description	Type: string Описание коробки

LocationDetails

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

Name	Description
apartment	Type: string Номер квартиры
building	Type: string Строение
comment	Type: string Комментарий
country	Type: string Страна Example: `Россия`
full_address	Type: string Полный адрес с указанием города, улицы и номера дома Example: `Москва, Пролетарский проспект, 19`
geoId	Type: number Идентификатор города Example: `213`
house	Type: string Номер дома Example: `19`
housing	Type: string Корпус
locality	Type: string Населенный пункт Example: `Москва`
postal_code	Type: string Индекс
region	Type: string Регион Example: `Москва`
street	Type: string Улица Example: `Пролетарский проспект`
subRegion	Type: string Область

PlacePhysicalDimensions

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

Name	Description
dx*	Type: integer Длина, сантиметры
dy*	Type: integer Высота, сантиметры
dz*	Type: integer Ширина, сантиметры
weight_gross*	Type: integer Вес брутто, граммы
predefined_volume	Type: integer Объем (в см3)

Responses

200 OK

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

Body

application/json

{
    "completed_updates": [
        {
            "reason": "string",
            "status": "string",
            "type": "string",
            "error_details": [
                "string"
            ],
            "code": "string"
        }
    ],
    "active_updates": [
        {
            "reason": "string",
            "status": "string",
            "type": "string",
            "error_details": [
                "string"
            ],
            "code": "string"
        }
    ],
    "ignored_updates": [
        {
            "reason": "string",
            "status": "string",
            "type": "string",
            "error_details": [
                "string"
            ],
            "code": "string"
        }
    ],
    "edit_id": "string"
}

Name	Description
active_updates	Type: UpdateItem[] Выполняющиеся изменения заказа
completed_updates	Type: UpdateItem[] Выполненные изменения заказа
edit_id	Type: string ID операции редактирования
ignored_updates	Type: UpdateItem[] Невыполненные изменения заказа

UpdateItem

Name	Description
code	Type: string Код статуса
error_details	Type: string[] Описание ошибок изменения
reason	Type: string Причины формирования статуса
status	Type: string Статус изменения
type	Type: string Тип изменения

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

3.05. Получение актуальной информации о доставке

3.07. Получение интервалов доставки для текущего места получения заказа.