Поиск заявок

claims

Type: V2ClaimInfo[]

Список найденных заявок

[
  {
    "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": {},
          "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": [
            null,
            null
          ],
          "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": {},
          "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": [
            null,
            null
          ],
          "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": {},
          "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"
    ]
  }
]

cursor

Type: string

Курсор предыдущей страницы поиска

Example: example

height

Type: number

Высота в метрах

Min value: 0

Max value: 500

length

Type: number

Длина в метрах

Min value: 0

Max value: 500

width

Type: number

Ширина в метрах

Min value: 0

Max value: 500

code

Type: string

Код маркировки товара в соответствии с форматом kind

Example: 444D00000000003741

kind

Type: string

Тип маркировки.
Возможные значения:

1. compiled - уже разобранная марка с выделенным GTIN и Serial.
   Пример:
   - 444D00000000003741
2. gs1_data_matrix_base64 - код товара в формате GS1 Data Matrix,
   подлежащий маркировке средствами идентификации.
   Максимум 200 символов.
   Код товара необходимо передавать целиком,
   закодировав строку в формат base64.

Example: gs1_data_matrix_base64

article

Type: ItemArticle

Артикул товара.
Должен быть уникальным для товаров, передаваемых из одной точки.

Example: 20ML50OWKY4FC86

excise

Type: Money

Сумма акциза

Стоимость доставки в формате десятичной дроби Decimal(18, 4)

Pattern: ^-?[0-9]{1,14}(\.[0-9]{0,4})?$

Example: 12.50

item_type

Type: ItemType

Тип наименования: товар или услуга.
Значение по умолчанию: product

Enum: product, service

mark

Type: ItemMark

Уникальный код товара (КИЗ). Актуален для РФ.
Если товары имеют уникальный код, то на каждый товар необходимо создать отдельный блок

{
  "kind": "gs1_data_matrix_base64",
  "code": "444D00000000003741"
}

supplier_inn

Type: SupplierInn

ИНН поставщика (10 или 12 цифр).

Pattern: ^[A-Z0-9\\-]+$

Example: 3664069397

vat_code_str

Type: VatCodeStrApi

Ставка НДС. Возможные значения:
vat_none - без НДС;
vat0 - нулевая ставка НДС (применяется в редких случаях);
vat10 - ставка НДС 10%;
vat20 - ставка НДС 20%.

Example: vat_none

cost_currency

Type: Currency

Трехзначный код валюты, в которой ведется расчет

Min length: 3

Max length: 3

Example: RUB

cost_value

Type: string

Цена за единицу товара в валюте cost_currency.
Для страхования стоимости передайте фактическую цену груза

Pattern: ^[0-9]+(\.[0-9]{1,2})?$

Example: 2.00

dropoff_point

Type: integer

Идентификатор точки (int64), куда нужно доставить
товар. Отличается от идентификатора в заявке.

Может быть любым числом. Должен соответствовать значению route_points[].point_id
у точки назначения

pickup_point

Type: integer

Идентификатор точки (int64), откуда нужно забрать
товар. Отличается от идентификатора в заявке.

Может быть любым числом. Должен соответствовать значению route_points[].point_id
у точки отправки

quantity

Type: integer

Количество товара в единицах (int64)

Min value: 1

title

Type: string

Наименование единицы товара

Example: Плюмбус

age_restricted

Type: boolean

Нужно ли проверить возраст клиента при выдаче товара

Default: false

droppof_point

Type: integer

deprecated, use dropoff_point

extra_id

Type: string

Краткий уникальный идентификатор товара (номер заказа в рамках заявки, как правило идентичен external_order_id)

Example: БП-208

fiscalization

Type: ItemFiscalization

Информация по фискализации (актуально для оплаты при получении)

{
  "excise": "12.50",
  "vat_code_str": "vat_none",
  "supplier_inn": "3664069397",
  "article": "20ML50OWKY4FC86",
  "mark": {
    "kind": "gs1_data_matrix_base64",
    "code": "444D00000000003741"
  },
  "item_type": "product"
}

size

Type: 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 м

{
  "length": 0.1,
  "width": 0.2,
  "height": 0.3
}

weight

Type: number

Вес единицы товара в кг. В поле следует передавать актуальные значения.

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

Если фактические характеристики отправления превысят допустимые,
курьер вправе отказаться от выполнения такого заказа на месте.
В этом случае будет удержана стоимость подачи.

Курьер (courier): до 10 кг
Экспресс (express): до 20 кг
Грузовой (cargo):

• Маленький кузов: до 300 кг
• Средний кузов: до 700 кг
• Большой кузов: до 1400 кг

name

Type: string

Имя контактного лица

Example: Морти

phone

Type: string

Телефон контактного лица

Example: +79099999998

email

Type: string

Email — обязательный параметр для точек с типом source и return

Example: example@yandex.ru

phone_additional_code

Type: string

Добавочный номер для звонка курьера

Example: 602 17 500

fullname

Type: AddressFullname

Полный адрес с указанием города, улицы и номера дома.
Номер квартиры, подъезда и этаж указывать не нужно.

Example: Санкт-Петербург, Большая Монетная улица, 1к1А

building

Type: string

Строение

Example: 23к1А

building_name

Type: string

Название апартаментов (здания)

Example: БЦ На Большой Монетной

city

Type: string

Город

Example: Санкт-Петербург

comment

Type: string

Комментарий для курьера.

Для точки отправки используйте шаблон: "Доставка из магазина <>. Сообщите менеджеру, что заказ для Яндекс Доставки. Назовите номер заказа <> и заберите посылку. Заказ оплачен безналично, при передаче заказа нельзя требовать с получателя деньги за доставку."

Для точек доставки в комментарии передавайте пожелания получателя. Например, "домофон не работает" / "шлагбаум закрыт, позвонить за 10 минут" / "не звонить, спит ребенок".

Max length: 7000

Example: Домофон не работает

coordinates

Type: number[]

Координаты точек в виде массива из двух вещественных чисел: долгота, широта — именно в таком порядке.
Указываются округленные значения координат.

Min items: 2

Max items: 2

[
  0.5,
  0.5
]

country

Type: string

Страна

Example: Россия

description

Type: string

Географическая область, уточняющая краткий адрес до глобального соответствия

Example: Санкт-Петербург, Россия

door_code

Type: string

Код домофона

Example: 169

door_code_extra

Type: string

Дополнительные указания по домофонам

Example: код на вход во двор #1234, код от апартаментов #4321

doorbell_name

Type: string

Имя на дверном звонке

Example: Магидович

porch

Type: string

Подъезд (может быть A)

Example: A

sflat

Type: string

Квартира

Example: 1

sfloor

Type: string

Этаж

Example: 1

shortname

Type: string

Краткий адрес в пределах города (как на Таксометре)

Example: Большая Монетная улица, 1к1А

street

Type: string

Улица

Example: Большая Монетная улица

uri

Type: string

URI геообъекта на картах

Example: ymapsbm1://geo?ll=38.805%2C55.084

email

Type: string

Электронная почта пользователя. Если не указано, будет использована почта получателя из точки назначения

Example: example@yandex.ru

full_name

Type: string

Для юридического лица — название организации, для ИП и физического лица — ФИО

Example: Морти

inn

Type: Inn

ИНН пользователя (10 или 12 цифр)

Pattern: ^[A-Z0-9\\-]+$

Example: 3664069397

phone

Type: string

Телефон пользователя в формате +X XXX XXX XX XX. Если не указано, будет использован телефон получателя из точки назначения

Example: 79000000000

is_paid

Type: PaymentComplete

Признак оплаты заказа

Example: false

client_order_id

Type: ClientOrderId

Внешний идентификатор клиентского заказа

Example: 100

customer

Type: CustomerFiscalization

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

{
  "full_name": "Морти",
  "inn": "3664069397",
  "email": "example@yandex.ru",
  "phone": "79000000000"
}

invoice_link

Type: InvoiceLink

Ссылка на чек

Example: https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024

payment_method

Type: PaymentMethod

Выбранный тип оплаты.
card - оплата картой;
cash - оплата наличными (пока недоступна);

Enum: card, cash

payment_ref_id

Type: PaymentId

Идентификатор оплаты

Example: 123e4567-e89b-12d3-a456-426614174000

currency

Type: string

Валюта

Example: RUB

currency_sign

Type: string

Знак валюты

Example: ₽

value

Type: string

Стоимость

Example: 100.0

from

Type: string<date-time>

Начало интервала

Example: 2020-01-01T00:00:00+00:00

to

Type: string<date-time>

Окончание интервала

Example: 2020-01-02T00:00:00+00:00

actual

Type: string<date-time>

Фактическое время посещения точки.
Заполняется только для посещенных точек.

Example: 2025-01-01T00:00:00Z

expected

Type: string<date-time>

Расчетное время посещения. Может быть заполнено
только для непосещенных точек.

Example: 2025-01-01T00:00:00Z

expected_waiting_time_sec

Type: integer

Расчетное время ожидания в точке. (int64)

address

Type: CargoPointAddress

Адрес точки

{
  "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": "Санкт-Петербург, Россия"
}

contact

Type: ContactOnPoint

Информация о контактном лице

{
  "name": "Морти",
  "phone": "+79099999998",
  "phone_additional_code": "602 17 500",
  "email": "example@yandex.ru"
}

id

Type: integer

Целочисленный идентификатор точки (int64)

type

Type: PointType

Тип точки:

• source - точка отправления, где курьер забирает товар
• destination – точки назначения, где курьер передает товар
• return - точка возврата товара (добавляется автоматически и по умолчанию совпадает с точкой отправления, но также можно определить другую точку)

Enum: source, destination, return

visit_order

Type: integer

Порядок посещения точки (нумерация начинается с 1) (int64)

visit_status

Type: PointVisitStatus

Статус посещения точки:

• pending - точка еще не посещена;
• arrived - курьер прибыл на точку;
• visited - курьер передал/забрал груз на точке;
• skipped - точка пропущена (в случае, если не смог принять товар).

Enum: pending, arrived, visited, skipped

visited_at

Type: PointVisitTime

Информация о времени посещения точки

{
  "expected": "2025-01-01T00:00:00Z",
  "expected_waiting_time_sec": 0,
  "actual": "2025-01-01T00:00:00Z"
}

expected_visit_interval

Type: ExpectedVisitInterval

Временной интервал посещения курьером точки согласно выбранному офферу

{
  "from": "2020-01-01T00:00:00+00:00",
  "to": "2020-01-02T00:00:00+00:00"
}

external_order_cost

Type: ExternalOrderCost

Стоимость внешнего заказа, привязанного к точке

{
  "value": "100.0",
  "currency": "RUB",
  "currency_sign": "₽"
}

external_order_id

Type: string

Номер заказа из системы клиента.
Передается для точки типа destination

Example: 100

leave_under_door

Type: boolean

Оставить посылку у двери

meet_outside

Type: boolean

Курьера встретят на улице у подъезда

no_door_call

Type: boolean

Не звонить в дверь

payment_on_delivery

Type: ResponsePaymentOnDelivery

Параметры оплаты при получении

{
  "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"
}

pickup_code

Type: PickupCode

Код выдачи посылки курьеру.
Курьеру потребуется ввести этот код, чтобы подтвердить, что он забрал посылку.
Для этого необходимо, чтобы ваши сотрудники на точке выдачи имели возможность назвать этот код курьеру.
Актуально для точки с типом 'source'.
Формат кода: 6 цифр
|
Код выдачи товара (ПВЗ)

Example: 893422

return_comment

Type: string

Комментарий к причинам возврата груза

Example: example

return_reasons

Type: string[]

Причины возврата груза

[
  "example"
]

skip_confirmation

Type: CargoPointSkipConfirmation

Пропускать подтверждение по смс в данной точке

Значение по умолчанию: false (подтверждение требуется).

Default: false

Example: false

code

Type: string

Код ошибки

Example: some_error

message

Type: string

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

Example: Some error

name

Type: string

Имя контактного лица

Example: Рик

phone

Type: string

Телефон контактного лица

Example: +79826810246

phone_additional_code

Type: string

Добавочный номер для звонка курьера

Example: 602 17 500

offer_id

Type: TaxiOfferId

Идентификатор предложения

Example: 28ae5f1d72364468be3f5e26cd6a66bf

price

Type: Money

decimal цена по предложению

Стоимость доставки в формате десятичной дроби Decimal(18, 4)

Pattern: ^-?[0-9]{1,14}(\.[0-9]{0,4})?$

Example: 12.50

price_raw

Type: integer

(deprecated) Цена по офферу в валюте, указанной в договоре (int64)

offer_id

Type: TaxiOfferId

Идентификатор предложения

Example: 28ae5f1d72364468be3f5e26cd6a66bf

price

Type: Money

Цена по предложению без НДС

Стоимость доставки в формате десятичной дроби Decimal(18, 4)

Pattern: ^-?[0-9]{1,14}(\.[0-9]{0,4})?$

Example: 12.50

price_raw

Type: integer

(deprecated) Цена по предложению в валюте, указанной (int64) в договоре

price_with_vat

Type: Money

Стоимость доставки в формате десятичной дроби Decimal(18, 4)

Pattern: ^-?[0-9]{1,14}(\.[0-9]{0,4})?$

Example: 12.50

valid_until

Type: string<date-time>

Время до которого действительно предложение на принятие заявки. Если значения нет, то ограничений по длительности предложения нет

Example: 2020-01-01T00:00:00+00:00

code

Type: Currency

Трехзначный код валюты, в которой ведется расчет

Min length: 3

Max length: 3

Example: RUB

template

Type: string

Шаблон для отображения валюты

Example: $VALUE$ $SIGN$$CURRENCY$

text

Type: string

Сокращенное наименование валюты

Example: руб.

sign

Type: string

Символ валюты

Example: ₽

currency

Type: string

Трехзначный код валюты, в которой ведется расчет

Example: RUB

currency_rules

Type: CurrencyRules

Правила отображения валюты

{
  "code": "RUB",
  "text": "руб.",
  "template": "$VALUE$ $SIGN$$CURRENCY$",
  "sign": "₽"
}

final_price

Type: Money

Окончательная цена доставки с учетом НДС.
Заполняется после окончания доставки/возврата.

Стоимость доставки в формате десятичной дроби Decimal(18, 4)

Pattern: ^-?[0-9]{1,14}(\.[0-9]{0,4})?$

Example: 12.50

final_pricing_calc_id

Type: string

Идентификатор расчета стоимости

Example: example

offer

Type: TaxiOffer

Предложение от Яндекс Доставки (актуально в течение некоторого времени).

{
  "offer_id": "28ae5f1d72364468be3f5e26cd6a66bf",
  "price_raw": 12,
  "price": "12.50",
  "valid_until": "2020-01-01T00:00:00+00:00",
  "price_with_vat": null
}

taxi_class

Type: string

Тариф доставки. Возможные значения: courier, express, cargo

Example: express

assign_robot

Type: boolean

Разрешить выполнение заказа ровером (шестиколесный робот)

cargo_loaders

Type: integer

Число грузчиков для грузового тарифа.
Возможные значения: 0, 1, 2.

Точный список возможных значений для конкретной точки
уточняйте с помощью метода получения тарифов tariffs.

Min value: 0

cargo_options

Type: CargoOptions

Список дополнительных опций тарифа.

Возможные отдельные опции:

• auto_courier (курьер только на автомобиле)
• thermobag (курьер с термосумкой)

Пример списка опций: ["auto_courier"].

Точный список возможных значений для конкретной геоточки
уточните с помощью метода получения тарифов tariffs

[
  "thermobag"
]

cargo_type

Type: CargoType

Тип (размер) кузова для грузового тарифа.
Возможные значения:

• van ("Маленький кузов")
• lcv_m ("Средний кузов")
• lcv_l ("Большой кузов")
• lcv_xl ("Кузов XL")
  Точный список возможных значений для конкретной геоточки уточняйте с помощью метода получения тарифов tariffs

Enum: van, lcv_m, lcv_l, lcv_xl

pro_courier

Type: boolean

Включить опцию "Профи" для тарифов "Экспресс" и "Курьер".
Поиск исполнителя будет происходить только среди опытных курьеров.

rental_duration

Type: integer

Время аренды, которое планирует клиент. Указывается в минутах.
Указывайте этот параметр только для почасового тарифа

taxi_classes

Type: string[]

Классы такси. Используем строго эти классы, без дополнительных проверок

Min items: 1

[
  "express"
]

taxi_class

Type: string

Тариф доставки. Возможные значения: courier, express, cargo

Example: express

cargo_loaders

Type: integer

Требуемое число грузчиков (int64)

Min value: 0

cargo_type

Type: string

Тип кузова

Example: lcv_m

cargo_type_int

Type: integer

Тип кузова (int64)

client_taxi_class

Type: string

Клиентский тариф

Example: cargo

door_to_door

Type: boolean

Опция "от двери до двери" для тарифа "Экспресс"

pro_courier

Type: boolean

Включить опцию "Профи" для тарифов "Экспресс" и "Курьер".
Поиск исполнителя будет происходить только среди опытных курьеров.

code

Type: ClaimWarningCodeApi

Тип предупреждения:

• not_fit_in_car - груз может не поместиться в транспортное средство;
• requirement_unavailable - указанное требование недоступно и было проигнорировано;
• address_not_found - указанный адрес не найден в Яндекс Картах;
• address_too_far - координаты из Яндекс Карт по указанному адресу находятся далеко от переданных координат.

Example: not_fit_in_car

source

Type: ClaimWarningSourceApi

Источник предупреждения:

• client_requirements - предупреждение связано с требованиями клиента;
• route_points - предупреждение связано
  с переданными адресами.

Example: client_requirements

message

Type: string

Описание предупреждения

Example: предупреждение

courier_name

Type: string

Имя курьера, доставляющего посылку

Example: Личность

legal_name

Type: string

Данные о юридическом лице, которое осуществляет доставку

Example: ИП Птичья личность

car_color

Type: string

Цвет машины

Example: красный

car_color_hex

Type: string

RGB-код цвета машины

Example: FF00000

car_model

Type: string

Модель машины

Example: Hyundai Solaris

car_number

Type: string

Номер машины

Example: А100РА100

transport_type

Type: string

Тип транспорта курьера

Example: car

callback_url

Type: string

URL, который вызывается при смене статусов по заявке.

Этот механизм устарел и может быть ненадежен, рекомендуем использовать в связке с claims/journal

Pattern: ^https?:.*

Example: https://www.example.com/

delivery_interval

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

{
  "from": "2020-01-01T07:00:00+00:00",
  "to": "2020-01-01T07:00:00+00:00"
}

created_ts

Type: string<date-time>

Дата и время создания заявки

Example: 2020-01-01T00:00:00+00:00

id

Type: ClaimId

Идентификатор(ID) заявки, полученный на этапе создания заявки

Min length: 32

Max length: 64

Example: 741cedf82cd464fa6fa16d87155c636

items

Type: V2CargoItem[]

Параметры товаров

Min items: 1

[
  {
    "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
  }
]

revision

Type: integer

Ревизия (int64)

route_points

Type: V2ResponseCargoRoutePoints

Информация по точкам маршрута

Min items: 2

[
  {
    "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"
    }
  }
]

status

Type: ClaimStatus

Статус заявки. Подробнее см. в разделе Статусная модель

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

updated_ts

Type: string<date-time>

Дата и время последнего обновления заявки

Example: 2020-01-01T00:00:00+00:00

user_request_revision

Type: string

Текущая версия изменений в заявке, переданная пользователем

Example: example

version

Type: integer

Версия (int64)

available_cancel_state

Type: AvailableCancelState

(deprecated) Признак возможности платной/бесплатной отмены.
Механизм устарел, используйте поле cancel_state метода claim/cancel-info

Enum: free, paid

callback_properties

Type: CallbackProperties

Параметры уведомления сервера клиента о смене статуса заявки.

Уведомление представляет собой POST-запрос по указанному url, к
которому будут добавлены информация о дате последнего изменения
заявки и идентификатора заявки в виде
'updated_ts=&claim_id=<id заявки>', то есть url вида
'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 секунд).

{
  "callback_url": "https://www.example.com/"
}

client_requirements

Type: ClientRequirements

Требования от клиента, указанные при создании или редактировании заявки

{
  "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
}

comment

Type: string

Общий комментарий к заказу

Example: Ресторан

corp_client_id

Type: CorpClientId

Идентификатор корпоративного клиента Яндекс Доставки (из OAuth-токена)

Min length: 32

Max length: 32

Example: cd8cc018bde34597932855e3cfdce927

current_point_id

Type: ClaimPointId

Целочисленный идентификатор точки (int64), генерируемый
на стороне Яндекс Доставки.
Содержится в поле route_points[].id. Применимо к точкам с типом
source, destination, return.

Example: 372036854775807

due

Type: Due

Желаемое время прибытия исполнителя на точку А (source).
В РФ отложить расчетное время прибытия исполнителя можно:
- на 30-240 минут от текущего момента – для тарифа express;
- на пять суток от текущего момента – для тарифа cargo.

Параметр не совместим с опциями замедления в тарифе express на территории РФ.
Если этот параметр не задан, то запустится поиск исполнителя на ближайшее время.

Example: 2020-01-01T00:00:00+00:00

emergency_contact

Type: ContactWithPhone

Информация о контактном лице с номером телефона

{
  "name": "Рик",
  "phone": "+79826810246",
  "phone_additional_code": "602 17 500"
}

error_messages

Type: HumanErrorMessage[]

Список сообщений об ошибках

[
  {
    "code": "some_error",
    "message": "Some error"
  }
]

eta

Type: Eta

Расчетное время выполнения заказа в минутах (int64)

Example: 10

matched_cars

Type: MatchedCar[]

Информация о подобранном тарифе

[
  {
    "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
  }
]

optional_return

Type: OptionalReturn

Отключить возврат товаров в случае отмены заказа.

Возможные значения:

• true (курьер оставляет товар себе)
• false (по умолчанию, требуется вернуть товар)

Default: false

Example: false

performer_cancel_reasons

Type: string[]

Причины, по которым курьер отменил доставку заказа

[
  "example"
]

performer_info

Type: PerformerInfo

Информация об исполнителе

Информация о курьере

{
  "courier_name": "Личность",
  "legal_name": "ИП Птичья личность",
  "car_model": "Hyundai Solaris",
  "car_number": "А100РА100",
  "car_color": "красный",
  "car_color_hex": "FF00000",
  "transport_type": "car"
}

pricing

Type: ClaimPricing

Информация о стоимости заказа

{
  "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
}

route_id

Type: string

Идентификатор машрута, в рамках которого доставляется заказ
Если несколько заказов доставляются одним курьером,
они будут иметь одинаковый route_id
(Актуально только для доставки "В течение дня")

Example: example

same_day_data

Type: SameDayData

Дополнительная информация для заявок В течение дня. Недоступно в России

{
  "delivery_interval": {
    "from": "2020-01-01T07:00:00+00:00",
    "to": "2020-01-01T07:00:00+00:00"
  }
}

shipping_document

Type: string

Сопроводительные документы

Example: example

skip_act

Type: SkipAct

Не показывать акт приема-передачи

Example: false

skip_client_notify

Type: SkipClientNotify

Не отправлять отправителю/получателю смс-уведомления,
когда к нему направится курьер.

Значение по умолчанию: false (отправлять уведомления)

Default: false

Example: false

skip_door_to_door

Type: SkipDoorToDoor

Отключить доставку до двери (выключить опцию "От двери до двери").

Возможные значения:

• true (курьер доставит заказ только на улицу, до подъезда)
• false (курьер доставит до двери) - значение по умолчанию

Default: false

Example: false

skip_emergency_notify

Type: SkipEmergencyNotify

Не отправлять уведомление запасному контактному лицу

Значение по умолчанию: false (отправлять уведомления)

Default: false

Example: false

taxi_offer

Type: TaxiOfferDeprecated

Предложение от Такси (актуально в течение некоторого времени). Данный механизм устарел, используйте pricing.offer

{
  "offer_id": "28ae5f1d72364468be3f5e26cd6a66bf",
  "price_raw": 12,
  "price": "12.50"
}

warnings

Type: ClaimWarning[]

Предупреждения по ходу обработки заявки

[
  {
    "source": "client_requirements",
    "code": "not_fit_in_car",
    "message": "предупреждение"
  }
]

code

Type: string

Код ошибки

Enum: unknown_error, validation_error

message

Type: string

Сообщение об ошибке, понятное человеку

Example: Ошибка валидации

code

Type: string

Код ошибки

Enum: unknown_error, too_many_requests

message

Type: string

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

Example: Слишком много запросов