- Request
- Query parameters
- Headers
- Body
- CargoItemSizes
- Currency
- Money
- VatCodeStrApi
- SupplierInn
- ItemArticle
- ItemMark
- ItemType
- ItemFiscalization
- V2CargoItem
- ContactOnPoint
- AddressFullname
- PointAddress
- CargoPointSkipConfirmation
- PointType
- PaymentMethod
- RequestBuyout
- Inn
- RequestCustomerFiscalization
- RequestPaymentOnDelivery
- ExternalOrderCost
- PickupCode
- V2CargoPoint
- V2CargoRoutePoints
- ContactWithPhone
- CargoType
- CargoOptions
- ClientRequirements
- CallbackProperties
- SkipDoorToDoor
- SkipClientNotify
- SkipEmergencyNotify
- SkipAct
- OptionalReturn
- Due
- SameDayData
- Responses
- 200 OK
- Body
- ClaimId
- CorpClientId
- CargoPointAddress
- PointVisitStatus
- PaymentId
- ClientOrderId
- PaymentComplete
- CustomerFiscalization
- InvoiceLink
- ResponsePaymentOnDelivery
- ExpectedVisitInterval
- PointVisitTime
- V2ResponseCargoPoint
- V2ResponseCargoRoutePoints
- ClaimPointId
- ClaimStatus
- HumanErrorMessage
- Eta
- TaxiOfferId
- TaxiOfferDeprecated
- TaxiOffer
- CurrencyRules
- ClaimPricing
- AvailableCancelState
- MatchedCar
- ClaimWarningSourceApi
- ClaimWarningCodeApi
- ClaimWarning
- PerformerInfo
- 400 Bad Request
- 403 Forbidden
- 404 Not Found
- 409 Conflict
- 429 Too Many Requests
Редактирование заявки до подтверждения
Метод изменяет параметры заявки до принятия оффера (до операции claims/accept)
Request
POST
b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/edit
Адрес сервиса
Query parameters
|
Name |
Description |
|
claim_id |
Type: string ID заявки, полученный на этапе создания заявки Min length: Max length: Example: `` |
|
version |
Type: integer Версия, с которой идет изменение (int64) |
Headers
|
Name |
Description |
|
Accept-Language |
Type: string Предпочитаемый язык ответа Например: Example: |
Body
application/json
{
"shipping_document": "example",
"items": [
{
"extra_id": "БП-208",
"pickup_point": 1,
"dropoff_point": 2,
"droppof_point": 0,
"title": "Плюмбус",
"size": {
"length": 0.1,
"width": 0.2,
"height": 0.3
},
"weight": 2,
"cost_value": "2.00",
"cost_currency": "RUB",
"quantity": 1,
"fiscalization": {
"excise": "12.50",
"vat_code_str": "vat_none",
"supplier_inn": "3664069397",
"article": "20ML50OWKY4FC86",
"mark": {
"kind": "gs1_data_matrix_base64",
"code": "444D00000000003741"
},
"item_type": "product"
},
"age_restricted": false
}
],
"route_points": [
{
"point_id": 6987,
"visit_order": 1,
"contact": {
"name": "Морти",
"phone": "+79099999998",
"phone_additional_code": "602 17 500",
"email": "example@yandex.ru"
},
"address": {
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"shortname": "Большая Монетная улица, 1к1А",
"coordinates": [
0.5,
0.5
],
"country": "Россия",
"city": "Санкт-Петербург",
"building_name": "БЦ На Большой Монетной",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1",
"door_code": "169",
"door_code_extra": "код на вход во двор #1234, код от апартаментов #4321",
"doorbell_name": "Магидович",
"comment": "Домофон не работает",
"uri": "ymapsbm1://geo?ll=38.805%2C55.084",
"description": "Санкт-Петербург, Россия"
},
"skip_confirmation": false,
"leave_under_door": true,
"meet_outside": true,
"no_door_call": true,
"type": "source",
"buyout": {
"payment_method": "card"
},
"payment_on_delivery": {
"customer": {
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
},
"payment_method": null
},
"external_order_id": "100",
"external_order_cost": {
"value": "100.0",
"currency": "RUB",
"currency_sign": "₽"
},
"pickup_code": "893422",
"should_notify_on_order_readiness": false
},
{
"point_id": 6987,
"visit_order": 1,
"contact": {
"name": "Морти",
"phone": "+79099999998",
"phone_additional_code": "602 17 500",
"email": "example@yandex.ru"
},
"address": {
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"shortname": "Большая Монетная улица, 1к1А",
"coordinates": [
0.5,
0.5
],
"country": "Россия",
"city": "Санкт-Петербург",
"building_name": "БЦ На Большой Монетной",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1",
"door_code": "169",
"door_code_extra": "код на вход во двор #1234, код от апартаментов #4321",
"doorbell_name": "Магидович",
"comment": "Домофон не работает",
"uri": "ymapsbm1://geo?ll=38.805%2C55.084",
"description": "Санкт-Петербург, Россия"
},
"skip_confirmation": false,
"leave_under_door": true,
"meet_outside": true,
"no_door_call": true,
"type": "source",
"buyout": {
"payment_method": "card"
},
"payment_on_delivery": {
"customer": {
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
},
"payment_method": null
},
"external_order_id": "100",
"external_order_cost": {
"value": "100.0",
"currency": "RUB",
"currency_sign": "₽"
},
"pickup_code": "893422",
"should_notify_on_order_readiness": false
}
],
"emergency_contact": {
"name": "Рик",
"phone": "+79826810246",
"phone_additional_code": "602 17 500"
},
"client_requirements": {
"taxi_class": "express",
"taxi_classes": [
"express"
],
"cargo_type": "lcv_m",
"cargo_loaders": 0,
"cargo_options": [
"thermobag"
],
"pro_courier": false,
"assign_robot": true,
"rental_duration": 0
},
"callback_properties": {
"callback_url": "https://www.example.com/"
},
"skip_door_to_door": false,
"skip_client_notify": false,
"skip_emergency_notify": false,
"skip_act": false,
"optional_return": false,
"due": "2020-01-01T00:00:00+00:00",
"comment": "Ресторан",
"referral_source": "bitrix",
"same_day_data": {
"delivery_interval": {
"from": "2020-01-01T07:00:00+00:00",
"to": "2020-01-01T07:00:00+00:00"
}
},
"auto_accept": true,
"offer_payload": "asjdijasDKL;ahsdfljhlkjhasF;HS;Ldjf;ljloshf"
}
|
Name |
Description |
|
items |
Type: V2CargoItem[] Параметры товаров Min items: Example
|
|
route_points |
Type: V2CargoRoutePoints Информация по точкам маршрута Min items: Example
|
|
auto_accept |
Type: boolean Включить автоматическое подтверждение заявки после создания. Для использования данной опции требуется согласование менеджера |
|
callback_properties |
Type: CallbackProperties Параметры уведомления сервера клиента о смене статуса заявки. Уведомление представляет собой POST-запрос по указанному url, к Важно: параметры добавляются конкатенацией к callback_url, то есть Поддерживаются только http и https. При https ssl-сертификат должен К уведомлениям следует относиться как к push ahead of polling, как Клиенту следует учесть, что ответ операции claims/info может Example
|
|
client_requirements |
Type: ClientRequirements Требования от клиента, указанные при создании или редактировании заявки Example
|
|
comment |
Type: string Комментарий к заказу Example: |
|
due |
Type: Due Желаемое время прибытия исполнителя на точку А (source). Параметр не совместим с опциями замедления в тарифе Example: |
|
emergency_contact |
Type: ContactWithPhone Информация о контактном лице с номером телефона Example
|
|
offer_payload |
Type: string Payload, полученный методом offers/calculate Example: |
|
optional_return |
Type: OptionalReturn Отключить возврат товаров в случае отмены заказа. Возможные значения:
Default: Example: |
|
referral_source |
Type: string Источник заявки (можно передать наименование CMS, из которой создается запрос) Example: |
|
same_day_data |
Type: SameDayData Признаки заказа "В течение дня" Дополнительная информация для заявок Example
|
|
shipping_document |
Type: string Сопроводительные документы Example: |
|
skip_act |
Type: SkipAct Не показывать акт приема-передачи Example: |
|
skip_client_notify |
Type: SkipClientNotify Не отправлять отправителю/получателю смс-уведомления, Значение по умолчанию: false (отправлять уведомления) Default: Example: |
|
skip_door_to_door |
Type: SkipDoorToDoor Отключить доставку до двери (выключить опцию "От двери до двери"). Возможные значения:
Default: Example: |
|
skip_emergency_notify |
Type: SkipEmergencyNotify Не отправлять уведомление запасному контактному лицу Значение по умолчанию: false (отправлять уведомления) Default: Example: |
CargoItemSizes
Габариты товара в метрах. В полях следует передавать актуальные значения.
Если габариты не были переданы, заказ оформляется с учетом
максимально допустимых габаритов для выбранного тарифа.
Если фактические характеристики товара превысят допустимые,
курьер вправе отказаться от выполнения такого заказа на месте.
В этом случае будет удержана стоимость подачи.
Курьер (courier): до 0.80 м × 0.50 м × 0.50 м
Экспресс (express): до 1.00 м × 0.60 м × 0.50 м
Грузовой (cargo):
- Маленький кузов: до 1.70 м × 0.96 м × 0.90 м
- Средний кузов: до 2.60 м × 1.30 м × 1.50 м
- Большой кузов: до 3.80 м × 1.80 м × 1.80 м
|
Name |
Description |
|
height |
Type: number Высота в метрах Min value: Max value: |
|
length |
Type: number Длина в метрах Min value: Max value: |
|
width |
Type: number Ширина в метрах Min value: Max value: |
Example
{
"length": 0.1,
"width": 0.2,
"height": 0.3
}
Currency
Трехзначный код валюты, в которой ведется расчет
Type: string
Min length: 3
Max length: 3
Example: RUB
Money
Стоимость доставки в формате десятичной дроби Decimal(18, 4)
Type: string
Pattern: ^-?[0-9]{1,14}(\.[0-9]{0,4})?$
Example: 12.50
VatCodeStrApi
Ставка НДС. Возможные значения:
vat_none - без НДС;
vat0 - нулевая ставка НДС (применяется в редких случаях);
vat10 - ставка НДС 10%;
vat20 - ставка НДС 20%.
Type: string
Example: vat_none
SupplierInn
ИНН поставщика (10 или 12 цифр).
Type: string
Pattern: ^[A-Z0-9\\-]+$
Example: 3664069397
ItemArticle
Артикул товара.
Должен быть уникальным для товаров, передаваемых из одной точки.
Type: string
Example: 20ML50OWKY4FC86
ItemMark
Уникальный код товара (КИЗ). Актуален для РФ.
Если товары имеют уникальный код, то на каждый товар необходимо создать отдельный блок
|
Name |
Description |
|
code |
Type: string Код маркировки товара в соответствии с форматом kind Example: |
|
kind |
Type: string Тип маркировки.
Example: |
Example
{
"kind": "gs1_data_matrix_base64",
"code": "444D00000000003741"
}
ItemType
Тип наименования: товар или услуга.
Значение по умолчанию: product
Type: string
Enum: product, service
ItemFiscalization
Информация по фискализации (актуально для оплаты при получении)
|
Name |
Description |
|
article |
Type: ItemArticle Артикул товара. Example: |
|
excise |
Type: Money Сумма акциза Стоимость доставки в формате десятичной дроби Decimal(18, 4) Pattern: Example: |
|
item_type |
Type: ItemType Тип наименования: товар или услуга. Enum: |
|
mark |
Type: ItemMark Уникальный код товара (КИЗ). Актуален для РФ. Example
|
|
supplier_inn |
Type: SupplierInn ИНН поставщика (10 или 12 цифр). Pattern: Example: |
|
vat_code_str |
Type: VatCodeStrApi Ставка НДС. Возможные значения: Example: |
Example
{
"excise": "12.50",
"vat_code_str": "vat_none",
"supplier_inn": "3664069397",
"article": "20ML50OWKY4FC86",
"mark": {
"kind": "gs1_data_matrix_base64",
"code": "444D00000000003741"
},
"item_type": "product"
}
V2CargoItem
|
Name |
Description |
|
cost_currency |
Type: Currency Трехзначный код валюты, в которой ведется расчет Min length: Max length: Example: |
|
cost_value |
Type: string Цена за единицу товара в валюте cost_currency. Pattern: Example: |
|
dropoff_point |
Type: integer Идентификатор точки (int64), куда нужно доставить Может быть любым числом. Должен соответствовать значению route_points[].point_id |
|
pickup_point |
Type: integer Идентификатор точки (int64), откуда нужно забрать Может быть любым числом. Должен соответствовать значению route_points[].point_id |
|
quantity |
Type: integer Количество товара в единицах (int64) Min value: |
|
title |
Type: string Наименование единицы товара Example: |
|
age_restricted |
Type: boolean Нужно ли проверить возраст клиента при выдаче товара Default: |
|
droppof_point |
Type: integer deprecated, use dropoff_point |
|
extra_id |
Type: string Краткий уникальный идентификатор товара (номер заказа в рамках заявки, как правило идентичен external_order_id) Example: |
|
fiscalization |
Type: ItemFiscalization Информация по фискализации (актуально для оплаты при получении) Example
|
|
size |
Type: CargoItemSizes Габариты товара в метрах. В полях следует передавать актуальные значения. Если габариты не были переданы, заказ оформляется с учетом Если фактические характеристики товара превысят допустимые, Курьер (courier): до 0.80 м × 0.50 м × 0.50 м
Example
|
|
weight |
Type: number Вес единицы товара в кг. В поле следует передавать актуальные значения. Если вес не был передан, заказ оформляется с учетом Если фактические характеристики отправления превысят допустимые, Курьер (courier): до 10 кг
|
Example
{
"extra_id": "БП-208",
"pickup_point": 1,
"dropoff_point": 2,
"droppof_point": 0,
"title": "Плюмбус",
"size": {
"length": 0.1,
"width": 0.2,
"height": 0.3
},
"weight": 2,
"cost_value": "2.00",
"cost_currency": "RUB",
"quantity": 1,
"fiscalization": {
"excise": "12.50",
"vat_code_str": "vat_none",
"supplier_inn": "3664069397",
"article": "20ML50OWKY4FC86",
"mark": {
"kind": "gs1_data_matrix_base64",
"code": "444D00000000003741"
},
"item_type": "product"
},
"age_restricted": false
}
ContactOnPoint
Информация о контактном лице
|
Name |
Description |
|
name |
Type: string Имя контактного лица Example: |
|
phone |
Type: string Телефон контактного лица Example: |
|
|
Type: string Email — обязательный параметр для точек с типом source и return Example: |
|
phone_additional_code |
Type: string Добавочный номер для звонка курьера Example: |
Example
{
"name": "Морти",
"phone": "+79099999998",
"phone_additional_code": "602 17 500",
"email": "example@yandex.ru"
}
AddressFullname
Полный адрес с указанием города, улицы и номера дома.
Номер квартиры, подъезда и этаж указывать не нужно.
Type: string
Example: Санкт-Петербург, Большая Монетная улица, 1к1А
PointAddress
Адрес точки
|
Name |
Description |
|
coordinates |
Type: number[] Координаты точек в виде массива из двух вещественных чисел: долгота, широта — именно в таком порядке. Min items: Max items: Example
|
|
fullname |
Type: AddressFullname Полный адрес с указанием города, улицы и номера дома. Example: |
|
building |
Type: string Строение Example: |
|
building_name |
Type: string Название апартаментов (здания) Example: |
|
city |
Type: string Город Example: |
|
comment |
Type: string Комментарий для курьера. Для точки отправки используйте шаблон: "Доставка из магазина <>. Сообщите менеджеру, что заказ для Яндекс Доставки. Назовите номер заказа <> и заберите посылку. Заказ оплачен безналично, при передаче заказа нельзя требовать с получателя деньги за доставку." Для точек доставки в комментарии передавайте пожелания получателя. Например, "домофон не работает" / "шлагбаум закрыт, позвонить за 10 минут" / "не звонить, спит ребенок". Example: |
|
country |
Type: string Страна Example: |
|
description |
Type: string Географическая область, уточняющая краткий адрес до глобального соответствия Example: |
|
door_code |
Type: string Код домофона Example: |
|
door_code_extra |
Type: string Дополнительные указания по домофонам Example: |
|
doorbell_name |
Type: string Имя на дверном звонке Example: |
|
porch |
Type: string Подъезд (может быть A) Example: |
|
sflat |
Type: string Квартира Example: |
|
sfloor |
Type: string Этаж Example: |
|
shortname |
Type: string Краткий адрес в пределах города (как на Таксометре) Example: |
|
street |
Type: string Улица Example: |
|
uri |
Type: string URI геообъекта на картах Example: |
Example
{
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"shortname": "Большая Монетная улица, 1к1А",
"coordinates": [
0.5,
0.5
],
"country": "Россия",
"city": "Санкт-Петербург",
"building_name": "БЦ На Большой Монетной",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1",
"door_code": "169",
"door_code_extra": "код на вход во двор #1234, код от апартаментов #4321",
"doorbell_name": "Магидович",
"comment": "Домофон не работает",
"uri": "ymapsbm1://geo?ll=38.805%2C55.084",
"description": "Санкт-Петербург, Россия"
}
CargoPointSkipConfirmation
Пропускать подтверждение по смс в данной точке
Значение по умолчанию: false (подтверждение требуется).
Type: boolean
Default: false
PointType
Тип точки:
- source - точка отправления, где курьер забирает товар
- destination – точки назначения, где курьер передает товар
- return - точка возврата товара (добавляется автоматически и по умолчанию совпадает с точкой отправления, но также можно определить другую точку)
Type: string
Enum: source, destination, return
PaymentMethod
Выбранный тип оплаты.
card - оплата картой;
cash - оплата наличными (пока недоступна);
Type: string
Enum: card, cash
RequestBuyout
Информация по выкупу товара курьером в точке отправления (актуально, если для всех точек назначения в маршруте включена оплата при получении).
|
Name |
Description |
|
payment_method |
Type: PaymentMethod На данный момент актуально только cash Выбранный тип оплаты. Enum: |
Example
{
"payment_method": "card"
}
Inn
ИНН пользователя (10 или 12 цифр)
Type: string
Pattern: ^[A-Z0-9\\-]+$
Example: 3664069397
RequestCustomerFiscalization
Информация о получателе
|
Name |
Description |
|
|
Type: string Электронная почта пользователя в формате example@yandex.ru. Example: |
|
inn |
Type: Inn ИНН пользователя (10 или 12 цифр) Pattern: Example: |
|
phone |
Type: string Телефон пользователя в формате +X XXX XXX XX XX. Если не указано, будет использован телефон получателя из точки Example: |
Example
{
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
}
RequestPaymentOnDelivery
Информация по оплате при получении (актуально для оплаты при получении)
|
Name |
Description |
|
payment_method |
Type: PaymentMethod Выбранный тип оплаты. Enum: |
|
customer |
Type: RequestCustomerFiscalization Информация о получателе Example
|
Example
{
"customer": {
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
},
"payment_method": "card"
}
ExternalOrderCost
Стоимость внешнего заказа, привязанного к точке
|
Name |
Description |
|
currency |
Type: string Валюта Example: |
|
currency_sign |
Type: string Знак валюты Example: |
|
value |
Type: string Стоимость Example: |
Example
{
"value": "100.0",
"currency": "RUB",
"currency_sign": "₽"
}
PickupCode
Код выдачи посылки курьеру.
Курьеру потребуется ввести этот код, чтобы подтвердить, что он забрал посылку.
Для этого необходимо, чтобы ваши сотрудники на точке выдачи имели возможность назвать этот код курьеру.
Актуально для точки с типом 'source'.
Формат кода: 6 цифр
|
Код выдачи товара (ПВЗ)
Type: string
Example: 893422
V2CargoPoint
|
Name |
Description |
|
address |
Type: PointAddress Адрес точки Example
|
|
contact |
Type: ContactOnPoint Информация о контактном лице Example
|
|
point_id |
Type: integer Целочисленный идентификатор точки (int64), уникальна в рамках создания заявки |
|
type |
Type: PointType Тип точки:
Enum: |
|
visit_order |
Type: integer Порядок посещения точки (нумерация начинается с 1) (int64) |
|
buyout |
Type: RequestBuyout Информация по выкупу товара курьером в точке отправления (актуально, если для всех точек назначения в маршруте включена оплата при получении). Example
|
|
external_order_cost |
Type: ExternalOrderCost Стоимость внешнего заказа, привязанного к точке Example
|
|
external_order_id |
Type: string Номер заказа из системы клиента. Example: |
|
leave_under_door |
Type: boolean Оставить посылку у двери |
|
meet_outside |
Type: boolean Курьера встретят на улице у подъезда |
|
no_door_call |
Type: boolean Не звонить в дверь |
|
payment_on_delivery |
Type: RequestPaymentOnDelivery Информация по оплате при получении (актуально для оплаты при получении) Example
|
|
pickup_code |
Type: PickupCode Код выдачи посылки курьеру. Example: |
|
should_notify_on_order_readiness |
Type: boolean Укажите этот параметр равным Default: |
|
skip_confirmation |
Type: CargoPointSkipConfirmation Пропускать подтверждение по смс в данной точке Значение по умолчанию: false (подтверждение требуется). Default: Example: |
Example
{
"point_id": 6987,
"visit_order": 1,
"contact": {
"name": "Морти",
"phone": "+79099999998",
"phone_additional_code": "602 17 500",
"email": "example@yandex.ru"
},
"address": {
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"shortname": "Большая Монетная улица, 1к1А",
"coordinates": [
0.5,
0.5
],
"country": "Россия",
"city": "Санкт-Петербург",
"building_name": "БЦ На Большой Монетной",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1",
"door_code": "169",
"door_code_extra": "код на вход во двор #1234, код от апартаментов #4321",
"doorbell_name": "Магидович",
"comment": "Домофон не работает",
"uri": "ymapsbm1://geo?ll=38.805%2C55.084",
"description": "Санкт-Петербург, Россия"
},
"skip_confirmation": false,
"leave_under_door": true,
"meet_outside": true,
"no_door_call": true,
"type": "source",
"buyout": {
"payment_method": "card"
},
"payment_on_delivery": {
"customer": {
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
},
"payment_method": null
},
"external_order_id": "100",
"external_order_cost": {
"value": "100.0",
"currency": "RUB",
"currency_sign": "₽"
},
"pickup_code": "893422",
"should_notify_on_order_readiness": false
}
V2CargoRoutePoints
Информация по точкам маршрута
Type: V2CargoPoint[]
Min items: 2
Example
[
{
"point_id": 6987,
"visit_order": 1,
"contact": {
"name": "Морти",
"phone": "+79099999998",
"phone_additional_code": "602 17 500",
"email": "example@yandex.ru"
},
"address": {
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"shortname": "Большая Монетная улица, 1к1А",
"coordinates": [
0.5,
0.5
],
"country": "Россия",
"city": "Санкт-Петербург",
"building_name": "БЦ На Большой Монетной",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1",
"door_code": "169",
"door_code_extra": "код на вход во двор #1234, код от апартаментов #4321",
"doorbell_name": "Магидович",
"comment": "Домофон не работает",
"uri": "ymapsbm1://geo?ll=38.805%2C55.084",
"description": "Санкт-Петербург, Россия"
},
"skip_confirmation": false,
"leave_under_door": true,
"meet_outside": true,
"no_door_call": true,
"type": "source",
"buyout": {
"payment_method": "card"
},
"payment_on_delivery": {
"customer": {
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
},
"payment_method": null
},
"external_order_id": "100",
"external_order_cost": {
"value": "100.0",
"currency": "RUB",
"currency_sign": "₽"
},
"pickup_code": "893422",
"should_notify_on_order_readiness": false
},
{
"point_id": 6987,
"visit_order": 1,
"contact": {
"name": "Морти",
"phone": "+79099999998",
"phone_additional_code": "602 17 500",
"email": "example@yandex.ru"
},
"address": {
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"shortname": "Большая Монетная улица, 1к1А",
"coordinates": [
0.5,
0.5
],
"country": "Россия",
"city": "Санкт-Петербург",
"building_name": "БЦ На Большой Монетной",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1",
"door_code": "169",
"door_code_extra": "код на вход во двор #1234, код от апартаментов #4321",
"doorbell_name": "Магидович",
"comment": "Домофон не работает",
"uri": "ymapsbm1://geo?ll=38.805%2C55.084",
"description": "Санкт-Петербург, Россия"
},
"skip_confirmation": false,
"leave_under_door": true,
"meet_outside": true,
"no_door_call": true,
"type": "source",
"buyout": {
"payment_method": "card"
},
"payment_on_delivery": {
"customer": {
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
},
"payment_method": null
},
"external_order_id": "100",
"external_order_cost": {
"value": "100.0",
"currency": "RUB",
"currency_sign": "₽"
},
"pickup_code": "893422",
"should_notify_on_order_readiness": false
}
]
ContactWithPhone
Информация о контактном лице с номером телефона
|
Name |
Description |
|
name |
Type: string Имя контактного лица Example: |
|
phone |
Type: string Телефон контактного лица Example: |
|
phone_additional_code |
Type: string Добавочный номер для звонка курьера Example: |
Example
{
"name": "Рик",
"phone": "+79826810246",
"phone_additional_code": "602 17 500"
}
CargoType
Тип (размер) кузова для грузового тарифа.
Возможные значения:
- van ("Маленький кузов")
- lcv_m ("Средний кузов")
- lcv_l ("Большой кузов")
- lcv_xl ("Кузов XL")
Точный список возможных значений для конкретной геоточки уточняйте с помощью метода получения тарифов tariffs
Type: string
Enum: van, lcv_m, lcv_l, lcv_xl
CargoOptions
Список дополнительных опций тарифа.
Возможные отдельные опции:
- auto_courier (курьер только на автомобиле)
- thermobag (курьер с термосумкой)
Пример списка опций: ["auto_courier"].
Точный список возможных значений для конкретной геоточки
уточните с помощью метода получения тарифов tariffs
Type: string[]
Example
[
"thermobag"
]
ClientRequirements
Требования от клиента, указанные при создании или редактировании заявки
|
Name |
Description |
|
taxi_class |
Type: string Тариф доставки. Возможные значения: courier, express, cargo Example: |
|
assign_robot |
Type: boolean Разрешить выполнение заказа ровером (шестиколесный робот) |
|
cargo_loaders |
Type: integer Число грузчиков для грузового тарифа. Точный список возможных значений для конкретной точки Min value: |
|
cargo_options |
Type: CargoOptions Список дополнительных опций тарифа. Возможные отдельные опции:
Пример списка опций: ["auto_courier"]. Точный список возможных значений для конкретной геоточки Example
|
|
cargo_type |
Type: CargoType Тип (размер) кузова для грузового тарифа.
Enum: |
|
pro_courier |
Type: boolean Включить опцию "Профи" для тарифов "Экспресс" и "Курьер". |
|
rental_duration |
Type: integer Время аренды, которое планирует клиент. Указывается в минутах. |
|
taxi_classes |
Type: string[] Классы такси. Используем строго эти классы, без дополнительных проверок Min items: Example
|
Example
{
"taxi_class": "express",
"taxi_classes": [
"express"
],
"cargo_type": "lcv_m",
"cargo_loaders": 0,
"cargo_options": [
"thermobag"
],
"pro_courier": false,
"assign_robot": true,
"rental_duration": 0
}
CallbackProperties
Параметры уведомления сервера клиента о смене статуса заявки.
Уведомление представляет собой POST-запрос по указанному url, к
которому будут добавлены информация о дате последнего изменения
заявки и идентификатора заявки в виде
'updated_ts=
'https://example.com/?my_order_id=123&' будет расширен до
'https://example.com/?my_order_id=123&updated_ts=...&claim_id=...'.
Важно: параметры добавляются конкатенацией к callback_url, то есть
url вида 'https://example.com' превратится в невалидный
'https://example.comupdated_ts=...&claim_id=...'.
Поддерживаются только http и https. При https ssl-сертификат должен
быть выдан известным серверу центром сертификации.
К уведомлениям следует относиться как к push ahead of polling, как
к ускорению получения информации о смене статусов. Сервер ожидает
ответ 200, при таймаутах или любом другом ответе какое-то время
будет пытаться доставить уведомление, после чего прекратит попытки.
То есть для надежного получения статуса по заявке клиенту
необходимо запрашивать информацию с помощью метода claims/info.
Клиенту следует учесть, что ответ операции claims/info может
содержать более старое состояние заявки (надо ориентироваться на
значение поля updated_ts). В этом случает необходимо повторить
вызов операции через некоторое время (от 5 до 30 секунд).
|
Name |
Description |
|
callback_url |
Type: string URL, который вызывается при смене статусов по заявке. Этот механизм устарел и может быть ненадежен, рекомендуем использовать в связке с claims/journal Pattern: Example: |
Example
{
"callback_url": "https://www.example.com/"
}
SkipDoorToDoor
Отключить доставку до двери (выключить опцию "От двери до двери").
Возможные значения:
- true (курьер доставит заказ только на улицу, до подъезда)
- false (курьер доставит до двери) - значение по умолчанию
Type: boolean
Default: false
SkipClientNotify
Не отправлять отправителю/получателю смс-уведомления,
когда к нему направится курьер.
Значение по умолчанию: false (отправлять уведомления)
Type: boolean
Default: false
SkipEmergencyNotify
Не отправлять уведомление запасному контактному лицу
Значение по умолчанию: false (отправлять уведомления)
Type: boolean
Default: false
SkipAct
Не показывать акт приема-передачи
Type: boolean
OptionalReturn
Отключить возврат товаров в случае отмены заказа.
Возможные значения:
- true (курьер оставляет товар себе)
- false (по умолчанию, требуется вернуть товар)
Type: boolean
Default: false
Due
Желаемое время прибытия исполнителя на точку А (source).
В РФ отложить расчетное время прибытия исполнителя можно:
- на 30-240 минут от текущего момента – для тарифа express;
- на пять суток от текущего момента – для тарифа cargo.
Параметр не совместим с опциями замедления в тарифе express на территории РФ.
Если этот параметр не задан, то запустится поиск исполнителя на ближайшее время.
Type: string<date-time>
Example: 2020-01-01T00:00:00+00:00
SameDayData
Дополнительная информация для заявок В течение дня. Недоступно в России
|
Name |
Description |
||||
|
delivery_interval |
Type: object
Интервал забора и доставки посылки Example
|
Example
{
"delivery_interval": {
"from": "2020-01-01T07:00:00+00:00",
"to": "2020-01-01T07:00:00+00:00"
}
}
Responses
200 OK
Заявка изменена
Body
application/json
{
"id": "741cedf82cd464fa6fa16d87155c636",
"corp_client_id": "cd8cc018bde34597932855e3cfdce927",
"items": [
{
"extra_id": "БП-208",
"pickup_point": 1,
"dropoff_point": 2,
"droppof_point": 0,
"title": "Плюмбус",
"size": {
"length": 0.1,
"width": 0.2,
"height": 0.3
},
"weight": 2,
"cost_value": "2.00",
"cost_currency": "RUB",
"quantity": 1,
"fiscalization": {
"excise": "12.50",
"vat_code_str": "vat_none",
"supplier_inn": "3664069397",
"article": "20ML50OWKY4FC86",
"mark": {
"kind": "gs1_data_matrix_base64",
"code": "444D00000000003741"
},
"item_type": "product"
},
"age_restricted": false
}
],
"route_points": [
{
"id": 1,
"contact": {
"name": "Морти",
"phone": "+79099999998",
"phone_additional_code": "602 17 500",
"email": "example@yandex.ru"
},
"address": {
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"shortname": "Большая Монетная улица, 1к1А",
"coordinates": [
0.5,
0.5
],
"country": "Россия",
"city": "Санкт-Петербург",
"building_name": "БЦ На Большой Монетной",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1",
"door_code": "169",
"door_code_extra": "код на вход во двор #1234, код от апартаментов #4321",
"doorbell_name": "Магидович",
"comment": "Домофон не работает",
"uri": "ymapsbm1://geo?ll=38.805%2C55.084",
"description": "Санкт-Петербург, Россия"
},
"type": "source",
"visit_order": 1,
"visit_status": "pending",
"skip_confirmation": false,
"leave_under_door": true,
"meet_outside": true,
"no_door_call": true,
"payment_on_delivery": {
"payment_ref_id": "123e4567-e89b-12d3-a456-426614174000",
"client_order_id": "100",
"is_paid": false,
"customer": {
"full_name": "Морти",
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
},
"payment_method": "card",
"invoice_link": "https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024"
},
"external_order_id": "100",
"external_order_cost": {
"value": "100.0",
"currency": "RUB",
"currency_sign": "₽"
},
"expected_visit_interval": {
"from": "2020-01-01T00:00:00+00:00",
"to": "2020-01-02T00:00:00+00:00"
},
"pickup_code": "893422",
"return_reasons": [
"example"
],
"return_comment": "example",
"visited_at": {
"expected": "2025-01-01T00:00:00Z",
"expected_waiting_time_sec": 0,
"actual": "2025-01-01T00:00:00Z"
}
},
{
"id": 1,
"contact": {
"name": "Морти",
"phone": "+79099999998",
"phone_additional_code": "602 17 500",
"email": "example@yandex.ru"
},
"address": {
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"shortname": "Большая Монетная улица, 1к1А",
"coordinates": [
0.5,
0.5
],
"country": "Россия",
"city": "Санкт-Петербург",
"building_name": "БЦ На Большой Монетной",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1",
"door_code": "169",
"door_code_extra": "код на вход во двор #1234, код от апартаментов #4321",
"doorbell_name": "Магидович",
"comment": "Домофон не работает",
"uri": "ymapsbm1://geo?ll=38.805%2C55.084",
"description": "Санкт-Петербург, Россия"
},
"type": "source",
"visit_order": 1,
"visit_status": "pending",
"skip_confirmation": false,
"leave_under_door": true,
"meet_outside": true,
"no_door_call": true,
"payment_on_delivery": {
"payment_ref_id": "123e4567-e89b-12d3-a456-426614174000",
"client_order_id": "100",
"is_paid": false,
"customer": {
"full_name": "Морти",
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
},
"payment_method": "card",
"invoice_link": "https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024"
},
"external_order_id": "100",
"external_order_cost": {
"value": "100.0",
"currency": "RUB",
"currency_sign": "₽"
},
"expected_visit_interval": {
"from": "2020-01-01T00:00:00+00:00",
"to": "2020-01-02T00:00:00+00:00"
},
"pickup_code": "893422",
"return_reasons": [
"example"
],
"return_comment": "example",
"visited_at": {
"expected": "2025-01-01T00:00:00Z",
"expected_waiting_time_sec": 0,
"actual": "2025-01-01T00:00:00Z"
}
}
],
"current_point_id": 372036854775807,
"status": "new",
"version": 0,
"user_request_revision": "example",
"error_messages": [
{
"code": "some_error",
"message": "Some error"
}
],
"emergency_contact": {
"name": "Рик",
"phone": "+79826810246",
"phone_additional_code": "602 17 500"
},
"skip_door_to_door": false,
"skip_client_notify": false,
"skip_emergency_notify": false,
"skip_act": false,
"optional_return": false,
"eta": 10,
"created_ts": "2020-01-01T00:00:00+00:00",
"updated_ts": "2020-01-01T00:00:00+00:00",
"taxi_offer": {
"offer_id": "28ae5f1d72364468be3f5e26cd6a66bf",
"price_raw": 12,
"price": null
},
"pricing": {
"offer": {
"offer_id": null,
"price_raw": 12,
"price": null,
"valid_until": "2020-01-01T00:00:00+00:00",
"price_with_vat": null
},
"currency": "RUB",
"currency_rules": {
"code": null,
"text": "руб.",
"template": "$VALUE$ $SIGN$$CURRENCY$",
"sign": "₽"
},
"final_pricing_calc_id": "example",
"final_price": null
},
"available_cancel_state": "free",
"client_requirements": {
"taxi_class": "express",
"taxi_classes": [
"express"
],
"cargo_type": "lcv_m",
"cargo_loaders": 0,
"cargo_options": [
"thermobag"
],
"pro_courier": false,
"assign_robot": true,
"rental_duration": 0
},
"matched_cars": [
{
"taxi_class": "express",
"client_taxi_class": "cargo",
"cargo_type": "lcv_m",
"cargo_type_int": "2 is equal to \"lcv_m\"",
"cargo_loaders": 0,
"door_to_door": false,
"pro_courier": false
}
],
"warnings": [
{
"source": "client_requirements",
"code": "not_fit_in_car",
"message": "предупреждение"
}
],
"performer_info": {
"courier_name": "Личность",
"legal_name": "ИП Птичья личность",
"car_model": "Hyundai Solaris",
"car_number": "А100РА100",
"car_color": "красный",
"car_color_hex": "FF00000",
"transport_type": "car"
},
"callback_properties": {
"callback_url": "https://www.example.com/"
},
"due": "2020-01-01T00:00:00+00:00",
"shipping_document": "example",
"comment": "Ресторан",
"revision": 1,
"route_id": "example",
"same_day_data": {
"delivery_interval": {
"from": "2020-01-01T07:00:00+00:00",
"to": "2020-01-01T07:00:00+00:00"
}
},
"performer_cancel_reasons": [
"example"
]
}
|
Name |
Description |
|
created_ts |
Type: string<date-time> Дата и время создания заявки Example: |
|
id |
Type: ClaimId Идентификатор(ID) заявки, полученный на этапе создания заявки Min length: Max length: Example: |
|
items |
Type: V2CargoItem[] Параметры товаров Min items: Example
|
|
revision |
Type: integer Ревизия (int64) |
|
route_points |
Type: V2ResponseCargoRoutePoints Информация по точкам маршрута Min items: Example
|
|
status |
Type: ClaimStatus Статус заявки. Подробнее см. в разделе Статусная модель Enum: |
|
updated_ts |
Type: string<date-time> Дата и время последнего обновления заявки Example: |
|
user_request_revision |
Type: string Текущая версия изменений в заявке, переданная пользователем Example: |
|
version |
Type: integer Версия (int64) |
|
available_cancel_state |
Type: AvailableCancelState (deprecated) Признак возможности платной/бесплатной отмены. Enum: |
|
callback_properties |
Type: CallbackProperties Параметры уведомления сервера клиента о смене статуса заявки. Уведомление представляет собой POST-запрос по указанному url, к Важно: параметры добавляются конкатенацией к callback_url, то есть Поддерживаются только http и https. При https ssl-сертификат должен К уведомлениям следует относиться как к push ahead of polling, как Клиенту следует учесть, что ответ операции claims/info может Example
|
|
client_requirements |
Type: ClientRequirements Требования от клиента, указанные при создании или редактировании заявки Example
|
|
comment |
Type: string Общий комментарий к заказу Example: |
|
corp_client_id |
Type: CorpClientId Идентификатор корпоративного клиента Яндекс Доставки (из OAuth-токена) Min length: Max length: Example: |
|
current_point_id |
Type: ClaimPointId Целочисленный идентификатор точки (int64), генерируемый Example: |
|
due |
Type: Due Желаемое время прибытия исполнителя на точку А (source). Параметр не совместим с опциями замедления в тарифе Example: |
|
emergency_contact |
Type: ContactWithPhone Информация о контактном лице с номером телефона Example
|
|
error_messages |
Type: HumanErrorMessage[] Список сообщений об ошибках Example
|
|
eta |
Type: Eta Расчетное время выполнения заказа в минутах (int64) Example: |
|
matched_cars |
Type: MatchedCar[] Информация о подобранном тарифе Example
|
|
optional_return |
Type: OptionalReturn Отключить возврат товаров в случае отмены заказа. Возможные значения:
Default: Example: |
|
performer_cancel_reasons |
Type: string[] Причины, по которым курьер отменил доставку заказа Example
|
|
performer_info |
Type: PerformerInfo Информация об исполнителе Информация о курьере Example
|
|
pricing |
Type: ClaimPricing Информация о стоимости заказа Example
|
|
route_id |
Type: string Идентификатор машрута, в рамках которого доставляется заказ Example: |
|
same_day_data |
Type: SameDayData Дополнительная информация для заявок Example
|
|
shipping_document |
Type: string Сопроводительные документы Example: |
|
skip_act |
Type: SkipAct Не показывать акт приема-передачи Example: |
|
skip_client_notify |
Type: SkipClientNotify Не отправлять отправителю/получателю смс-уведомления, Значение по умолчанию: false (отправлять уведомления) Default: Example: |
|
skip_door_to_door |
Type: SkipDoorToDoor Отключить доставку до двери (выключить опцию "От двери до двери"). Возможные значения:
Default: Example: |
|
skip_emergency_notify |
Type: SkipEmergencyNotify Не отправлять уведомление запасному контактному лицу Значение по умолчанию: false (отправлять уведомления) Default: Example: |
|
taxi_offer |
Type: TaxiOfferDeprecated Предложение от Такси (актуально в течение некоторого времени). Данный механизм устарел, используйте pricing.offer Example
|
|
warnings |
Type: ClaimWarning[] Предупреждения по ходу обработки заявки Example
|
ClaimId
Идентификатор(ID) заявки, полученный на этапе создания заявки
Type: string
Min length: 32
Max length: 64
Example: 741cedf82cd464fa6fa16d87155c636
CorpClientId
Идентификатор корпоративного клиента Яндекс Доставки (из OAuth-токена)
Type: string
Min length: 32
Max length: 32
Example: cd8cc018bde34597932855e3cfdce927
CargoPointAddress
Адрес точки
|
Name |
Description |
|
fullname |
Type: AddressFullname Полный адрес с указанием города, улицы и номера дома. Example: |
|
building |
Type: string Строение Example: |
|
building_name |
Type: string Название апартаментов (здания) Example: |
|
city |
Type: string Город Example: |
|
comment |
Type: string Комментарий для курьера. Для точки отправки используйте шаблон: "Доставка из магазина <>. Сообщите менеджеру, что заказ для Яндекс Доставки. Назовите номер заказа <> и заберите посылку. Заказ оплачен безналично, при передаче заказа нельзя требовать с получателя деньги за доставку." Для точек доставки в комментарии передавайте пожелания получателя. Например, "домофон не работает" / "шлагбаум закрыт, позвонить за 10 минут" / "не звонить, спит ребенок". Max length: Example: |
|
coordinates |
Type: number[] Координаты точек в виде массива из двух вещественных чисел: долгота, широта — именно в таком порядке. Min items: Max items: Example
|
|
country |
Type: string Страна Example: |
|
description |
Type: string Географическая область, уточняющая краткий адрес до глобального соответствия Example: |
|
door_code |
Type: string Код домофона Example: |
|
door_code_extra |
Type: string Дополнительные указания по домофонам Example: |
|
doorbell_name |
Type: string Имя на дверном звонке Example: |
|
porch |
Type: string Подъезд (может быть A) Example: |
|
sflat |
Type: string Квартира Example: |
|
sfloor |
Type: string Этаж Example: |
|
shortname |
Type: string Краткий адрес в пределах города (как на Таксометре) Example: |
|
street |
Type: string Улица Example: |
|
uri |
Type: string URI геообъекта на картах Example: |
Example
{
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"shortname": "Большая Монетная улица, 1к1А",
"coordinates": [
0.5,
0.5
],
"country": "Россия",
"city": "Санкт-Петербург",
"building_name": "БЦ На Большой Монетной",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1",
"door_code": "169",
"door_code_extra": "код на вход во двор #1234, код от апартаментов #4321",
"doorbell_name": "Магидович",
"comment": "Домофон не работает",
"uri": "ymapsbm1://geo?ll=38.805%2C55.084",
"description": "Санкт-Петербург, Россия"
}
PointVisitStatus
Статус посещения точки:
- pending - точка еще не посещена;
- arrived - курьер прибыл на точку;
- visited - курьер передал/забрал груз на точке;
- skipped - точка пропущена (в случае, если не смог принять товар).
Type: string
Enum: pending, arrived, visited, skipped
PaymentId
Идентификатор оплаты
Type: string<uuid>
Example: 123e4567-e89b-12d3-a456-426614174000
ClientOrderId
Внешний идентификатор клиентского заказа
Type: string
Example: 100
PaymentComplete
Признак оплаты заказа
Type: boolean
CustomerFiscalization
Информация о клиенте(получателе)
|
Name |
Description |
|
|
Type: string Электронная почта пользователя. Если не указано, будет использована почта получателя из точки назначения Example: |
|
full_name |
Type: string Для юридического лица — название организации, для ИП и физического лица — ФИО Example: |
|
inn |
Type: Inn ИНН пользователя (10 или 12 цифр) Pattern: Example: |
|
phone |
Type: string Телефон пользователя в формате +X XXX XXX XX XX. Если не указано, будет использован телефон получателя из точки назначения Example: |
Example
{
"full_name": "Морти",
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
}
InvoiceLink
Ссылка на чек
Type: string
Example: https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024
ResponsePaymentOnDelivery
Параметры оплаты при получении
|
Name |
Description |
|
is_paid |
Type: PaymentComplete Признак оплаты заказа Example: |
|
client_order_id |
Type: ClientOrderId Внешний идентификатор клиентского заказа Example: |
|
customer |
Type: CustomerFiscalization Информация о клиенте(получателе) Example
|
|
invoice_link |
Type: InvoiceLink Ссылка на чек Example: |
|
payment_method |
Type: PaymentMethod Выбранный тип оплаты. Enum: |
|
payment_ref_id |
Type: PaymentId Идентификатор оплаты Example: |
Example
{
"payment_ref_id": "123e4567-e89b-12d3-a456-426614174000",
"client_order_id": "100",
"is_paid": false,
"customer": {
"full_name": "Морти",
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
},
"payment_method": "card",
"invoice_link": "https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024"
}
ExpectedVisitInterval
Временной интервал посещения курьером точки согласно выбранному офферу
|
Name |
Description |
|
from |
Type: string<date-time> Начало интервала Example: |
|
to |
Type: string<date-time> Окончание интервала Example: |
Example
{
"from": "2020-01-01T00:00:00+00:00",
"to": "2020-01-02T00:00:00+00:00"
}
PointVisitTime
Информация о времени посещения точки
|
Name |
Description |
|
actual |
Type: string<date-time> Фактическое время посещения точки. Example: |
|
expected |
Type: string<date-time> Расчетное время посещения. Может быть заполнено Example: |
|
expected_waiting_time_sec |
Type: integer Расчетное время ожидания в точке. (int64) |
Example
{
"expected": "2025-01-01T00:00:00Z",
"expected_waiting_time_sec": 0,
"actual": "2025-01-01T00:00:00Z"
}
V2ResponseCargoPoint
Информация по точкам маршрута
|
Name |
Description |
|
address |
Type: CargoPointAddress Адрес точки Example
|
|
contact |
Type: ContactOnPoint Информация о контактном лице Example
|
|
id |
Type: integer Целочисленный идентификатор точки (int64) |
|
type |
Type: PointType Тип точки:
Enum: |
|
visit_order |
Type: integer Порядок посещения точки (нумерация начинается с 1) (int64) |
|
visit_status |
Type: PointVisitStatus Статус посещения точки:
Enum: |
|
visited_at |
Type: PointVisitTime Информация о времени посещения точки Example
|
|
expected_visit_interval |
Type: ExpectedVisitInterval Временной интервал посещения курьером точки согласно выбранному офферу Example
|
|
external_order_cost |
Type: ExternalOrderCost Стоимость внешнего заказа, привязанного к точке Example
|
|
external_order_id |
Type: string Номер заказа из системы клиента. Example: |
|
leave_under_door |
Type: boolean Оставить посылку у двери |
|
meet_outside |
Type: boolean Курьера встретят на улице у подъезда |
|
no_door_call |
Type: boolean Не звонить в дверь |
|
payment_on_delivery |
Type: ResponsePaymentOnDelivery Параметры оплаты при получении Example
|
|
pickup_code |
Type: PickupCode Код выдачи посылки курьеру. Example: |
|
return_comment |
Type: string Комментарий к причинам возврата груза Example: |
|
return_reasons |
Type: string[] Причины возврата груза Example
|
|
skip_confirmation |
Type: CargoPointSkipConfirmation Пропускать подтверждение по смс в данной точке Значение по умолчанию: false (подтверждение требуется). Default: Example: |
Example
{
"id": 1,
"contact": {
"name": "Морти",
"phone": "+79099999998",
"phone_additional_code": "602 17 500",
"email": "example@yandex.ru"
},
"address": {
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"shortname": "Большая Монетная улица, 1к1А",
"coordinates": [
0.5,
0.5
],
"country": "Россия",
"city": "Санкт-Петербург",
"building_name": "БЦ На Большой Монетной",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1",
"door_code": "169",
"door_code_extra": "код на вход во двор #1234, код от апартаментов #4321",
"doorbell_name": "Магидович",
"comment": "Домофон не работает",
"uri": "ymapsbm1://geo?ll=38.805%2C55.084",
"description": "Санкт-Петербург, Россия"
},
"type": "source",
"visit_order": 1,
"visit_status": "pending",
"skip_confirmation": false,
"leave_under_door": true,
"meet_outside": true,
"no_door_call": true,
"payment_on_delivery": {
"payment_ref_id": "123e4567-e89b-12d3-a456-426614174000",
"client_order_id": "100",
"is_paid": false,
"customer": {
"full_name": "Морти",
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
},
"payment_method": "card",
"invoice_link": "https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024"
},
"external_order_id": "100",
"external_order_cost": {
"value": "100.0",
"currency": "RUB",
"currency_sign": "₽"
},
"expected_visit_interval": {
"from": "2020-01-01T00:00:00+00:00",
"to": "2020-01-02T00:00:00+00:00"
},
"pickup_code": "893422",
"return_reasons": [
"example"
],
"return_comment": "example",
"visited_at": {
"expected": "2025-01-01T00:00:00Z",
"expected_waiting_time_sec": 0,
"actual": "2025-01-01T00:00:00Z"
}
}
V2ResponseCargoRoutePoints
Информация по точкам маршрута
Type: V2ResponseCargoPoint[]
Min items: 2
Example
[
{
"id": 1,
"contact": {
"name": "Морти",
"phone": "+79099999998",
"phone_additional_code": "602 17 500",
"email": "example@yandex.ru"
},
"address": {
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"shortname": "Большая Монетная улица, 1к1А",
"coordinates": [
0.5,
0.5
],
"country": "Россия",
"city": "Санкт-Петербург",
"building_name": "БЦ На Большой Монетной",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1",
"door_code": "169",
"door_code_extra": "код на вход во двор #1234, код от апартаментов #4321",
"doorbell_name": "Магидович",
"comment": "Домофон не работает",
"uri": "ymapsbm1://geo?ll=38.805%2C55.084",
"description": "Санкт-Петербург, Россия"
},
"type": "source",
"visit_order": 1,
"visit_status": "pending",
"skip_confirmation": false,
"leave_under_door": true,
"meet_outside": true,
"no_door_call": true,
"payment_on_delivery": {
"payment_ref_id": "123e4567-e89b-12d3-a456-426614174000",
"client_order_id": "100",
"is_paid": false,
"customer": {
"full_name": "Морти",
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
},
"payment_method": "card",
"invoice_link": "https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024"
},
"external_order_id": "100",
"external_order_cost": {
"value": "100.0",
"currency": "RUB",
"currency_sign": "₽"
},
"expected_visit_interval": {
"from": "2020-01-01T00:00:00+00:00",
"to": "2020-01-02T00:00:00+00:00"
},
"pickup_code": "893422",
"return_reasons": [
"example"
],
"return_comment": "example",
"visited_at": {
"expected": "2025-01-01T00:00:00Z",
"expected_waiting_time_sec": 0,
"actual": "2025-01-01T00:00:00Z"
}
},
{
"id": 1,
"contact": {
"name": "Морти",
"phone": "+79099999998",
"phone_additional_code": "602 17 500",
"email": "example@yandex.ru"
},
"address": {
"fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А",
"shortname": "Большая Монетная улица, 1к1А",
"coordinates": [
0.5,
0.5
],
"country": "Россия",
"city": "Санкт-Петербург",
"building_name": "БЦ На Большой Монетной",
"street": "Большая Монетная улица",
"building": "23к1А",
"porch": "A",
"sfloor": "1",
"sflat": "1",
"door_code": "169",
"door_code_extra": "код на вход во двор #1234, код от апартаментов #4321",
"doorbell_name": "Магидович",
"comment": "Домофон не работает",
"uri": "ymapsbm1://geo?ll=38.805%2C55.084",
"description": "Санкт-Петербург, Россия"
},
"type": "source",
"visit_order": 1,
"visit_status": "pending",
"skip_confirmation": false,
"leave_under_door": true,
"meet_outside": true,
"no_door_call": true,
"payment_on_delivery": {
"payment_ref_id": "123e4567-e89b-12d3-a456-426614174000",
"client_order_id": "100",
"is_paid": false,
"customer": {
"full_name": "Морти",
"inn": "3664069397",
"email": "example@yandex.ru",
"phone": "79000000000"
},
"payment_method": "card",
"invoice_link": "https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024"
},
"external_order_id": "100",
"external_order_cost": {
"value": "100.0",
"currency": "RUB",
"currency_sign": "₽"
},
"expected_visit_interval": {
"from": "2020-01-01T00:00:00+00:00",
"to": "2020-01-02T00:00:00+00:00"
},
"pickup_code": "893422",
"return_reasons": [
"example"
],
"return_comment": "example",
"visited_at": {
"expected": "2025-01-01T00:00:00Z",
"expected_waiting_time_sec": 0,
"actual": "2025-01-01T00:00:00Z"
}
}
]
ClaimPointId
Целочисленный идентификатор точки (int64), генерируемый
на стороне Яндекс Доставки.
Содержится в поле route_points[].id. Применимо к точкам с типом
source, destination, return.
Type: integer
ClaimStatus
Статус заявки. Подробнее см. в разделе Статусная модель
Type: string
Enum: new, estimating, estimating_failed, ready_for_approval, accepted, performer_lookup, performer_draft, performer_found, performer_not_found, pickup_arrived, ready_for_pickup_confirmation, pickuped, delivery_arrived, ready_for_delivery_confirmation, delivered, delivered_finish, returning, return_arrived, ready_for_return_confirmation, returned, returned_finish, failed, cancelled, cancelled_with_payment, cancelled_by_taxi, cancelled_with_items_on_hands
HumanErrorMessage
Код и описание ошибки
|
Name |
Description |
|
code |
Type: string Код ошибки Example: |
|
message |
Type: string Описание ошибки Example: |
Example
{
"code": "some_error",
"message": "Some error"
}
Eta
Расчетное время выполнения заказа в минутах (int64)
Type: integer
TaxiOfferId
Идентификатор предложения
Type: string
Example: 28ae5f1d72364468be3f5e26cd6a66bf
TaxiOfferDeprecated
Предложение от Такси (актуально в течение некоторого времени). Данный механизм устарел, используйте pricing.offer
|
Name |
Description |
|
offer_id |
Type: TaxiOfferId Идентификатор предложения Example: |
|
price |
Type: Money decimal цена по предложению Стоимость доставки в формате десятичной дроби Decimal(18, 4) Pattern: Example: |
|
price_raw |
Type: integer (deprecated) Цена по офферу в валюте, указанной в договоре (int64) |
Example
{
"offer_id": "28ae5f1d72364468be3f5e26cd6a66bf",
"price_raw": 12,
"price": "12.50"
}
TaxiOffer
Предложение от Яндекс Доставки (актуально в течение некоторого времени).
|
Name |
Description |
|
offer_id |
Type: TaxiOfferId Идентификатор предложения Example: |
|
price |
Type: Money Цена по предложению без НДС Стоимость доставки в формате десятичной дроби Decimal(18, 4) Pattern: Example: |
|
price_raw |
Type: integer (deprecated) Цена по предложению в валюте, указанной (int64) в договоре |
|
price_with_vat |
Type: Money Стоимость доставки в формате десятичной дроби Decimal(18, 4) Pattern: Example: |
|
valid_until |
Type: string<date-time> Время до которого действительно предложение на принятие заявки. Если значения нет, то ограничений по длительности предложения нет Example: |
Example
{
"offer_id": "28ae5f1d72364468be3f5e26cd6a66bf",
"price_raw": 12,
"price": "12.50",
"valid_until": "2020-01-01T00:00:00+00:00",
"price_with_vat": null
}
CurrencyRules
Правила отображения валюты
|
Name |
Description |
|
code |
Type: Currency Трехзначный код валюты, в которой ведется расчет Min length: Max length: Example: |
|
template |
Type: string Шаблон для отображения валюты Example: |
|
text |
Type: string Сокращенное наименование валюты Example: |
|
sign |
Type: string Символ валюты Example: |
Example
{
"code": "RUB",
"text": "руб.",
"template": "$VALUE$ $SIGN$$CURRENCY$",
"sign": "₽"
}
ClaimPricing
Информация о стоимости заказа
|
Name |
Description |
|
currency |
Type: string Трехзначный код валюты, в которой ведется расчет Example: |
|
currency_rules |
Type: CurrencyRules Правила отображения валюты Example
|
|
final_price |
Type: Money Окончательная цена доставки с учетом НДС. Стоимость доставки в формате десятичной дроби Decimal(18, 4) Pattern: Example: |
|
final_pricing_calc_id |
Type: string Идентификатор расчета стоимости Example: |
|
offer |
Type: TaxiOffer Предложение от Яндекс Доставки (актуально в течение некоторого времени). Example
|
Example
{
"offer": {
"offer_id": "28ae5f1d72364468be3f5e26cd6a66bf",
"price_raw": 12,
"price": "12.50",
"valid_until": "2020-01-01T00:00:00+00:00",
"price_with_vat": null
},
"currency": "RUB",
"currency_rules": {
"code": "RUB",
"text": "руб.",
"template": "$VALUE$ $SIGN$$CURRENCY$",
"sign": "₽"
},
"final_pricing_calc_id": "example",
"final_price": null
}
AvailableCancelState
(deprecated) Признак возможности платной/бесплатной отмены.
Механизм устарел, используйте поле cancel_state метода claim/cancel-info
Type: string
Enum: free, paid
MatchedCar
|
Name |
Description |
|
taxi_class |
Type: string Тариф доставки. Возможные значения: courier, express, cargo Example: |
|
cargo_loaders |
Type: integer Требуемое число грузчиков (int64) Min value: |
|
cargo_type |
Type: string Тип кузова Example: |
|
cargo_type_int |
Type: integer Тип кузова (int64) |
|
client_taxi_class |
Type: string Клиентский тариф Example: |
|
door_to_door |
Type: boolean Опция "от двери до двери" для тарифа "Экспресс" |
|
pro_courier |
Type: boolean Включить опцию "Профи" для тарифов "Экспресс" и "Курьер". |
Example
{
"taxi_class": "express",
"client_taxi_class": "cargo",
"cargo_type": "lcv_m",
"cargo_type_int": "2 is equal to \"lcv_m\"",
"cargo_loaders": 0,
"door_to_door": false,
"pro_courier": false
}
ClaimWarningSourceApi
Источник предупреждения:
- client_requirements - предупреждение связано с требованиями клиента;
- route_points - предупреждение связано
с переданными адресами.
Type: string
Example: client_requirements
ClaimWarningCodeApi
Тип предупреждения:
- not_fit_in_car - груз может не поместиться в транспортное средство;
- requirement_unavailable - указанное требование недоступно и было проигнорировано;
- address_not_found - указанный адрес не найден в Яндекс Картах;
- address_too_far - координаты из Яндекс Карт по указанному адресу находятся далеко от переданных координат.
Type: string
Example: not_fit_in_car
ClaimWarning
|
Name |
Description |
|
code |
Type: ClaimWarningCodeApi Тип предупреждения:
Example: |
|
source |
Type: ClaimWarningSourceApi Источник предупреждения:
Example: |
|
message |
Type: string Описание предупреждения Example: |
Example
{
"source": "client_requirements",
"code": "not_fit_in_car",
"message": "предупреждение"
}
PerformerInfo
Информация о курьере
|
Name |
Description |
|
courier_name |
Type: string Имя курьера, доставляющего посылку Example: |
|
legal_name |
Type: string Данные о юридическом лице, которое осуществляет доставку Example: |
|
car_color |
Type: string Цвет машины Example: |
|
car_color_hex |
Type: string RGB-код цвета машины Example: |
|
car_model |
Type: string Модель машины Example: |
|
car_number |
Type: string Номер машины Example: |
|
transport_type |
Type: string Тип транспорта курьера Example: |
Example
{
"courier_name": "Личность",
"legal_name": "ИП Птичья личность",
"car_model": "Hyundai Solaris",
"car_number": "А100РА100",
"car_color": "красный",
"car_color_hex": "FF00000",
"transport_type": "car"
}
400 Bad Request
Неправильные параметры заявки
Body
application/json
{
"code": "bad_request",
"message": "Неправильное тело запроса"
}
|
Name |
Description |
|
code |
Type: string Код ошибки Enum: |
|
message |
Type: string Сообщение об ошибке, понятное человеку Example: |
403 Forbidden
Ошибка аутентификации или оплата при получении недоступна
Body
application/json
{
"code": "payment_on_delivery_disabled",
"message": "Оплата при получении недоступна"
}
|
Name |
Description |
|
code |
Type: string Код ошибки Enum: |
|
message |
Type: string Описание ошибки Example: |
404 Not Found
Заявка не найдена
Body
application/json
{
"code": "not_found",
"message": "Заявка не найдена"
}
|
Name |
Description |
|
code |
Type: string Код ошибки Enum: |
|
message |
Type: string Описание ошибки Example: |
409 Conflict
Конфликт: попытка изменить статус для неактуальной
версии или неподходящий статус заявки
Body
application/json
{
"code": "inappropriate_status",
"message": "Недопустимое действие над заявкой"
}
|
Name |
Description |
|
code |
Type: string Код ошибки Enum: |
|
message |
Type: string Сообщение об ошибке, понятное человеку Example: |
429 Too Many Requests
Слишком много запросов
Body
application/json
{
"code": "too_many_requests",
"message": "Слишком много запросов"
}
|
Name |
Description |
|
code |
Type: string Код ошибки Enum: |
|
message |
Type: string Описание ошибки Example: |
No longer supported, please use an alternative and newer version.