--- metadata: - name: generator content: Diplodoc Platform v5.52.0 alternate: - https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2ClaimsCreate.md - https://yandex.com/support/delivery-profile/ru/api/express/openapi/IntegrationV2ClaimsCreate.md - href: en/api/express/openapi/IntegrationV2ClaimsCreate.md type: text/markdown title: Markdown version - href: ../../../llms.txt type: text/markdown title: llms.txt --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/support/delivery-profile/en/llms.txt
# Create claim The method creates a claim with the specified parameters in the system Yandex Delivery. Sending a request doesn''t mean that the order has been accepted. For same-day delivery, you need to fill in the `same_day_data` field in the request body and specify the dimensions and weight of the item. You don''t need to fill out the `client_requirements` section. The delivery rate in the same day is unavailable in Russia. You can find out the order evaluation result using the method [claims/info](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2ClaimsInfo.md). ## Request
POST {.openapi__method} ```text translate=no b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/create ```
Service URL
### Query parameters #| || **Name** | **Description** || || _request_id_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Idempotency token. Letters, numbers, and other symbols are allowed. To guarantee that values are unique, we recommend using the uuid format and its derivatives. If a server error (code 5xx) or timeout occur when creating a claim, use the same value to retry. (Otherwise, claim duplicating is possible, which may result in multiple couriers coming for the order). In other cases (when creating a new claim), use the new request_id value. # [Learn more](https://yandex.com/support/delivery-profile/en/api/express/faq.md#claim-create) _Min length:_{.json-schema-reset .json-schema-assertion} `1` _Max length:_{.json-schema-reset .json-schema-assertion} `128` _Example:_{.json-schema-reset .json-schema-example} `` {.table-cell} || |#{.json-schema-properties} ### Headers #| || **Name** | **Description** || || _Accept-Language_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Preferred response language. Examples: "en" — English _Example:_{.json-schema-reset .json-schema-example} `en` {.table-cell} || |#{.json-schema-properties}
### Body {% cut "application/json" %} ```json translate=no { "shipping_document": "example", "items": [ { "extra_id": "BP-208", "pickup_point": 1, "droppof_point": 2, "title": "Plumbus", "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" } } ], "route_points": [ { "point_id": 6987, "visit_order": 1, "contact": { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "+79123456789" }, "payment_method": null }, "external_order_id": "100", "external_order_cost": { "value": "100.0", "currency": "RUB", "currency_sign": "₽" }, "pickup_code": "893422" }, { "point_id": 6987, "visit_order": 1, "contact": { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "+79123456789" }, "payment_method": null }, "external_order_id": "100", "external_order_cost": { "value": "100.0", "currency": "RUB", "currency_sign": "₽" }, "pickup_code": "893422" } ], "emergency_contact": { "name": "Rick", "phone": "+79826810246", "phone_additional_code": "602 17 500" }, "client_requirements": { "taxi_class": "express", "cargo_type": "lcv_m", "cargo_loaders": 0, "cargo_options": [ "thermobag" ], "pro_courier": false }, "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": "Restaurant", "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" } ``` {% endcut %} #| || **Name** | **Description** || || _items_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [V2CargoItem](#entity-V2CargoItem)[] Item parameters _Min items:_{.json-schema-reset .json-schema-assertion} `1` {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "extra_id": "BP-208", "pickup_point": 1, "droppof_point": 2, "title": "Plumbus", "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" } } ] ``` {% endcut %} {.table-cell} || || _route_points_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [V2CargoRoutePoints](#entity-V2CargoRoutePoints) Route point information _Min items:_{.json-schema-reset .json-schema-assertion} `2` {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "point_id": 6987, "visit_order": 1, "contact": { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "+79123456789" }, "payment_method": null }, "external_order_id": "100", "external_order_cost": { "value": "100.0", "currency": "RUB", "currency_sign": "₽" }, "pickup_code": "893422" }, { "point_id": 6987, "visit_order": 1, "contact": { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "+79123456789" }, "payment_method": null }, "external_order_id": "100", "external_order_cost": { "value": "100.0", "currency": "RUB", "currency_sign": "₽" }, "pickup_code": "893422" } ] ``` {% endcut %} {.table-cell} || || _auto_accept_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: boolean Enable automatic claim confirmation after creation. A manager's approval is required to use this option {.table-cell} || || _callback_properties_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [CallbackProperties](#entity-CallbackProperties) Parameters for notifying the client's server about the claim status change. A notification is a POST request to the specified URL to which information about the date of the last claim change and claim ID in the format 'updated_ts=&claim_id=' will be added. Which means that this URL 'https://example.com/?my_order_id=123&' format will be expanded into 'https://example.com/?my_order_id=123&updated_ts=...&claim_id=...'. Note that parameters are added by concatenation to callback_url, which means that the URL such as 'https://example.com' will turn into this invalid format: 'https://example.comupdated_ts=...&claim_id=...'. Only HTTP and HTTPS are supported. In the case of HTTPS, an SSL certificate must be issued by a certification authority known to the server. Notifications should be viewed as a push ahead of polling, a way of speeding up information on status changes. The server expects the 200 response, and if there are timeouts or any other response, it will attempt to deliver the notification and then stop the attempts. So in order to reliably obtain the claim status, the client needs to request information using the method [claims/info](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2ClaimsInfo.md). The client should note that the response of the [claims/info](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2ClaimsInfo.md) operation may contain an older claim state (the value of the updated_ts field should be used as a reference). In this case, the operation call must be repeated after some time (from 5 to 30 seconds). {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "callback_url": "https://www.example.com/" } ``` {% endcut %} {.table-cell} || || _client_requirements_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ClientRequirements](#entity-ClientRequirements) Customer requirements specified when creating or editing a claim {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "taxi_class": "express", "cargo_type": "lcv_m", "cargo_loaders": 0, "cargo_options": [ "thermobag" ], "pro_courier": false } ``` {% endcut %} {.table-cell} || || _comment_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Comment to the order _Max length:_{.json-schema-reset .json-schema-assertion} `7000` _Example:_{.json-schema-reset .json-schema-example} `Restaurant` {.table-cell} || || _due_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [Due](#entity-Due) Estimated time of arrival of the courier. (In Russia, you can postpone the estimated time of arrival by 30-60 minutes from the current moment). If this parameter isn''t specified, we will look for a courier as soon as possible. _Example:_{.json-schema-reset .json-schema-example} `2020-01-01T00:00:00+00:00` {.table-cell} || || _emergency_contact_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ContactWithPhone](#entity-ContactWithPhone) Information about the contact person with a phone number {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "name": "Rick", "phone": "+79826810246", "phone_additional_code": "602 17 500" } ``` {% endcut %} {.table-cell} || || _offer_payload_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Payload obtained using the method [offers/calculate](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2OfferCalculate.md) _Example:_{.json-schema-reset .json-schema-example} `asjdijasDKL;ahsdfljhlkjhasF;HS;Ldjf;ljloshf` {.table-cell} || || _optional_return_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [OptionalReturn](#entity-OptionalReturn) Disable item return in case of order cancellation. Possible values: - true (the courier keeps the item) - false (by default, the item must be returned) _Default:_{.json-schema-reset .json-schema-value} `false` _Example:_{.json-schema-reset .json-schema-example} `false` {.table-cell} || || _referral_source_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Claim source (the name of the CMS where the request is created can be entered) _Example:_{.json-schema-reset .json-schema-example} `bitrix` {.table-cell} || || _same_day_data_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [SameDayData](#entity-SameDayData) Features of a "Same-day delivery" order Additional information for `Same-day delivery` claims. The option is unavailable in Russia. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "delivery_interval": { "from": "2020-01-01T07:00:00+00:00", "to": "2020-01-01T07:00:00+00:00" } } ``` {% endcut %} {.table-cell} || || _shipping_document_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Shipping documents _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || || _skip_act_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [SkipAct](#entity-SkipAct) Don't show an acceptance certificate _Example:_{.json-schema-reset .json-schema-example} `false` {.table-cell} || || _skip_client_notify_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [SkipClientNotify](#entity-SkipClientNotify) Don't send SMS notifications to the sender/recipient when a courier is on their way. Default value: false (send notifications) _Default:_{.json-schema-reset .json-schema-value} `false` _Example:_{.json-schema-reset .json-schema-example} `false` {.table-cell} || || _skip_door_to_door_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [SkipDoorToDoor](#entity-SkipDoorToDoor) Disable door-to-door delivery (disable the "Door-to-door" option). Possible values: - true (the courier will deliver the order only at the entrance outside) - false (the courier will deliver the order to the door) - default value _Default:_{.json-schema-reset .json-schema-value} `false` _Example:_{.json-schema-reset .json-schema-example} `false` {.table-cell} || || _skip_emergency_notify_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [SkipEmergencyNotify](#entity-SkipEmergencyNotify) Don't send a notification to the emergency contact person Default value: false (send notifications) _Default:_{.json-schema-reset .json-schema-value} `false` _Example:_{.json-schema-reset .json-schema-example} `false` {.table-cell} || |#{.json-schema-properties}
### CargoItemSizes {#entity-CargoItemSizes} Unit dimensions in meters. The actual values should be added to the fields. If the dimensions aren't added, the order is placed, taking into account the maximum dimensions allowed for the selected rate. If the actual characteristics of the unit exceed the allowed dimensions, the courier has the right to refuse to fulfill the order on site. In this case, the minimum fee will be withheld. Courier: up to 0.80 m × 0.50 m × 0.50 м Express: up to 1.00 m × 0.60 m × 0.50 m Cargo: - Small body: up to 1.70 m × 0.96 m × 0.90 m - Medium body: up to 2.60 m × 1.30 m × 1.50 m - Large body: up to 3.80 m × 1.80 m × 1.80 m #| || **Name** | **Description** || || _height_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: number Height in meters {.table-cell} || || _length_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: number Length in meters {.table-cell} || || _width_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: number Width in meters {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "length": 0.1, "width": 0.2, "height": 0.3 } ``` {% endcut %}
### Currency {#entity-Currency} Three-digit code of the payment currency **Type**: string _Min length:_{.json-schema-reset .json-schema-assertion} `3` _Max length:_{.json-schema-reset .json-schema-assertion} `3` _Example:_{.json-schema-reset .json-schema-example} `RUB`
### Money {#entity-Money} Delivery cost in Decimal(18, 4) format **Type**: string _Pattern:_{.json-schema-reset .json-schema-assertion} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$` _Example:_{.json-schema-reset .json-schema-example} `12.50`
### VatCodeStrApi {#entity-VatCodeStrApi} VAT rate. Possible values: vat_none — without VAT. vat0 — 0% VAT (applied in rare cases). vat10 — 10% VAT. vat20 — 20% VAT. **Type**: string _Example:_{.json-schema-reset .json-schema-example} `vat_none`
### SupplierInn {#entity-SupplierInn} Supplier's ITN (10 or 12 digits). **Type**: string _Pattern:_{.json-schema-reset .json-schema-assertion} `^(\d{10}|\d{12})$` _Example:_{.json-schema-reset .json-schema-example} `3664069397`
### ItemArticle {#entity-ItemArticle} Item SKU. Must be unique for items delivered from one point. **Type**: string _Example:_{.json-schema-reset .json-schema-example} `20ML50OWKY4FC86`
### ItemMark {#entity-ItemMark} Unique item code (control identification sign). Valid for Russia. If items have a unique code, a separate block must be created for each of them #| || **Name** | **Description** || || _code_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Unit marking code in accordance with the format ''kind'' _Example:_{.json-schema-reset .json-schema-example} `444D00000000003741` {.table-cell} || || _kind_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Marking type. Possible values: 1. compiled — disassembled stamp with dedicated GTIN and Serial. Example: - 444D00000000003741 2. gs1_data_matrix_base64 — unit code in GS1 Data Matrix format subject to marking using identification. Maximum 200 characters. The unit code must be entered in full by encoding the string in base64 format. _Example:_{.json-schema-reset .json-schema-example} `gs1_data_matrix_base64` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "kind": "gs1_data_matrix_base64", "code": "444D00000000003741" } ``` {% endcut %}
### ItemType {#entity-ItemType} Name type: product or service. Default value: product **Type**: string _Enum:_{.json-schema-reset .json-schema-value} `product`, `service`
### ItemFiscalization {#entity-ItemFiscalization} Fiscalization information (valid for payment upon receipt) #| || **Name** | **Description** || || _article_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ItemArticle](#entity-ItemArticle) Item SKU. Must be unique for items delivered from one point. _Example:_{.json-schema-reset .json-schema-example} `20ML50OWKY4FC86` {.table-cell} || || _excise_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [Money](#entity-Money) Amount of excise tax Delivery cost in Decimal(18, 4) format _Pattern:_{.json-schema-reset .json-schema-assertion} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$` _Example:_{.json-schema-reset .json-schema-example} `12.50` {.table-cell} || || _item_type_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ItemType](#entity-ItemType) Name type: product or service. Default value: product _Enum:_{.json-schema-reset .json-schema-value} `product`, `service` {.table-cell} || || _mark_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ItemMark](#entity-ItemMark) Unique item code (control identification sign). Valid for Russia. If items have a unique code, a separate block must be created for each of them {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "kind": "gs1_data_matrix_base64", "code": "444D00000000003741" } ``` {% endcut %} {.table-cell} || || _supplier_inn_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [SupplierInn](#entity-SupplierInn) Supplier's ITN (10 or 12 digits). _Pattern:_{.json-schema-reset .json-schema-assertion} `^(\d{10}|\d{12})$` _Example:_{.json-schema-reset .json-schema-example} `3664069397` {.table-cell} || || _vat_code_str_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [VatCodeStrApi](#entity-VatCodeStrApi) VAT rate. Possible values: vat_none — without VAT. vat0 — 0% VAT (applied in rare cases). vat10 — 10% VAT. vat20 — 20% VAT. _Example:_{.json-schema-reset .json-schema-example} `vat_none` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "excise": "12.50", "vat_code_str": "vat_none", "supplier_inn": "3664069397", "article": "20ML50OWKY4FC86", "mark": { "kind": "gs1_data_matrix_base64", "code": "444D00000000003741" }, "item_type": "product" } ``` {% endcut %}
### V2CargoItem {#entity-V2CargoItem} #| || **Name** | **Description** || || _cost_currency_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [Currency](#entity-Currency) Three-digit code of the payment currency _Min length:_{.json-schema-reset .json-schema-assertion} `3` _Max length:_{.json-schema-reset .json-schema-assertion} `3` _Example:_{.json-schema-reset .json-schema-example} `RUB` {.table-cell} || || _cost_value_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Price per item in cost_currency. To insure the cost, enter the actual cargo price _Example:_{.json-schema-reset .json-schema-example} `2.00` {.table-cell} || || _droppof_point_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: integer ID of the point (int64) to deliver the item to. Differs from the ID in the claim. It can be any number. Must match the route_points[].point_id value of the destination point {.table-cell} || || _pickup_point_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: integer ID of the point (int64) to pick up the item from. Differs from the ID in the claim. It can be any number. Must match the route_points[].point_id value of the dispatch point {.table-cell} || || _quantity_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: integer Number of units (int64) _Min value:_{.json-schema-reset .json-schema-assertion} `1` {.table-cell} || || _title_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Item name _Example:_{.json-schema-reset .json-schema-example} `Plumbus` {.table-cell} || || _extra_id_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Short unique item ID (order number in the claim, usually identical to external_order_id) _Max length:_{.json-schema-reset .json-schema-assertion} `512` _Example:_{.json-schema-reset .json-schema-example} `BP-208` {.table-cell} || || _fiscalization_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ItemFiscalization](#entity-ItemFiscalization) Fiscalization information (valid for payment upon receipt) {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "excise": "12.50", "vat_code_str": "vat_none", "supplier_inn": "3664069397", "article": "20ML50OWKY4FC86", "mark": { "kind": "gs1_data_matrix_base64", "code": "444D00000000003741" }, "item_type": "product" } ``` {% endcut %} {.table-cell} || || _size_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [CargoItemSizes](#entity-CargoItemSizes) Unit dimensions in meters. The actual values should be added to the fields. If the dimensions aren't added, the order is placed, taking into account the maximum dimensions allowed for the selected rate. If the actual characteristics of the unit exceed the allowed dimensions, the courier has the right to refuse to fulfill the order on site. In this case, the minimum fee will be withheld. Courier: up to 0.80 m × 0.50 m × 0.50 м Express: up to 1.00 m × 0.60 m × 0.50 m Cargo: - Small body: up to 1.70 m × 0.96 m × 0.90 m - Medium body: up to 2.60 m × 1.30 m × 1.50 m - Large body: up to 3.80 m × 1.80 m × 1.80 m {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "length": 0.1, "width": 0.2, "height": 0.3 } ``` {% endcut %} {.table-cell} || || _weight_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: number Item weight in kg. The actual values should be entered in the field. If the weight isn't added, the order is placed, taking into account the maximum dimensions allowed for the selected rate. If the actual characteristics of the parcel exceed the allowed dimensions, the courier has the right to refuse to fulfill the order on site. In this case, the minimum fee will be withheld. Courier: up to 10 kg Express: up to 20 kg Cargo: - Small body: up to 300 kg - Medium body: up to 700 kg - Large body: up to 1400 kg {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "extra_id": "BP-208", "pickup_point": 1, "droppof_point": 2, "title": "Plumbus", "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" } } ``` {% endcut %}
### ContactOnPoint {#entity-ContactOnPoint} Information about the contact person #| || **Name** | **Description** || || _name_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Name of the contact person _Example:_{.json-schema-reset .json-schema-example} `Rick` {.table-cell} || || _phone_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Phone number of the contact person _Max length:_{.json-schema-reset .json-schema-assertion} `30` _Pattern:_{.json-schema-reset .json-schema-assertion} `[0-9 \\(\\)\\-\\+]+` _Example:_{.json-schema-reset .json-schema-example} `+79123456789` {.table-cell} || || _email_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Email is a mandatory parameter for source and return points _Max length:_{.json-schema-reset .json-schema-assertion} `320` _Pattern:_{.json-schema-reset .json-schema-assertion} `\S+@\S+.\S+` _Example:_{.json-schema-reset .json-schema-example} `example@yandex.ru` {.table-cell} || || _phone_additional_code_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Extension number to call the courier _Example:_{.json-schema-reset .json-schema-example} `602 17 500` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" } ``` {% endcut %}
### AddressFullname {#entity-AddressFullname} Full address with an indication of the city, street, and house number. You don't need to specify the flat, the entrance number, or the floor. **Type**: string _Example:_{.json-schema-reset .json-schema-example} `Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A`
### CargoPointAddress {#entity-CargoPointAddress} Point address #| || **Name** | **Description** || || _fullname_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [AddressFullname](#entity-AddressFullname) Full address with an indication of the city, street, and house number. You don't need to specify the flat, the entrance number, or the floor. _Example:_{.json-schema-reset .json-schema-example} `Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A` {.table-cell} || || _building_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Building _Example:_{.json-schema-reset .json-schema-example} `23f1A` {.table-cell} || || _building_name_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Apartment building name _Example:_{.json-schema-reset .json-schema-example} `BC of Bol'shaya Monetnaya` {.table-cell} || || _city_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string City _Example:_{.json-schema-reset .json-schema-example} `Saint Petersburg` {.table-cell} || || _comment_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Comment for the courier. For the dispatch point, use the template: "Delivery from store <>. Inform the manager that the order is for Yandex Delivery. Provide your order number <> and collect the parcel. The order was paid using cashless payment. So, there's no need to ask the recipient to pay for the delivery when handing over the order." For delivery points, leave the recipient's wishes in the comments. For example, "the intercom doesn't work" / "the gate is closed, call 10 minutes in advance" / "don't call, the baby is asleep". _Max length:_{.json-schema-reset .json-schema-assertion} `7000` _Example:_{.json-schema-reset .json-schema-example} `The intercom doesn't work` {.table-cell} || || _coordinates_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: number[] Coordinates of points in the form of an array of two real numbers: longitude and latitude — exactly in that order. Rounded coordinate values are specified. _Min items:_{.json-schema-reset .json-schema-assertion} `2` _Max items:_{.json-schema-reset .json-schema-assertion} `2` {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ 0.5, 0.5 ] ``` {% endcut %} {.table-cell} || || _country_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Country _Example:_{.json-schema-reset .json-schema-example} `Russia` {.table-cell} || || _description_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string A geographic area that turns a short address into a global match _Example:_{.json-schema-reset .json-schema-example} `Saint Petersburg, Russia` {.table-cell} || || _door_code_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Intercom code _Example:_{.json-schema-reset .json-schema-example} `169` {.table-cell} || || _door_code_extra_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Additional instructions for intercoms _Example:_{.json-schema-reset .json-schema-example} `courtyard entrance code #1234, apartment code #4321` {.table-cell} || || _doorbell_name_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Name on the doorbell _Example:_{.json-schema-reset .json-schema-example} `Magidovich` {.table-cell} || || _porch_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Entrance (may be A) _Example:_{.json-schema-reset .json-schema-example} `A` {.table-cell} || || _sflat_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Flat _Example:_{.json-schema-reset .json-schema-example} `1` {.table-cell} || || _sfloor_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Floor _Example:_{.json-schema-reset .json-schema-example} `1` {.table-cell} || || _shortname_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Short address within the city (like on a Taximeter) _Example:_{.json-schema-reset .json-schema-example} `Bol'shaya Monetnaya Street, 1f1A` {.table-cell} || || _street_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Street _Example:_{.json-schema-reset .json-schema-example} `Bol'shaya Monetnaya street` {.table-cell} || || _uri_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string URI of the geo object on maps _Example:_{.json-schema-reset .json-schema-example} `ymapsbm1://geo?ll=38.805%2C55.084` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" } ``` {% endcut %}
### CargoPointSkipConfirmation {#entity-CargoPointSkipConfirmation} Skip SMS confirmation at the given point Default value: false (confirmation required). **Type**: boolean _Default:_{.json-schema-reset .json-schema-value} `false`
### PointType {#entity-PointType} Point type: - source: the point of departure where the courier picks up the item - destination: destination points where the courier delivers the items - return: item return point (added automatically and matches the point of departure by default, but a different point can also be selected) **Type**: string _Enum:_{.json-schema-reset .json-schema-value} `source`, `destination`, `return`
### PaymentMethod {#entity-PaymentMethod} Selected payment method. card — payment by card. cash — cash payment (not yet available). **Type**: string _Enum:_{.json-schema-reset .json-schema-value} `card`, `cash`
### RequestBuyout {#entity-RequestBuyout} Information on item buyout by the courier at the point of departure (relevant if payment upon receipt is enabled for all destination points on the route). #| || **Name** | **Description** || || _payment_method_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [PaymentMethod](#entity-PaymentMethod) Only cash can be used at the moment Selected payment method. card — payment by card. cash — cash payment (not yet available). _Enum:_{.json-schema-reset .json-schema-value} `card`, `cash` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "payment_method": "card" } ``` {% endcut %}
### Inn {#entity-Inn} User's ITN (10 or 12 digits) **Type**: string _Pattern:_{.json-schema-reset .json-schema-assertion} `^(\d{10}|\d{12})$` _Example:_{.json-schema-reset .json-schema-example} `3664069397`
### RequestCustomerFiscalization {#entity-RequestCustomerFiscalization} Information about the recipient #| || **Name** | **Description** || || _email_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string User's email address in example@yandex.ru format. If not specified, the recipient's email address from the destination point will be used _Max length:_{.json-schema-reset .json-schema-assertion} `320` _Pattern:_{.json-schema-reset .json-schema-assertion} `\S+@\S+.\S+` _Example:_{.json-schema-reset .json-schema-example} `example@yandex.ru` {.table-cell} || || _inn_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [Inn](#entity-Inn) User's ITN (10 or 12 digits) _Pattern:_{.json-schema-reset .json-schema-assertion} `^(\d{10}|\d{12})$` _Example:_{.json-schema-reset .json-schema-example} `3664069397` {.table-cell} || || _phone_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string User's phone number in +X XXX XXX XX XX format. If not specified, the recipient's phone number from the destination point will be used _Max length:_{.json-schema-reset .json-schema-assertion} `30` _Pattern:_{.json-schema-reset .json-schema-assertion} `[0-9 \\(\\)\\-\\+]+` _Example:_{.json-schema-reset .json-schema-example} `+79123456789` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" } ``` {% endcut %}
### RequestPaymentOnDelivery {#entity-RequestPaymentOnDelivery} Information about payment upon receipt (relevant for payment upon receipt) #| || **Name** | **Description** || || _payment_method_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [PaymentMethod](#entity-PaymentMethod) Selected payment method. card — payment by card. cash — cash payment (not yet available). _Enum:_{.json-schema-reset .json-schema-value} `card`, `cash` {.table-cell} || || _customer_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [RequestCustomerFiscalization](#entity-RequestCustomerFiscalization) Information about the recipient {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" } ``` {% endcut %} {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "customer": { "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" }, "payment_method": "card" } ``` {% endcut %}
### ExternalOrderCost {#entity-ExternalOrderCost} Cost of the external order linked to the point #| || **Name** | **Description** || || _currency_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Currency _Example:_{.json-schema-reset .json-schema-example} `RUB` {.table-cell} || || _currency_sign_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Currency symbol _Example:_{.json-schema-reset .json-schema-example} `₽` {.table-cell} || || _value_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Cost _Example:_{.json-schema-reset .json-schema-example} `100.0` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "value": "100.0", "currency": "RUB", "currency_sign": "₽" } ``` {% endcut %}
### PickupCode {#entity-PickupCode} Parcel pick-up code. The courier needs to enter this code to confirm that they have picked up the parcel. This requires your employees to be at the point of dispatch to provide this code to the courier. Relevant for source points. Code format: 6 digits | Item pick-up code (pick-up point) **Type**: string _Min length:_{.json-schema-reset .json-schema-assertion} `6` _Max length:_{.json-schema-reset .json-schema-assertion} `6` _Pattern:_{.json-schema-reset .json-schema-assertion} `\d{6}` _Example:_{.json-schema-reset .json-schema-example} `893422`
### V2CargoPoint {#entity-V2CargoPoint} #| || **Name** | **Description** || || _address_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [CargoPointAddress](#entity-CargoPointAddress) Point address {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" } ``` {% endcut %} {.table-cell} || || _contact_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [ContactOnPoint](#entity-ContactOnPoint) Information about the contact person {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" } ``` {% endcut %} {.table-cell} || || _point_id_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: integer Integer point ID (int64), unique within claim creation {.table-cell} || || _type_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [PointType](#entity-PointType) Point type: - source: the point of departure where the courier picks up the item - destination: destination points where the courier delivers the items - return: item return point (added automatically and matches the point of departure by default, but a different point can also be selected) _Enum:_{.json-schema-reset .json-schema-value} `source`, `destination`, `return` {.table-cell} || || _visit_order_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: integer The order in which the points are visited (numbering starts with 1) (int64) {.table-cell} || || _buyout_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [RequestBuyout](#entity-RequestBuyout) Information on item buyout by the courier at the point of departure (relevant if payment upon receipt is enabled for all destination points on the route). {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "payment_method": "card" } ``` {% endcut %} {.table-cell} || || _external_order_cost_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ExternalOrderCost](#entity-ExternalOrderCost) Cost of the external order linked to the point {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "value": "100.0", "currency": "RUB", "currency_sign": "₽" } ``` {% endcut %} {.table-cell} || || _external_order_id_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Order number from the customer's system. Entered for destination points _Max length:_{.json-schema-reset .json-schema-assertion} `512` _Example:_{.json-schema-reset .json-schema-example} `100` {.table-cell} || || _leave_under_door_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: boolean Leave the parcel at the door {.table-cell} || || _meet_outside_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: boolean The courier will be met outside, at the entrance {.table-cell} || || _no_door_call_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: boolean Don't ring the doorbell {.table-cell} || || _payment_on_delivery_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [RequestPaymentOnDelivery](#entity-RequestPaymentOnDelivery) Information about payment upon receipt (relevant for payment upon receipt) {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "customer": { "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" }, "payment_method": "card" } ``` {% endcut %} {.table-cell} || || _pickup_code_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [PickupCode](#entity-PickupCode) Parcel pick-up code. The courier needs to enter this code to confirm that they have picked up the parcel. This requires your employees to be at the point of dispatch to provide this code to the courier. Relevant for source points. Code format: 6 digits | Item pick-up code (pick-up point) _Min length:_{.json-schema-reset .json-schema-assertion} `6` _Max length:_{.json-schema-reset .json-schema-assertion} `6` _Pattern:_{.json-schema-reset .json-schema-assertion} `\d{6}` _Example:_{.json-schema-reset .json-schema-example} `893422` {.table-cell} || || _skip_confirmation_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [CargoPointSkipConfirmation](#entity-CargoPointSkipConfirmation) Skip SMS confirmation at the given point Default value: false (confirmation required). _Default:_{.json-schema-reset .json-schema-value} `false` _Example:_{.json-schema-reset .json-schema-example} `false` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "point_id": 6987, "visit_order": 1, "contact": { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "+79123456789" }, "payment_method": null }, "external_order_id": "100", "external_order_cost": { "value": "100.0", "currency": "RUB", "currency_sign": "₽" }, "pickup_code": "893422" } ``` {% endcut %}
### V2CargoRoutePoints {#entity-V2CargoRoutePoints} Route point information **Type**: [V2CargoPoint](#entity-V2CargoPoint)[] _Min items:_{.json-schema-reset .json-schema-assertion} `2` {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "point_id": 6987, "visit_order": 1, "contact": { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "+79123456789" }, "payment_method": null }, "external_order_id": "100", "external_order_cost": { "value": "100.0", "currency": "RUB", "currency_sign": "₽" }, "pickup_code": "893422" }, { "point_id": 6987, "visit_order": 1, "contact": { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "+79123456789" }, "payment_method": null }, "external_order_id": "100", "external_order_cost": { "value": "100.0", "currency": "RUB", "currency_sign": "₽" }, "pickup_code": "893422" } ] ``` {% endcut %}
### ContactWithPhone {#entity-ContactWithPhone} Information about the contact person with a phone number #| || **Name** | **Description** || || _name_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Name of the contact person _Example:_{.json-schema-reset .json-schema-example} `Rick` {.table-cell} || || _phone_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Phone number of the contact person _Max length:_{.json-schema-reset .json-schema-assertion} `30` _Pattern:_{.json-schema-reset .json-schema-assertion} `[0-9 \\(\\)\\-\\+]+` _Example:_{.json-schema-reset .json-schema-example} `+79826810246` {.table-cell} || || _phone_additional_code_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Extension number to call the courier _Example:_{.json-schema-reset .json-schema-example} `602 17 500` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "name": "Rick", "phone": "+79826810246", "phone_additional_code": "602 17 500" } ``` {% endcut %}
### CargoType {#entity-CargoType} Body type (size) for the cargo rate.\nPossible values: - van (\"Small body\") - lcv_m (\"Medium body\") - lcv_l (\"Large body\") - lcv_xl ("XL body") For an exact list of possible values for a particular geo point,\nuse the method for obtaining rates [tariffs](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2Tariffs.md) **Type**: string _Enum:_{.json-schema-reset .json-schema-value} `van`, `lcv_m`, `lcv_l`, `lcv_xl`
### CargoOptions {#entity-CargoOptions} List of additional rate options. Possible separate options: - auto_courier (a courier with a vehicle only) - thermobag (a courier with a thermobag) Example of a list of options: ["auto_courier"]. For an exact list of possible values for a particular geo point, use the method for obtaining rates [tariffs](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2Tariffs.md) **Type**: string[] {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ "thermobag" ] ``` {% endcut %}
### ClientRequirements {#entity-ClientRequirements} Customer requirements specified when creating or editing a claim #| || **Name** | **Description** || || _taxi_class_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Delivery rate. Possible values: courier, express, cargo _Example:_{.json-schema-reset .json-schema-example} `express` {.table-cell} || || _cargo_loaders_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: integer Number of loaders for the cargo rate. Possible values: 0, 1, 2. For an exact list of possible values for a particular point, use the method for obtaining rates [tariffs](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2Tariffs.md). _Min value:_{.json-schema-reset .json-schema-assertion} `0` {.table-cell} || || _cargo_options_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [CargoOptions](#entity-CargoOptions) List of additional rate options. Possible separate options: - auto_courier (a courier with a vehicle only) - thermobag (a courier with a thermobag) Example of a list of options: ["auto_courier"]. For an exact list of possible values for a particular geo point, use the method for obtaining rates [tariffs](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2Tariffs.md) {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ "thermobag" ] ``` {% endcut %} {.table-cell} || || _cargo_type_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [CargoType](#entity-CargoType) Body type (size) for the cargo rate.\nPossible values: - van (\"Small body\") - lcv_m (\"Medium body\") - lcv_l (\"Large body\") - lcv_xl ("XL body") For an exact list of possible values for a particular geo point,\nuse the method for obtaining rates [tariffs](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2Tariffs.md) _Enum:_{.json-schema-reset .json-schema-value} `van`, `lcv_m`, `lcv_l`, `lcv_xl` {.table-cell} || || _pro_courier_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: boolean Enable the "Pro" option for "Express" and "Courier" rates. In this case, we will look only for experienced couriers. {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "taxi_class": "express", "cargo_type": "lcv_m", "cargo_loaders": 0, "cargo_options": [ "thermobag" ], "pro_courier": false } ``` {% endcut %}
### CallbackProperties {#entity-CallbackProperties} Parameters for notifying the client's server about the claim status change. A notification is a POST request to the specified URL to which information about the date of the last claim change and claim ID in the format 'updated_ts=&claim_id=' will be added. Which means that this URL 'https://example.com/?my_order_id=123&' format will be expanded into 'https://example.com/?my_order_id=123&updated_ts=...&claim_id=...'. Note that parameters are added by concatenation to callback_url, which means that the URL such as 'https://example.com' will turn into this invalid format: 'https://example.comupdated_ts=...&claim_id=...'. Only HTTP and HTTPS are supported. In the case of HTTPS, an SSL certificate must be issued by a certification authority known to the server. Notifications should be viewed as a push ahead of polling, a way of speeding up information on status changes. The server expects the 200 response, and if there are timeouts or any other response, it will attempt to deliver the notification and then stop the attempts. So in order to reliably obtain the claim status, the client needs to request information using the method [claims/info](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2ClaimsInfo.md). The client should note that the response of the [claims/info](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2ClaimsInfo.md) operation may contain an older claim state (the value of the updated_ts field should be used as a reference). In this case, the operation call must be repeated after some time (from 5 to 30 seconds). #| || **Name** | **Description** || || _callback_url_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The URL used in the case of a status change for the claim. This mechanism is deprecated, use the [claims/journal](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2ClaimsJournal.md) operation instead. _Pattern:_{.json-schema-reset .json-schema-assertion} `^https?:.*` _Example:_{.json-schema-reset .json-schema-example} `https://www.example.com/` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "callback_url": "https://www.example.com/" } ``` {% endcut %}
### SkipDoorToDoor {#entity-SkipDoorToDoor} Disable door-to-door delivery (disable the "Door-to-door" option). Possible values: - true (the courier will deliver the order only at the entrance outside) - false (the courier will deliver the order to the door) - default value **Type**: boolean _Default:_{.json-schema-reset .json-schema-value} `false`
### SkipClientNotify {#entity-SkipClientNotify} Don't send SMS notifications to the sender/recipient when a courier is on their way. Default value: false (send notifications) **Type**: boolean _Default:_{.json-schema-reset .json-schema-value} `false`
### SkipEmergencyNotify {#entity-SkipEmergencyNotify} Don't send a notification to the emergency contact person Default value: false (send notifications) **Type**: boolean _Default:_{.json-schema-reset .json-schema-value} `false`
### SkipAct {#entity-SkipAct} Don't show an acceptance certificate **Type**: boolean
### OptionalReturn {#entity-OptionalReturn} Disable item return in case of order cancellation. Possible values: - true (the courier keeps the item) - false (by default, the item must be returned) **Type**: boolean _Default:_{.json-schema-reset .json-schema-value} `false`
### Due {#entity-Due} Estimated time of arrival of the courier. (In Russia, you can postpone the estimated time of arrival by 30-60 minutes from the current moment). If this parameter isn''t specified, we will look for a courier as soon as possible. **Type**: string<date-time> _Example:_{.json-schema-reset .json-schema-example} `2020-01-01T00:00:00+00:00`
### SameDayData {#entity-SameDayData} Additional information for `Same-day delivery` claims. The option is unavailable in Russia. #| || **Name** | **Description** || || _delivery_interval_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| {% cut "**Type**: object" %} #| || _from_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string<date-time> Interval start _Example:_{.json-schema-reset .json-schema-example} `2020-01-01T07:00:00+00:00` {.table-cell} || || _to_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string<date-time> Interval end (date and time) _Example:_{.json-schema-reset .json-schema-example} `2020-01-01T07:00:00+00:00` {.table-cell} || |#{.json-schema-properties} {% endcut %} Parcel pick-up and delivery interval {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "from": "2020-01-01T07:00:00+00:00", "to": "2020-01-01T07:00:00+00:00" } ``` {% endcut %} {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "delivery_interval": { "from": "2020-01-01T07:00:00+00:00", "to": "2020-01-01T07:00:00+00:00" } } ``` {% endcut %}
## Responses
## 200 OK Ok, claim created
### Body {% cut "application/json" %} ```json translate=no { "id": "741cedf82cd464fa6fa16d87155c636", "corp_client_id": "cd8cc018bde34597932855e3cfdce927", "items": [ { "extra_id": "BP-208", "pickup_point": 1, "droppof_point": 2, "title": "Plumbus", "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" } } ], "route_points": [ { "id": 1, "contact": { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "Morty", "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" }, "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": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "Morty", "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" }, "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": "Rick", "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", "pricing": { "offer": { "offer_id": "28ae5f1d72364468be3f5e26cd6a66bf", "price": null, "valid_until": "2020-01-01T00:00:00+00:00", "price_with_vat": null }, "currency": "RUB", "currency_rules": { "code": null, "text": "rub.", "template": "$VALUE$ $SIGN$$CURRENCY$", "sign": "₽" }, "final_pricing_calc_id": "example", "final_price": null }, "client_requirements": { "taxi_class": "express", "cargo_type": "lcv_m", "cargo_loaders": 0, "cargo_options": [ "thermobag" ], "pro_courier": false }, "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": "warning" } ], "performer_info": { "courier_name": "Person", "legal_name": "Sole Trader Birdperson", "car_model": "Hyundai Solaris", "car_number": "Y100BJF", "car_color": "red", "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": "Restaurant", "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" } } } ``` {% endcut %} #| || **Name** | **Description** || || _created_ts_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string<date-time> Date and time of claim creation _Example:_{.json-schema-reset .json-schema-example} `2020-01-01T00:00:00+00:00` {.table-cell} || || _id_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [ClaimId](#entity-ClaimId) Claim ID obtained at the claim creation stage _Min length:_{.json-schema-reset .json-schema-assertion} `32` _Max length:_{.json-schema-reset .json-schema-assertion} `64` _Example:_{.json-schema-reset .json-schema-example} `741cedf82cd464fa6fa16d87155c636` {.table-cell} || || _items_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [V2CargoItem](#entity-V2CargoItem)[] Item parameters _Min items:_{.json-schema-reset .json-schema-assertion} `1` {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "extra_id": "BP-208", "pickup_point": 1, "droppof_point": 2, "title": "Plumbus", "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" } } ] ``` {% endcut %} {.table-cell} || || _revision_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: integer Revision (int64) {.table-cell} || || _route_points_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [V2ResponseCargoRoutePoints](#entity-V2ResponseCargoRoutePoints) Route point information _Min items:_{.json-schema-reset .json-schema-assertion} `2` {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "id": 1, "contact": { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "Morty", "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" }, "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": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "Morty", "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" }, "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" } } ] ``` {% endcut %} {.table-cell} || || _status_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [ClaimStatus](#entity-ClaimStatus) Claim status. To learn more, see [Status model](https://yandex.com/support/delivery-profile/en/api/express/claim-process.md) _Enum:_{.json-schema-reset .json-schema-value} `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` {.table-cell} || || _updated_ts_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string<date-time> Date and time of the last claim update _Example:_{.json-schema-reset .json-schema-example} `2020-01-01T00:00:00+00:00` {.table-cell} || || _user_request_revision_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The current version of changes in the claim entered by the user _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || || _version_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: integer Version (int64) {.table-cell} || || _callback_properties_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [CallbackProperties](#entity-CallbackProperties) Parameters for notifying the client's server about the claim status change. A notification is a POST request to the specified URL to which information about the date of the last claim change and claim ID in the format 'updated_ts=&claim_id=' will be added. Which means that this URL 'https://example.com/?my_order_id=123&' format will be expanded into 'https://example.com/?my_order_id=123&updated_ts=...&claim_id=...'. Note that parameters are added by concatenation to callback_url, which means that the URL such as 'https://example.com' will turn into this invalid format: 'https://example.comupdated_ts=...&claim_id=...'. Only HTTP and HTTPS are supported. In the case of HTTPS, an SSL certificate must be issued by a certification authority known to the server. Notifications should be viewed as a push ahead of polling, a way of speeding up information on status changes. The server expects the 200 response, and if there are timeouts or any other response, it will attempt to deliver the notification and then stop the attempts. So in order to reliably obtain the claim status, the client needs to request information using the method [claims/info](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2ClaimsInfo.md). The client should note that the response of the [claims/info](https://yandex.com/support/delivery-profile/en/api/express/openapi/IntegrationV2ClaimsInfo.md) operation may contain an older claim state (the value of the updated_ts field should be used as a reference). In this case, the operation call must be repeated after some time (from 5 to 30 seconds). {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "callback_url": "https://www.example.com/" } ``` {% endcut %} {.table-cell} || || _client_requirements_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ClientRequirements](#entity-ClientRequirements) Customer requirements specified when creating or editing a claim {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "taxi_class": "express", "cargo_type": "lcv_m", "cargo_loaders": 0, "cargo_options": [ "thermobag" ], "pro_courier": false } ``` {% endcut %} {.table-cell} || || _comment_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string General comment to the order _Max length:_{.json-schema-reset .json-schema-assertion} `7000` _Example:_{.json-schema-reset .json-schema-example} `Restaurant` {.table-cell} || || _corp_client_id_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [CorpClientId](#entity-CorpClientId) Yandex Delivery corporate client ID (from the OAuth token) _Min length:_{.json-schema-reset .json-schema-assertion} `32` _Max length:_{.json-schema-reset .json-schema-assertion} `32` _Example:_{.json-schema-reset .json-schema-example} `cd8cc018bde34597932855e3cfdce927` {.table-cell} || || _current_point_id_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ClaimPointId](#entity-ClaimPointId) Integer point ID (int64) generated on the Yandex Delivery side. It is in the route_points[].id field. Applicable to source, destination, and return points. _Example:_{.json-schema-reset .json-schema-example} `372036854775807` {.table-cell} || || _due_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [Due](#entity-Due) Estimated time of arrival of the courier. (In Russia, you can postpone the estimated time of arrival by 30-60 minutes from the current moment). If this parameter isn''t specified, we will look for a courier as soon as possible. _Example:_{.json-schema-reset .json-schema-example} `2020-01-01T00:00:00+00:00` {.table-cell} || || _emergency_contact_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ContactWithPhone](#entity-ContactWithPhone) Information about the contact person with a phone number {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "name": "Rick", "phone": "+79826810246", "phone_additional_code": "602 17 500" } ``` {% endcut %} {.table-cell} || || _error_messages_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [HumanErrorMessage](#entity-HumanErrorMessage)[] List of error messages {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "code": "some_error", "message": "Some error" } ] ``` {% endcut %} {.table-cell} || || _eta_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [Eta](#entity-Eta) Estimated order fulfillment time in minutes (int64) _Example:_{.json-schema-reset .json-schema-example} `10` {.table-cell} || || _matched_cars_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [MatchedCar](#entity-MatchedCar)[] Information about the selected rate {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "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 } ] ``` {% endcut %} {.table-cell} || || _optional_return_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [OptionalReturn](#entity-OptionalReturn) Disable item return in case of order cancellation. Possible values: - true (the courier keeps the item) - false (by default, the item must be returned) _Default:_{.json-schema-reset .json-schema-value} `false` _Example:_{.json-schema-reset .json-schema-example} `false` {.table-cell} || || _performer_info_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [PerformerInfo](#entity-PerformerInfo) Information about the executor Information about the courier {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "courier_name": "Person", "legal_name": "Sole Trader Birdperson", "car_model": "Hyundai Solaris", "car_number": "Y100BJF", "car_color": "red", "car_color_hex": "FF00000", "transport_type": "car" } ``` {% endcut %} {.table-cell} || || _pricing_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ClaimPricing](#entity-ClaimPricing) Information about the order cost {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "offer": { "offer_id": "28ae5f1d72364468be3f5e26cd6a66bf", "price": "12.50", "valid_until": "2020-01-01T00:00:00+00:00", "price_with_vat": null }, "currency": "RUB", "currency_rules": { "code": "RUB", "text": "rub.", "template": "$VALUE$ $SIGN$$CURRENCY$", "sign": "₽" }, "final_pricing_calc_id": "example", "final_price": null } ``` {% endcut %} {.table-cell} || || _route_id_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string ID of the route within which the order is delivered If multiple orders are delivered by one courier, all of them will have the same route_id (Relevant only for the "Same-day delivery") _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || || _same_day_data_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [SameDayData](#entity-SameDayData) Additional information for `Same-day delivery` claims. The option is unavailable in Russia. {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "delivery_interval": { "from": "2020-01-01T07:00:00+00:00", "to": "2020-01-01T07:00:00+00:00" } } ``` {% endcut %} {.table-cell} || || _shipping_document_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Shipping documents _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || || _skip_act_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [SkipAct](#entity-SkipAct) Don't show an acceptance certificate _Example:_{.json-schema-reset .json-schema-example} `false` {.table-cell} || || _skip_client_notify_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [SkipClientNotify](#entity-SkipClientNotify) Don't send SMS notifications to the sender/recipient when a courier is on their way. Default value: false (send notifications) _Default:_{.json-schema-reset .json-schema-value} `false` _Example:_{.json-schema-reset .json-schema-example} `false` {.table-cell} || || _skip_door_to_door_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [SkipDoorToDoor](#entity-SkipDoorToDoor) Disable door-to-door delivery (disable the "Door-to-door" option). Possible values: - true (the courier will deliver the order only at the entrance outside) - false (the courier will deliver the order to the door) - default value _Default:_{.json-schema-reset .json-schema-value} `false` _Example:_{.json-schema-reset .json-schema-example} `false` {.table-cell} || || _skip_emergency_notify_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [SkipEmergencyNotify](#entity-SkipEmergencyNotify) Don't send a notification to the emergency contact person Default value: false (send notifications) _Default:_{.json-schema-reset .json-schema-value} `false` _Example:_{.json-schema-reset .json-schema-example} `false` {.table-cell} || || _warnings_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ClaimWarning](#entity-ClaimWarning)[] Warnings during claim processing {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "source": "client_requirements", "code": "not_fit_in_car", "message": "warning" } ] ``` {% endcut %} {.table-cell} || |#{.json-schema-properties}
### ClaimId {#entity-ClaimId} Claim ID obtained at the claim creation stage **Type**: string _Min length:_{.json-schema-reset .json-schema-assertion} `32` _Max length:_{.json-schema-reset .json-schema-assertion} `64` _Example:_{.json-schema-reset .json-schema-example} `741cedf82cd464fa6fa16d87155c636`
### CorpClientId {#entity-CorpClientId} Yandex Delivery corporate client ID (from the OAuth token) **Type**: string _Min length:_{.json-schema-reset .json-schema-assertion} `32` _Max length:_{.json-schema-reset .json-schema-assertion} `32` _Example:_{.json-schema-reset .json-schema-example} `cd8cc018bde34597932855e3cfdce927`
### PointVisitStatus {#entity-PointVisitStatus} Point visit status: - pending — not yet visited. - arrived — the courier arrived at the point. - visited — the courier handed over/picked up the cargo at the point. - skipped — skipped (if the item wasn't accepted). **Type**: string _Enum:_{.json-schema-reset .json-schema-value} `pending`, `arrived`, `visited`, `skipped`
### PaymentId {#entity-PaymentId} Payment ID **Type**: string<uuid> _Example:_{.json-schema-reset .json-schema-example} `123e4567-e89b-12d3-a456-426614174000`
### ClientOrderId {#entity-ClientOrderId} customer order's external ID **Type**: string _Example:_{.json-schema-reset .json-schema-example} `100`
### PaymentComplete {#entity-PaymentComplete} Order payment indication **Type**: boolean
### CustomerFiscalization {#entity-CustomerFiscalization} Information about the customer (recipient) #| || **Name** | **Description** || || _email_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string User's email address. If not specified, the recipient's email address from the destination point will be used _Example:_{.json-schema-reset .json-schema-example} `example@yandex.ru` {.table-cell} || || _full_name_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string For legal entities — organization name, for individual entrepreneurs and individuals — full name _Example:_{.json-schema-reset .json-schema-example} `Morty` {.table-cell} || || _inn_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [Inn](#entity-Inn) User's ITN (10 or 12 digits) _Pattern:_{.json-schema-reset .json-schema-assertion} `^(\d{10}|\d{12})$` _Example:_{.json-schema-reset .json-schema-example} `3664069397` {.table-cell} || || _phone_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string User's phone number in +X XXX XXX XX XX format. If not specified, the recipient's phone number from the destination point will be used _Example:_{.json-schema-reset .json-schema-example} `+79123456789` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "full_name": "Morty", "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" } ``` {% endcut %}
### InvoiceLink {#entity-InvoiceLink} Invoice link **Type**: string _Example:_{.json-schema-reset .json-schema-example} `https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024`
### ResponsePaymentOnDelivery {#entity-ResponsePaymentOnDelivery} Parameters of payment upon receipt #| || **Name** | **Description** || || _is_paid_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [PaymentComplete](#entity-PaymentComplete) Order payment indication _Example:_{.json-schema-reset .json-schema-example} `false` {.table-cell} || || _client_order_id_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ClientOrderId](#entity-ClientOrderId) customer order's external ID _Example:_{.json-schema-reset .json-schema-example} `100` {.table-cell} || || _customer_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [CustomerFiscalization](#entity-CustomerFiscalization) Information about the customer (recipient) {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "full_name": "Morty", "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" } ``` {% endcut %} {.table-cell} || || _invoice_link_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [InvoiceLink](#entity-InvoiceLink) Invoice link _Example:_{.json-schema-reset .json-schema-example} `https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024` {.table-cell} || || _payment_method_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [PaymentMethod](#entity-PaymentMethod) Selected payment method. card — payment by card. cash — cash payment (not yet available). _Enum:_{.json-schema-reset .json-schema-value} `card`, `cash` {.table-cell} || || _payment_ref_id_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [PaymentId](#entity-PaymentId) Payment ID _Example:_{.json-schema-reset .json-schema-example} `123e4567-e89b-12d3-a456-426614174000` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "payment_ref_id": "123e4567-e89b-12d3-a456-426614174000", "client_order_id": "100", "is_paid": false, "customer": { "full_name": "Morty", "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" }, "payment_method": "card", "invoice_link": "https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024" } ``` {% endcut %}
### ExpectedVisitInterval {#entity-ExpectedVisitInterval} Time interval of the courier's visit to the point according to the selected offer #| || **Name** | **Description** || || _from_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string<date-time> Interval start _Example:_{.json-schema-reset .json-schema-example} `2020-01-01T00:00:00+00:00` {.table-cell} || || _to_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string<date-time> Interval end _Example:_{.json-schema-reset .json-schema-example} `2020-01-02T00:00:00+00:00` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "from": "2020-01-01T00:00:00+00:00", "to": "2020-01-02T00:00:00+00:00" } ``` {% endcut %}
### PointVisitTime {#entity-PointVisitTime} Information about the point visit time #| || **Name** | **Description** || || _actual_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string<date-time> Actual point visit time. Filled in only for visited points. _Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z` {.table-cell} || || _expected_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string<date-time> Estimated time of arrival. Can be filled in only for unvisited points. _Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z` {.table-cell} || || _expected_waiting_time_sec_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: integer Estimated waiting time at the point. (int64) {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "expected": "2025-01-01T00:00:00Z", "expected_waiting_time_sec": 0, "actual": "2025-01-01T00:00:00Z" } ``` {% endcut %}
### V2ResponseCargoPoint {#entity-V2ResponseCargoPoint} Route point information #| || **Name** | **Description** || || _address_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [CargoPointAddress](#entity-CargoPointAddress) Point address {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" } ``` {% endcut %} {.table-cell} || || _contact_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [ContactOnPoint](#entity-ContactOnPoint) Information about the contact person {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" } ``` {% endcut %} {.table-cell} || || _id_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: integer Integer point ID (int64) {.table-cell} || || _type_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [PointType](#entity-PointType) Point type: - source: the point of departure where the courier picks up the item - destination: destination points where the courier delivers the items - return: item return point (added automatically and matches the point of departure by default, but a different point can also be selected) _Enum:_{.json-schema-reset .json-schema-value} `source`, `destination`, `return` {.table-cell} || || _visit_order_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: integer The order in which the points are visited (numbering starts with 1) (int64) {.table-cell} || || _visit_status_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [PointVisitStatus](#entity-PointVisitStatus) Point visit status: - pending — not yet visited. - arrived — the courier arrived at the point. - visited — the courier handed over/picked up the cargo at the point. - skipped — skipped (if the item wasn't accepted). _Enum:_{.json-schema-reset .json-schema-value} `pending`, `arrived`, `visited`, `skipped` {.table-cell} || || _visited_at_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [PointVisitTime](#entity-PointVisitTime) Information about the point visit time {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "expected": "2025-01-01T00:00:00Z", "expected_waiting_time_sec": 0, "actual": "2025-01-01T00:00:00Z" } ``` {% endcut %} {.table-cell} || || _expected_visit_interval_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ExpectedVisitInterval](#entity-ExpectedVisitInterval) Time interval of the courier's visit to the point according to the selected offer {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "from": "2020-01-01T00:00:00+00:00", "to": "2020-01-02T00:00:00+00:00" } ``` {% endcut %} {.table-cell} || || _external_order_cost_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ExternalOrderCost](#entity-ExternalOrderCost) Cost of the external order linked to the point {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "value": "100.0", "currency": "RUB", "currency_sign": "₽" } ``` {% endcut %} {.table-cell} || || _external_order_id_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Order number from the customer's system. Entered for destination points _Example:_{.json-schema-reset .json-schema-example} `100` {.table-cell} || || _leave_under_door_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: boolean Leave the parcel at the door {.table-cell} || || _meet_outside_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: boolean The courier will be met outside, at the entrance {.table-cell} || || _no_door_call_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: boolean Don't ring the doorbell {.table-cell} || || _payment_on_delivery_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [ResponsePaymentOnDelivery](#entity-ResponsePaymentOnDelivery) Parameters of payment upon receipt {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "payment_ref_id": "123e4567-e89b-12d3-a456-426614174000", "client_order_id": "100", "is_paid": false, "customer": { "full_name": "Morty", "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" }, "payment_method": "card", "invoice_link": "https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024" } ``` {% endcut %} {.table-cell} || || _pickup_code_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [PickupCode](#entity-PickupCode) Parcel pick-up code. The courier needs to enter this code to confirm that they have picked up the parcel. This requires your employees to be at the point of dispatch to provide this code to the courier. Relevant for source points. Code format: 6 digits | Item pick-up code (pick-up point) _Min length:_{.json-schema-reset .json-schema-assertion} `6` _Max length:_{.json-schema-reset .json-schema-assertion} `6` _Pattern:_{.json-schema-reset .json-schema-assertion} `\d{6}` _Example:_{.json-schema-reset .json-schema-example} `893422` {.table-cell} || || _return_comment_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Comments on the reasons for returning the cargo _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || || _return_reasons_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string[] Reasons for returning the cargo {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ "example" ] ``` {% endcut %} {.table-cell} || || _skip_confirmation_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [CargoPointSkipConfirmation](#entity-CargoPointSkipConfirmation) Skip SMS confirmation at the given point Default value: false (confirmation required). _Default:_{.json-schema-reset .json-schema-value} `false` _Example:_{.json-schema-reset .json-schema-example} `false` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "id": 1, "contact": { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "Morty", "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" }, "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" } } ``` {% endcut %}
### V2ResponseCargoRoutePoints {#entity-V2ResponseCargoRoutePoints} Route point information **Type**: [V2ResponseCargoPoint](#entity-V2ResponseCargoPoint)[] _Min items:_{.json-schema-reset .json-schema-assertion} `2` {% cut "**Example**" %}{.json-schema-example} ```json translate=no [ { "id": 1, "contact": { "name": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "Morty", "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" }, "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": "Rick", "phone": "+79123456789", "phone_additional_code": "602 17 500", "email": "example@yandex.ru" }, "address": { "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A", "shortname": "Bol'shaya Monetnaya Street, 1f1A", "coordinates": [ 0.5, 0.5 ], "country": "Russia", "city": "Saint Petersburg", "building_name": "BC of Bol'shaya Monetnaya", "street": "Bol'shaya Monetnaya street", "building": "23f1A", "porch": "A", "sfloor": "1", "sflat": "1", "door_code": "169", "door_code_extra": "courtyard entrance code #1234, apartment code #4321", "doorbell_name": "Magidovich", "comment": "The intercom doesn't work", "uri": "ymapsbm1://geo?ll=38.805%2C55.084", "description": "Saint Petersburg, Russia" }, "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": "Morty", "inn": "3664069397", "email": "example@yandex.ru", "phone": "+79123456789" }, "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" } } ] ``` {% endcut %}
### ClaimPointId {#entity-ClaimPointId} Integer point ID (int64) generated on the Yandex Delivery side. It is in the route_points[].id field. Applicable to source, destination, and return points. **Type**: integer
### ClaimStatus {#entity-ClaimStatus} Claim status. To learn more, see [Status model](https://yandex.com/support/delivery-profile/en/api/express/claim-process.md) **Type**: string _Enum:_{.json-schema-reset .json-schema-value} `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 {#entity-HumanErrorMessage} Error code and description #| || **Name** | **Description** || || _code_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Error code _Example:_{.json-schema-reset .json-schema-example} `some_error` {.table-cell} || || _message_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Error description _Example:_{.json-schema-reset .json-schema-example} `Some error` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "code": "some_error", "message": "Some error" } ``` {% endcut %}
### Eta {#entity-Eta} Estimated order fulfillment time in minutes (int64) **Type**: integer
### TaxiOfferId {#entity-TaxiOfferId} Offer ID **Type**: string _Example:_{.json-schema-reset .json-schema-example} `28ae5f1d72364468be3f5e26cd6a66bf`
### TaxiOffer {#entity-TaxiOffer} Offer from Yandex Delivery (valid for some time). #| || **Name** | **Description** || || _offer_id_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [TaxiOfferId](#entity-TaxiOfferId) Offer ID _Example:_{.json-schema-reset .json-schema-example} `28ae5f1d72364468be3f5e26cd6a66bf` {.table-cell} || || _price_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [Money](#entity-Money) Offer price without VAT Delivery cost in Decimal(18, 4) format _Pattern:_{.json-schema-reset .json-schema-assertion} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$` _Example:_{.json-schema-reset .json-schema-example} `12.50` {.table-cell} || || _price_with_vat_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [Money](#entity-Money) Delivery cost in Decimal(18, 4) format _Pattern:_{.json-schema-reset .json-schema-assertion} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$` _Example:_{.json-schema-reset .json-schema-example} `12.50` {.table-cell} || || _valid_until_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string<date-time> Time until which the offer to accept the claim is valid. If there is no value, there are no limits on the offer duration _Example:_{.json-schema-reset .json-schema-example} `2020-01-01T00:00:00+00:00` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "offer_id": "28ae5f1d72364468be3f5e26cd6a66bf", "price": "12.50", "valid_until": "2020-01-01T00:00:00+00:00", "price_with_vat": null } ``` {% endcut %}
### CurrencyRules {#entity-CurrencyRules} Currency display rules #| || **Name** | **Description** || || _code_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [Currency](#entity-Currency) Three-digit code of the payment currency _Min length:_{.json-schema-reset .json-schema-assertion} `3` _Max length:_{.json-schema-reset .json-schema-assertion} `3` _Example:_{.json-schema-reset .json-schema-example} `RUB` {.table-cell} || || _template_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Currency display template _Example:_{.json-schema-reset .json-schema-example} `$VALUE$ $SIGN$$CURRENCY$` {.table-cell} || || _text_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Short currency name _Example:_{.json-schema-reset .json-schema-example} `rub.` {.table-cell} || || _sign_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Currency symbol _Example:_{.json-schema-reset .json-schema-example} `₽` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "code": "RUB", "text": "rub.", "template": "$VALUE$ $SIGN$$CURRENCY$", "sign": "₽" } ``` {% endcut %}
### ClaimPricing {#entity-ClaimPricing} Information about the order cost #| || **Name** | **Description** || || _currency_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Three-digit code of the payment currency _Example:_{.json-schema-reset .json-schema-example} `RUB` {.table-cell} || || _currency_rules_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [CurrencyRules](#entity-CurrencyRules) Currency display rules {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "code": "RUB", "text": "rub.", "template": "$VALUE$ $SIGN$$CURRENCY$", "sign": "₽" } ``` {% endcut %} {.table-cell} || || _final_price_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [Money](#entity-Money) Final delivery price, including VAT. Filled in after the delivery/return is completed. Delivery cost in Decimal(18, 4) format _Pattern:_{.json-schema-reset .json-schema-assertion} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$` _Example:_{.json-schema-reset .json-schema-example} `12.50` {.table-cell} || || _final_pricing_calc_id_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Cost calculation ID _Example:_{.json-schema-reset .json-schema-example} `example` {.table-cell} || || _offer_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: [TaxiOffer](#entity-TaxiOffer) Offer from Yandex Delivery (valid for some time). {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "offer_id": "28ae5f1d72364468be3f5e26cd6a66bf", "price": "12.50", "valid_until": "2020-01-01T00:00:00+00:00", "price_with_vat": null } ``` {% endcut %} {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "offer": { "offer_id": "28ae5f1d72364468be3f5e26cd6a66bf", "price": "12.50", "valid_until": "2020-01-01T00:00:00+00:00", "price_with_vat": null }, "currency": "RUB", "currency_rules": { "code": "RUB", "text": "rub.", "template": "$VALUE$ $SIGN$$CURRENCY$", "sign": "₽" }, "final_pricing_calc_id": "example", "final_price": null } ``` {% endcut %}
### MatchedCar {#entity-MatchedCar} #| || **Name** | **Description** || || _taxi_class_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Delivery rate. Possible values: courier, express, cargo _Example:_{.json-schema-reset .json-schema-example} `express` {.table-cell} || || _cargo_loaders_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: integer Required number of loaders (int64) _Min value:_{.json-schema-reset .json-schema-assertion} `0` {.table-cell} || || _cargo_type_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Body type _Example:_{.json-schema-reset .json-schema-example} `lcv_m` {.table-cell} || || _cargo_type_int_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: integer Body type (int64) {.table-cell} || || _client_taxi_class_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Customer rate _Example:_{.json-schema-reset .json-schema-example} `cargo` {.table-cell} || || _door_to_door_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: boolean The "door-to-door" option for the "Express" rate {.table-cell} || || _pro_courier_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: boolean Enable the "Pro" option for "Express" and "Courier" rates. In this case, we will look only for experienced couriers. {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "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 } ``` {% endcut %}
### ClaimWarningSourceApi {#entity-ClaimWarningSourceApi} Warning source: - client_requirements — the warning is related to customer requirements. - route_points — the warning is related to the transmitted addresses. **Type**: string _Example:_{.json-schema-reset .json-schema-example} `client_requirements`
### ClaimWarningCodeApi {#entity-ClaimWarningCodeApi} Warning type: - not_fit_in_car: the cargo may not fit in the vehicle. - requirement_unavailable: the specified requirement isn't available and has been ignored. - address_not_found - the specified address wasn't found in Yandex Maps. - address_too_far: the coordinates from Yandex Maps the specified address are far from the transmitted coordinates. **Type**: string _Example:_{.json-schema-reset .json-schema-example} `not_fit_in_car`
### ClaimWarning {#entity-ClaimWarning} #| || **Name** | **Description** || || _code_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [ClaimWarningCodeApi](#entity-ClaimWarningCodeApi) Warning type: - not_fit_in_car: the cargo may not fit in the vehicle. - requirement_unavailable: the specified requirement isn't available and has been ignored. - address_not_found - the specified address wasn't found in Yandex Maps. - address_too_far: the coordinates from Yandex Maps the specified address are far from the transmitted coordinates. _Example:_{.json-schema-reset .json-schema-example} `not_fit_in_car` {.table-cell} || || _source_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: [ClaimWarningSourceApi](#entity-ClaimWarningSourceApi) Warning source: - client_requirements — the warning is related to customer requirements. - route_points — the warning is related to the transmitted addresses. _Example:_{.json-schema-reset .json-schema-example} `client_requirements` {.table-cell} || || _message_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Warning description _Example:_{.json-schema-reset .json-schema-example} `warning` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "source": "client_requirements", "code": "not_fit_in_car", "message": "warning" } ``` {% endcut %}
### PerformerInfo {#entity-PerformerInfo} Information about the courier #| || **Name** | **Description** || || _courier_name_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Name of the courier who is delivering a parcel _Example:_{.json-schema-reset .json-schema-example} `Person` {.table-cell} || || _legal_name_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Data on the legal entity that performs the delivery _Example:_{.json-schema-reset .json-schema-example} `Sole Trader Birdperson` {.table-cell} || || _car_color_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Vehicle color _Example:_{.json-schema-reset .json-schema-example} `red` {.table-cell} || || _car_color_hex_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string RGB code of the vehicle color _Example:_{.json-schema-reset .json-schema-example} `FF00000` {.table-cell} || || _car_model_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Vehicle model _Example:_{.json-schema-reset .json-schema-example} `Hyundai Solaris` {.table-cell} || || _car_number_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string License plate number of the vehicle _Example:_{.json-schema-reset .json-schema-example} `Y100BJF` {.table-cell} || || _transport_type_{.json-schema-reset .json-schema-property} {.table-cell}| **Type**: string Type of courier transport _Example:_{.json-schema-reset .json-schema-example} `car` {.table-cell} || |#{.json-schema-properties} {% cut "**Example**" %}{.json-schema-example} ```json translate=no { "courier_name": "Person", "legal_name": "Sole Trader Birdperson", "car_model": "Hyundai Solaris", "car_number": "Y100BJF", "car_color": "red", "car_color_hex": "FF00000", "transport_type": "car" } ``` {% endcut %}
## 400 Bad Request Invalid request
### Body {% cut "application/json" %} ```json translate=no { "code": "bad_request", "message": "Incorrect request body" } ``` {% endcut %} #| || **Name** | **Description** || || _code_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Error code _Enum:_{.json-schema-reset .json-schema-value} `validation_error`, `sdd_items_without_parameters_forbidden`, `items_without_parameters_forbidden`, `sdd_multipoints_not_supported`, `address_too_far`, `address_not_found`, `bad_request`, `invalid_post_payment`, `sdd_client_requirements_forbidden`, `invalid_delivery_interval`, `wrong_pickup_code_format`, `wrong_pickup_code_usage`, `unknown_zone`, `invalid_time_intervals`, `unsupported_points_count`, `invalid_phone_incorrect_symbol`, `invalid_phone_must_start_plus_symbol`, `country_phone_code_not_supported`, `invalid_phone_size_incorrect`, `item_destination_point_not_found`, `invalid_destination_point`, `due_in_past`, `delay_too_long`, `external_order_id_not_allowed`, `address_outside_delivery_zone`, `invalid_buyout_point_type`, `payment_on_delivery_missed`, `payment_on_delivery_invalid_request`, `max_order_cost_exceeded`, `invalid_post_payment_payment_method`, `invalid_buyout_payment_method`, `invalid_source_point`, `invalid_point_phone`, `invalid_item_destination_point`, `invalid_item_source_point`, `different_cost_currencies` {.table-cell} || || _message_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The person understood the error message _Example:_{.json-schema-reset .json-schema-example} `Incorrect request body` {.table-cell} || |#{.json-schema-properties}
## 403 Forbidden Identification error or payment on receipt isn't available
### Body {% cut "application/json" %} ```json translate=no { "code": "payment_on_delivery_disabled", "message": "Incorrect request body" } ``` {% endcut %} #| || **Name** | **Description** || || _code_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Error code _Enum:_{.json-schema-reset .json-schema-value} `buyout_disabled`, `payment_on_delivery_disabled`, `forbidden_by_antifake` {.table-cell} || || _message_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string The person understood the error message _Example:_{.json-schema-reset .json-schema-example} `Incorrect request body` {.table-cell} || |#{.json-schema-properties}
## 429 Too Many Requests Too many claims created in a period of time
### Body {% cut "application/json" %} ```json translate=no { "code": "too_many_requests", "message": "Too many requests" } ``` {% endcut %} #| || **Name** | **Description** || || _code_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Error code _Const:_{.json-schema-reset .json-schema-value} `too_many_requests` _Example:_{.json-schema-reset .json-schema-example} `too_many_requests` {.table-cell} || || _message_{.json-schema-reset .json-schema-property .json-schema-required} {.table-cell}| **Type**: string Error description _Example:_{.json-schema-reset .json-schema-example} `Too many requests` {.table-cell} || |#{.json-schema-properties}
[*Deprecated]: No longer supported, please use an alternative and newer version.