--- metadata: - name: generator content: Diplodoc Platform v5.15.5 alternate: - https://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2ClaimsInfo.md --- > **Documentation Index:** Fetch the complete configuration index at https://delivery.yango.com/docs/en/llms.txt
# Get claim information The method returns basic information about the claim: status, price, free cancellation option, and other information. For claims with the "Same-day delivery" service, a response with the "same_day_data" is returned. ## Request
POST {.openapi__method} ```text translate=no b2b.delivery.yango.tech/b2b/cargo/integration/v2/claims/info ```
Service URL
### Query parameters #||| **Name** | **Description** || || claim_id* {.openapi-table-parameter-name} | **Type:** string Claim ID received at the claim creation stage
*Min length:*{.openapi-description-annotation} `32` *Max length:*{.openapi-description-annotation} `64` |||#{.openapi-table} ### Headers #||| **Name** | **Description** || || Accept-Language* {.openapi-table-parameter-name} | **Type:** string Preferred response language. Examples: "en" — English
Example: `en` |||#{.openapi-table} ## Responses
## 200 OK Claim information
### Body {% cut "application/json" %} ```text 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": "AED", "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": "Bryan Burns", "phone": "+97142774444", "phone_additional_code": "602 17 500", "email": "customer-BryanBurns@yango.com" }, "address": { "fullname": "One Central Building 5, Trade Center Second, Dubai", "shortname": "One Central Building 5, Trade Center Second", "coordinates": [ 0 ], "country": "UAE", "city": "Dubai", "building_name": "Dubai", "street": "Trade Center Second", "building": "building number", "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": "Yango Dubai Office, One Central Building 5, Trade Center Second, Dubai" }, "type": "source", "visit_order": 1, "visit_status": "pending", "skip_confirmation": false, "leave_under_door": false, "meet_outside": false, "no_door_call": false, "payment_on_delivery": { "payment_ref_id": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b", "client_order_id": "100", "is_paid": false, "customer": { "full_name": "Morty", "inn": 3664069397, "email": "customer-BryanBurns@yango.com", "phone": "+97142774444" }, "payment_method": "card", "invoice_link": "url" }, "external_order_id": "100", "external_order_cost": { "value": "100.0", "currency": "AED", "currency_sign": "currency sign (if exists)" }, "expected_visit_interval": { "from": "2020-01-01T00:00:00+00:00", "to": "2020-01-02T00:00:00+00:00" }, "pickup_code": "893422", "return_reasons": [ "string" ], "return_comment": "string", "visited_at": { "expected": "2022-12-29T18:02:01Z", "expected_waiting_time_sec": 0, "actual": "2022-12-29T18:02:01Z" } } ], "current_point_id": 372036854775807, "status": "new", "version": 0, "user_request_revision": "string", "error_messages": [ { "code": "some_error", "message": "Some error" } ], "emergency_contact": { "name": "Rick", "phone": "+97142772222", "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": "12.50", "valid_until": "2020-01-01T00:00:00+00:00", "price_with_vat": "12.50" }, "currency": "AED", "currency_rules": { "code": "AED", "text": "AED", "template": "$VALUE$ $SIGN$$CURRENCY$", "sign": "₽" }, "final_pricing_calc_id": "string", "final_price": "12.50" }, "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": "Mark Smith", "legal_name": "Individual entrepreneur Mark Smith", "car_model": "Hyundai Solaris", "car_number": "71673", "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": "string", "comment": "Restaurant", "revision": 1, "route_id": "string", "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* {.openapi-table-parameter-name} | **Type:** string<date-time> Date and time of claim creation *Example:*{.openapi-description-annotation} `2020-01-01T00:00:00+00:00` || || id* {.openapi-table-parameter-name} | **Type:** string Claim ID obtained at the claim creation stage *Example:*{.openapi-description-annotation} `741cedf82cd464fa6fa16d87155c636` *Min length:*{.openapi-description-annotation} `32` *Max length:*{.openapi-description-annotation} `64` || || items* {.openapi-table-parameter-name} | **Type:** [V2CargoItem](#v2cargoitem)[] Item parameters
*Min items:*{.openapi-description-annotation} `1` || || revision* {.openapi-table-parameter-name} | **Type:** integer<int64> Revision (int64) *Example:*{.openapi-description-annotation} `1` || || route_points* {.openapi-table-parameter-name} | **Type:** [V2ResponseCargoPoint](#v2responsecargopoint)[] Route point information
Route point information *Min items:*{.openapi-description-annotation} `2` || || status* {.openapi-table-parameter-name} | **Type:** [ClaimStatus](#claimstatus) Claim status. To learn more, see [Status model](https://delivery.yango.com/docs/en/api/express/claim-process.md) *Example:*{.openapi-description-annotation} `new` *Enum:*{.openapi-description-annotation} `new`, `estimating`, `estimating_failed`, `ready_for_approval`, `accepted`, `performer_lookup`, `performer_draft`, `performer_found`, `performer_not_found`, `pickup_arrived`, `ready_for_pickup_confirmation`, `pickuped`, `delivery_arrived`, `ready_for_delivery_confirmation`, `delivered`, `delivered_finish`, `returning`, `return_arrived`, `ready_for_return_confirmation`, `returned`, `returned_finish`, `failed`, `cancelled`, `cancelled_with_payment`, `cancelled_by_taxi`, `cancelled_with_items_on_hands` || || updated_ts* {.openapi-table-parameter-name} | **Type:** string<date-time> Date and time of the last claim update *Example:*{.openapi-description-annotation} `2020-01-01T00:00:00+00:00` || || user_request_revision* {.openapi-table-parameter-name} | **Type:** string The current version of changes in the claim entered by the user || || version* {.openapi-table-parameter-name} | **Type:** integer<int64> Version (int64) || || callback_properties {.openapi-table-parameter-name} | **Type:** [CallbackProperties](#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://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2ClaimsInfo.md). The client should note that the response of the [claims/info](https://delivery.yango.com/docs/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). || || client_requirements {.openapi-table-parameter-name} | **Type:** [ClientRequirements](#clientrequirements) Customer requirements specified when creating or editing a claim || || comment {.openapi-table-parameter-name} | **Type:** string General comment to the order *Example:*{.openapi-description-annotation} `Restaurant` *Max length:*{.openapi-description-annotation} `7000` || || corp_client_id {.openapi-table-parameter-name} | **Type:** string Yango Delivery corporate client ID (from the OAuth token) *Example:*{.openapi-description-annotation} `cd8cc018bde34597932855e3cfdce927` *Min length:*{.openapi-description-annotation} `32` *Max length:*{.openapi-description-annotation} `32` || || current_point_id {.openapi-table-parameter-name} | **Type:** integer<int64> Integer point ID (int64) generated on the Yango Delivery side. It is in the route_points[].id field. Applicable to source, destination, and return points. *Example:*{.openapi-description-annotation} `372036854775807` || || due {.openapi-table-parameter-name} | **Type:** string<date-time> Estimated time of arrival of the courier. If this parameter isn''t specified, we will look for a courier as soon as possible. *Example:*{.openapi-description-annotation} `2020-01-01T00:00:00+00:00` || || emergency_contact {.openapi-table-parameter-name} | **Type:** [ContactWithPhone](#contactwithphone) Information about the contact person with a phone number || || error_messages {.openapi-table-parameter-name} | **Type:** [HumanErrorMessage](#humanerrormessage)[] List of error messages
Error code and description || || eta {.openapi-table-parameter-name} | **Type:** integer<int64> Estimated order fulfillment time in minutes (int64) *Example:*{.openapi-description-annotation} `10` || || matched_cars {.openapi-table-parameter-name} | **Type:** [MatchedCar](#matchedcar)[] Information about the selected rate
|| || optional_return {.openapi-table-parameter-name} | **Type:** boolean 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:*{.openapi-description-annotation} `false` *Example:*{.openapi-description-annotation} `false` || || performer_info {.openapi-table-parameter-name} | **Type:** [PerformerInfo](#performerinfo) Information about the executor || || pricing {.openapi-table-parameter-name} | **Type:** [ClaimPricing](#claimpricing) Information about the order cost || || route_id {.openapi-table-parameter-name} | **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") || || same_day_data {.openapi-table-parameter-name} | **Type:** [SameDayData](#samedaydata) Additional information for `Same-day delivery` claims. || || shipping_document {.openapi-table-parameter-name} | **Type:** string Shipping documents || || skip_act {.openapi-table-parameter-name} | **Type:** boolean Don't show an acceptance certificate *Example:*{.openapi-description-annotation} `false` || || skip_client_notify {.openapi-table-parameter-name} | **Type:** boolean Don't send SMS notifications to the sender/recipient when a courier is on their way. Default value: false (send notifications) *Default:*{.openapi-description-annotation} `false` *Example:*{.openapi-description-annotation} `false` || || skip_door_to_door {.openapi-table-parameter-name} | **Type:** boolean 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:*{.openapi-description-annotation} `false` *Example:*{.openapi-description-annotation} `false` || || skip_emergency_notify {.openapi-table-parameter-name} | **Type:** boolean Don't send a notification to the emergency contact person Default value: false (send notifications) *Default:*{.openapi-description-annotation} `false` *Example:*{.openapi-description-annotation} `false` || || warnings {.openapi-table-parameter-name} | **Type:** [ClaimWarning](#claimwarning)[] Warnings during claim processing
|||#{.openapi-table}
### V2CargoItem #||| **Name** | **Description** || || cost_currency* {.openapi-table-parameter-name} | **Type:** string Three-digit code of the payment currency *Example:*{.openapi-description-annotation} `AED` *Min length:*{.openapi-description-annotation} `3` *Max length:*{.openapi-description-annotation} `3` || || cost_value* {.openapi-table-parameter-name} | **Type:** string Price per item in cost_currency. To insure the cost, enter the actual cargo price *Example:*{.openapi-description-annotation} `2.00` || || droppof_point* {.openapi-table-parameter-name} | **Type:** integer<int64> 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 *Example:*{.openapi-description-annotation} `2` || || pickup_point* {.openapi-table-parameter-name} | **Type:** integer<int64> 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 *Example:*{.openapi-description-annotation} `1` || || quantity* {.openapi-table-parameter-name} | **Type:** integer<int64> Number of units (int64) *Example:*{.openapi-description-annotation} `1` *Min value:*{.openapi-description-annotation} `1` || || title* {.openapi-table-parameter-name} | **Type:** string Item name *Example:*{.openapi-description-annotation} `Plumbus` || || extra_id {.openapi-table-parameter-name} | **Type:** string Short unique item ID (order number in the claim, usually identical to external_order_id) *Example:*{.openapi-description-annotation} `BP-208` *Max length:*{.openapi-description-annotation} `512` || || fiscalization {.openapi-table-parameter-name} | **Type:** [ItemFiscalization](#itemfiscalization) Fiscalization information (valid for payment upon receipt) || || size {.openapi-table-parameter-name} | **Type:** [CargoItemSizes](#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 || || weight {.openapi-table-parameter-name} | **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 *Example:*{.openapi-description-annotation} `2` |||#{.openapi-table}
### V2ResponseCargoPoint Route point information #||| **Name** | **Description** || || address* {.openapi-table-parameter-name} | **Type:** [CargoPointAddress](#cargopointaddress) Point address || || contact* {.openapi-table-parameter-name} | **Type:** [ContactOnPoint](#contactonpoint) Information about the contact person || || id* {.openapi-table-parameter-name} | **Type:** integer<int64> Integer point ID (int64) *Example:*{.openapi-description-annotation} `1` || || type* {.openapi-table-parameter-name} | **Type:** [PointType](#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) *Example:*{.openapi-description-annotation} `source` *Enum:*{.openapi-description-annotation} `source`, `destination`, `return` || || visit_order* {.openapi-table-parameter-name} | **Type:** integer<int64> The order in which the points are visited (numbering starts with 1) (int64) *Example:*{.openapi-description-annotation} `1` || || visit_status* {.openapi-table-parameter-name} | **Type:** [PointVisitStatus](#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). *Example:*{.openapi-description-annotation} `pending` *Enum:*{.openapi-description-annotation} `pending`, `arrived`, `visited`, `skipped` || || visited_at* {.openapi-table-parameter-name} | **Type:** [PointVisitTime](#pointvisittime) Information about the point visit time || || expected_visit_interval {.openapi-table-parameter-name} | **Type:** [ExpectedVisitInterval](#expectedvisitinterval) Time interval of the courier's visit to the point according to the selected offer || || external_order_cost {.openapi-table-parameter-name} | **Type:** [ExternalOrderCost](#externalordercost) Cost of the external order linked to the point || || external_order_id {.openapi-table-parameter-name} | **Type:** string Order number from the customer's system. Entered for destination points *Example:*{.openapi-description-annotation} `100` || || leave_under_door {.openapi-table-parameter-name} | **Type:** boolean Leave the parcel at the door || || meet_outside {.openapi-table-parameter-name} | **Type:** boolean The courier will be met outside, at the entrance || || no_door_call {.openapi-table-parameter-name} | **Type:** boolean Don't ring the doorbell || || payment_on_delivery {.openapi-table-parameter-name} | **Type:** [ResponsePaymentOnDelivery](#responsepaymentondelivery) Parameters of payment upon receipt || || pickup_code {.openapi-table-parameter-name} | **Type:** string 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) *Example:*{.openapi-description-annotation} `893422` *Min length:*{.openapi-description-annotation} `6` *Max length:*{.openapi-description-annotation} `6` *Pattern:*{.openapi-description-annotation} `\d{6}` || || return_comment {.openapi-table-parameter-name} | **Type:** string Comments on the reasons for returning the cargo || || return_reasons {.openapi-table-parameter-name} | **Type:** string[] Reasons for returning the cargo
|| || skip_confirmation {.openapi-table-parameter-name} | **Type:** boolean Skip SMS confirmation at the given point Default value: false (confirmation required). *Default:*{.openapi-description-annotation} `false` *Example:*{.openapi-description-annotation} `false` |||#{.openapi-table}
### ClaimStatus Claim status. To learn more, see [Status model](https://delivery.yango.com/docs/en/api/express/claim-process.md) #||| **Type** | **Description** || || [ClaimStatus](#claimstatus) | *Example:*{.openapi-description-annotation} `new` *Enum:*{.openapi-description-annotation} `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` |||#{.openapi-table}
### 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://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2ClaimsInfo.md). The client should note that the response of the [claims/info](https://delivery.yango.com/docs/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* {.openapi-table-parameter-name} | **Type:** string The URL used in the case of a status change for the claim. This mechanism is deprecated, use the [claims/journal](https://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2ClaimsJournal.md) operation instead. *Example:*{.openapi-description-annotation} `https://www.example.com/` *Pattern:*{.openapi-description-annotation} `^https?:.*` |||#{.openapi-table}
### ClientRequirements Customer requirements specified when creating or editing a claim #||| **Name** | **Description** || || taxi_class* {.openapi-table-parameter-name} | **Type:** string Delivery rate. Possible values: courier, express, cargo *Example:*{.openapi-description-annotation} `express` || || cargo_loaders {.openapi-table-parameter-name} | **Type:** integer<int64> 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://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2Tariffs.md). *Example:*{.openapi-description-annotation} `0` *Min value:*{.openapi-description-annotation} `0` || || cargo_options {.openapi-table-parameter-name} | **Type:** string[] 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://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2Tariffs.md)
*Example:*{.openapi-description-annotation} `thermobag` || || cargo_type {.openapi-table-parameter-name} | **Type:** [CargoType](#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://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2Tariffs.md) *Example:*{.openapi-description-annotation} `lcv_m` *Enum:*{.openapi-description-annotation} `van`, `lcv_m`, `lcv_l`, `lcv_xl` || || pro_courier {.openapi-table-parameter-name} | **Type:** boolean Enable the "Pro" option for "Express" and "Courier" rates. In this case, we will look only for experienced couriers. *Example:*{.openapi-description-annotation} `false` |||#{.openapi-table}
### ContactWithPhone Information about the contact person with a phone number #||| **Name** | **Description** || || name* {.openapi-table-parameter-name} | **Type:** string Name of the contact person *Example:*{.openapi-description-annotation} `Rick` || || phone* {.openapi-table-parameter-name} | **Type:** string Phone number of the contact person *Example:*{.openapi-description-annotation} `+97142772222` *Max length:*{.openapi-description-annotation} `30` *Pattern:*{.openapi-description-annotation} `[0-9 \\(\\)\\-\\+]+` || || phone_additional_code {.openapi-table-parameter-name} | **Type:** string Extension number to call the courier *Example:*{.openapi-description-annotation} `602 17 500` |||#{.openapi-table}
### HumanErrorMessage Error code and description #||| **Name** | **Description** || || code* {.openapi-table-parameter-name} | **Type:** string Error code *Example:*{.openapi-description-annotation} `some_error` || || message* {.openapi-table-parameter-name} | **Type:** string Error description *Example:*{.openapi-description-annotation} `Some error` |||#{.openapi-table}
### MatchedCar #||| **Name** | **Description** || || taxi_class* {.openapi-table-parameter-name} | **Type:** string Delivery rate. Possible values: courier, express, cargo *Example:*{.openapi-description-annotation} `express` || || cargo_loaders {.openapi-table-parameter-name} | **Type:** integer<int64> Required number of loaders (int64) *Example:*{.openapi-description-annotation} `0` *Min value:*{.openapi-description-annotation} `0` || || cargo_type {.openapi-table-parameter-name} | **Type:** string Body type *Example:*{.openapi-description-annotation} `lcv_m` || || cargo_type_int {.openapi-table-parameter-name} | **Type:** integer<int64> Body type (int64) *Example:*{.openapi-description-annotation} `2 is equal to "lcv_m"` || || client_taxi_class {.openapi-table-parameter-name} | **Type:** string Customer rate *Example:*{.openapi-description-annotation} `cargo` || || door_to_door {.openapi-table-parameter-name} | **Type:** boolean The "door-to-door" option for the "Express" rate *Example:*{.openapi-description-annotation} `false` || || pro_courier {.openapi-table-parameter-name} | **Type:** boolean Enable the "Pro" option for "Express" and "Courier" rates. In this case, we will look only for experienced couriers. *Example:*{.openapi-description-annotation} `false` |||#{.openapi-table}
### PerformerInfo Information about the courier #||| **Name** | **Description** || || courier_name* {.openapi-table-parameter-name} | **Type:** string Name of the courier who is delivering a parcel *Example:*{.openapi-description-annotation} `Mark Smith` || || legal_name* {.openapi-table-parameter-name} | **Type:** string Data on the legal entity that performs the delivery *Example:*{.openapi-description-annotation} `Individual entrepreneur Mark Smith` || || car_color {.openapi-table-parameter-name} | **Type:** string Vehicle color *Example:*{.openapi-description-annotation} `red` || || car_color_hex {.openapi-table-parameter-name} | **Type:** string RGB code of the vehicle color *Example:*{.openapi-description-annotation} `FF00000` || || car_model {.openapi-table-parameter-name} | **Type:** string Vehicle model *Example:*{.openapi-description-annotation} `Hyundai Solaris` || || car_number {.openapi-table-parameter-name} | **Type:** string License plate number of the vehicle *Example:*{.openapi-description-annotation} `71673` || || transport_type {.openapi-table-parameter-name} | **Type:** string Type of courier transport *Example:*{.openapi-description-annotation} `car` |||#{.openapi-table}
### ClaimPricing Information about the order cost #||| **Name** | **Description** || || currency {.openapi-table-parameter-name} | **Type:** string Three-digit code of the payment currency *Example:*{.openapi-description-annotation} `AED` || || currency_rules {.openapi-table-parameter-name} | **Type:** [CurrencyRules](#currencyrules) Currency display rules || || final_price {.openapi-table-parameter-name} | **Type:** string Delivery cost in Decimal(18, 4) format *Example:*{.openapi-description-annotation} `12.50` *Pattern:*{.openapi-description-annotation} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$` || || final_pricing_calc_id {.openapi-table-parameter-name} | **Type:** string Cost calculation ID || || offer {.openapi-table-parameter-name} | **Type:** [TaxiOffer](#taxioffer) Offer from Yango Delivery (valid for some time). |||#{.openapi-table}
### SameDayData Additional information for `Same-day delivery` claims. #||| **Name** | **Description** || || delivery_interval* {.openapi-table-parameter-name} | {% cut "**Type:** object" %}{.openapi-table-parameter-inline-type} #||| from* {.openapi-table-parameter-name} | **Type:** string<date-time> Interval start *Example:*{.openapi-description-annotation} `2020-01-01T07:00:00+00:00` || || to* {.openapi-table-parameter-name} | **Type:** string<date-time> Interval end (date and time) *Example:*{.openapi-description-annotation} `2020-01-01T07:00:00+00:00` |||#{.openapi-table} {% endcut %} Parcel pick-up and delivery interval |||#{.openapi-table}
### ClaimWarning #||| **Name** | **Description** || || code* {.openapi-table-parameter-name} | **Type:** string 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 maps. - address_too_far: the coordinates from maps the specified address are far from the transmitted coordinates. *Example:*{.openapi-description-annotation} `not_fit_in_car` || || source* {.openapi-table-parameter-name} | **Type:** string Warning source: - client_requirements — the warning is related to customer requirements. - route_points — the warning is related to the transmitted addresses. *Example:*{.openapi-description-annotation} `client_requirements` || || message {.openapi-table-parameter-name} | **Type:** string Warning description *Example:*{.openapi-description-annotation} `warning` |||#{.openapi-table}
### ItemFiscalization Fiscalization information (valid for payment upon receipt) #||| **Name** | **Description** || || article {.openapi-table-parameter-name} | **Type:** string Item SKU. Must be unique for items delivered from one point. *Example:*{.openapi-description-annotation} `20ML50OWKY4FC86` || || excise {.openapi-table-parameter-name} | **Type:** string Amount of excise tax *Example:*{.openapi-description-annotation} `12.50` *Pattern:*{.openapi-description-annotation} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$` || || item_type {.openapi-table-parameter-name} | **Type:** [ItemType](#itemtype) Name type: product or service. Default value: product *Enum:*{.openapi-description-annotation} `product`, `service` || || mark {.openapi-table-parameter-name} | **Type:** [ItemMark](#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 || || supplier_inn {.openapi-table-parameter-name} | **Type:** string Supplier's ITN (10 or 12 digits). Fill in the field for orders with buyout and CoD options. If there is no ITN, specify the default value: 1234567890 *Example:*{.openapi-description-annotation} `3664069397` *Pattern:*{.openapi-description-annotation} `^(\d{10}|\d{12})$` || || vat_code_str {.openapi-table-parameter-name} | **Type:** string VAT rate. Possible values: vat_none — without VAT. vat0 — 0% VAT (applied in rare cases). vat10 — 10% VAT. vat20 — 20% VAT. *Example:*{.openapi-description-annotation} `vat_none` |||#{.openapi-table}
### 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* {.openapi-table-parameter-name} | **Type:** number Height in meters *Example:*{.openapi-description-annotation} `0.3` || || length* {.openapi-table-parameter-name} | **Type:** number Length in meters *Example:*{.openapi-description-annotation} `0.1` || || width* {.openapi-table-parameter-name} | **Type:** number Width in meters *Example:*{.openapi-description-annotation} `0.2` |||#{.openapi-table}
### CargoPointAddress Point address #||| **Name** | **Description** || || fullname* {.openapi-table-parameter-name} | **Type:** string 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:*{.openapi-description-annotation} `One Central Building 5, Trade Center Second, Dubai` || || building {.openapi-table-parameter-name} | **Type:** string Building *Example:*{.openapi-description-annotation} `building number` || || building_name {.openapi-table-parameter-name} | **Type:** string Apartment building name *Example:*{.openapi-description-annotation} `Dubai` || || city {.openapi-table-parameter-name} | **Type:** string City *Example:*{.openapi-description-annotation} `Dubai` || || comment {.openapi-table-parameter-name} | **Type:** string Comment for the courier. For the dispatch point, use the template: "Delivery from store <>. Inform the manager that the order is for Yango 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". *Example:*{.openapi-description-annotation} `The intercom doesn't work` *Max length:*{.openapi-description-annotation} `7000` || || coordinates {.openapi-table-parameter-name} | **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:*{.openapi-description-annotation} `2` *Max items:*{.openapi-description-annotation} `2` || || country {.openapi-table-parameter-name} | **Type:** string Country *Example:*{.openapi-description-annotation} `UAE` || || description {.openapi-table-parameter-name} | **Type:** string A geographic area that turns a short address into a global match *Example:*{.openapi-description-annotation} `Yango Dubai Office, One Central Building 5, Trade Center Second, Dubai` || || door_code {.openapi-table-parameter-name} | **Type:** string Intercom code *Example:*{.openapi-description-annotation} `169` || || door_code_extra {.openapi-table-parameter-name} | **Type:** string Additional instructions for intercoms *Example:*{.openapi-description-annotation} `courtyard entrance code #1234, apartment code #4321` || || doorbell_name {.openapi-table-parameter-name} | **Type:** string Name on the doorbell *Example:*{.openapi-description-annotation} `Magidovich` || || porch {.openapi-table-parameter-name} | **Type:** string Entrance (may be A) *Example:*{.openapi-description-annotation} `A` || || sflat {.openapi-table-parameter-name} | **Type:** string Flat *Example:*{.openapi-description-annotation} `1` || || sfloor {.openapi-table-parameter-name} | **Type:** string Floor *Example:*{.openapi-description-annotation} `1` || || shortname {.openapi-table-parameter-name} | **Type:** string Short address within the city (like on a Taximeter) *Example:*{.openapi-description-annotation} `One Central Building 5, Trade Center Second` || || street {.openapi-table-parameter-name} | **Type:** string Street *Example:*{.openapi-description-annotation} `Trade Center Second` || || uri {.openapi-table-parameter-name} | **Type:** string URI of the geo object on maps *Example:*{.openapi-description-annotation} `ymapsbm1://geo?ll=38.805%2C55.084` |||#{.openapi-table}
### ContactOnPoint Information about the contact person #||| **Name** | **Description** || || name* {.openapi-table-parameter-name} | **Type:** string Name of the contact person *Example:*{.openapi-description-annotation} `Bryan Burns` || || phone* {.openapi-table-parameter-name} | **Type:** string Phone number of the contact person *Example:*{.openapi-description-annotation} `+97142774444` *Max length:*{.openapi-description-annotation} `30` *Pattern:*{.openapi-description-annotation} `[0-9 \\(\\)\\-\\+]+` || || email {.openapi-table-parameter-name} | **Type:** string Email is a mandatory parameter for source and return points *Example:*{.openapi-description-annotation} `customer-BryanBurns@yango.com` *Max length:*{.openapi-description-annotation} `320` *Pattern:*{.openapi-description-annotation} `\S+@\S+.\S+` || || phone_additional_code {.openapi-table-parameter-name} | **Type:** string Extension number to call the courier *Example:*{.openapi-description-annotation} `602 17 500` |||#{.openapi-table}
### 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** | **Description** || || [PointType](#pointtype) | *Example:*{.openapi-description-annotation} `source` *Enum:*{.openapi-description-annotation} `source`, `destination`, `return` |||#{.openapi-table}
### 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** | **Description** || || [PointVisitStatus](#pointvisitstatus) | *Example:*{.openapi-description-annotation} `pending` *Enum:*{.openapi-description-annotation} `pending`, `arrived`, `visited`, `skipped` |||#{.openapi-table}
### PointVisitTime Information about the point visit time #||| **Name** | **Description** || || actual {.openapi-table-parameter-name} | **Type:** string<date-time> Actual point visit time. Filled in only for visited points. || || expected {.openapi-table-parameter-name} | **Type:** string<date-time> Estimated time of arrival. Can be filled in only for unvisited points. || || expected_waiting_time_sec {.openapi-table-parameter-name} | **Type:** integer<int64> Estimated waiting time at the point. (int64) |||#{.openapi-table}
### ExpectedVisitInterval Time interval of the courier's visit to the point according to the selected offer #||| **Name** | **Description** || || from* {.openapi-table-parameter-name} | **Type:** string<date-time> Interval start *Example:*{.openapi-description-annotation} `2020-01-01T00:00:00+00:00` || || to* {.openapi-table-parameter-name} | **Type:** string<date-time> Interval end *Example:*{.openapi-description-annotation} `2020-01-02T00:00:00+00:00` |||#{.openapi-table}
### ExternalOrderCost Cost of the external order linked to the point #||| **Name** | **Description** || || currency* {.openapi-table-parameter-name} | **Type:** string Currency *Example:*{.openapi-description-annotation} `AED` || || currency_sign* {.openapi-table-parameter-name} | **Type:** string Currency symbol *Example:*{.openapi-description-annotation} `currency sign (if exists)` || || value* {.openapi-table-parameter-name} | **Type:** string Cost *Example:*{.openapi-description-annotation} `100.0` |||#{.openapi-table}
### ResponsePaymentOnDelivery Parameters of payment upon receipt #||| **Name** | **Description** || || is_paid* {.openapi-table-parameter-name} | **Type:** boolean Order payment indication *Example:*{.openapi-description-annotation} `false` || || client_order_id {.openapi-table-parameter-name} | **Type:** string customer order's external ID *Example:*{.openapi-description-annotation} `100` || || customer {.openapi-table-parameter-name} | **Type:** [CustomerFiscalization](#customerfiscalization) Information about the customer (recipient) || || invoice_link {.openapi-table-parameter-name} | **Type:** string Invoice link *Example:*{.openapi-description-annotation} `url` || || payment_method {.openapi-table-parameter-name} | **Type:** [PaymentMethod](#paymentmethod) Selected payment method. card — payment by card. cash — cash payment (not yet available). *Enum:*{.openapi-description-annotation} `card`, `cash` || || payment_ref_id {.openapi-table-parameter-name} | **Type:** string<uuid> Payment ID |||#{.openapi-table}
### 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://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2Tariffs.md) #||| **Type** | **Description** || || [CargoType](#cargotype) | *Example:*{.openapi-description-annotation} `lcv_m` *Enum:*{.openapi-description-annotation} `van`, `lcv_m`, `lcv_l`, `lcv_xl` |||#{.openapi-table}
### CurrencyRules Currency display rules #||| **Name** | **Description** || || code* {.openapi-table-parameter-name} | **Type:** string Three-digit code of the payment currency *Example:*{.openapi-description-annotation} `AED` *Min length:*{.openapi-description-annotation} `3` *Max length:*{.openapi-description-annotation} `3` || || template* {.openapi-table-parameter-name} | **Type:** string Currency display template *Example:*{.openapi-description-annotation} `$VALUE$ $SIGN$$CURRENCY$` || || text* {.openapi-table-parameter-name} | **Type:** string Short currency name *Example:*{.openapi-description-annotation} `AED` || || sign {.openapi-table-parameter-name} | **Type:** string Currency symbol *Example:*{.openapi-description-annotation} `₽` |||#{.openapi-table}
### TaxiOffer Offer from Yango Delivery (valid for some time). #||| **Name** | **Description** || || offer_id* {.openapi-table-parameter-name} | **Type:** string Offer ID *Example:*{.openapi-description-annotation} `28ae5f1d72364468be3f5e26cd6a66bf` || || price* {.openapi-table-parameter-name} | **Type:** string Offer price without VAT *Example:*{.openapi-description-annotation} `12.50` *Pattern:*{.openapi-description-annotation} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$` || || price_with_vat {.openapi-table-parameter-name} | **Type:** string Delivery cost in Decimal(18, 4) format *Example:*{.openapi-description-annotation} `12.50` *Pattern:*{.openapi-description-annotation} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$` || || valid_until {.openapi-table-parameter-name} | **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:*{.openapi-description-annotation} `2020-01-01T00:00:00+00:00` |||#{.openapi-table}
### ItemType Name type: product or service. Default value: product #||| **Type** | **Description** || || [ItemType](#itemtype) | *Enum:*{.openapi-description-annotation} `product`, `service` |||#{.openapi-table}
### 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* {.openapi-table-parameter-name} | **Type:** string Unit marking code in accordance with the format ''kind'' *Example:*{.openapi-description-annotation} `444D00000000003741` || || kind* {.openapi-table-parameter-name} | **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:*{.openapi-description-annotation} `gs1_data_matrix_base64` |||#{.openapi-table}
### CustomerFiscalization Information about the customer (recipient) #||| **Name** | **Description** || || email {.openapi-table-parameter-name} | **Type:** string User's email address. If not specified, the recipient's email address from the destination point will be used *Example:*{.openapi-description-annotation} `customer-BryanBurns@yango.com` || || full_name {.openapi-table-parameter-name} | **Type:** string For legal entities — organization name, for individual entrepreneurs and individuals — full name *Example:*{.openapi-description-annotation} `Morty` || || inn {.openapi-table-parameter-name} | **Type:** string User's ITN (10 or 12 digits) *Example:*{.openapi-description-annotation} `3664069397` *Pattern:*{.openapi-description-annotation} `^(\d{10}|\d{12})$` || || phone {.openapi-table-parameter-name} | **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:*{.openapi-description-annotation} `+97142774444` |||#{.openapi-table}
### PaymentMethod Selected payment method. card — payment by card. cash — cash payment (not yet available). #||| **Type** | **Description** || || [PaymentMethod](#paymentmethod) | *Enum:*{.openapi-description-annotation} `card`, `cash` |||#{.openapi-table}
## 400 Bad Request Bad request
### Body {% cut "application/json" %} ```json translate=no { "code": "bad_request", "message": "Incorrect request body" } ``` {% endcut %} #||| **Name** | **Description** || || code* {.openapi-table-parameter-name} | **Type:** string Error code *Example:*{.openapi-description-annotation} `bad_request` *Enum:*{.openapi-description-annotation} `bad_request` || || message* {.openapi-table-parameter-name} | **Type:** string Error description *Example:*{.openapi-description-annotation} `Incorrect request body` |||#{.openapi-table}
## 404 Not Found Claim not found
### Body {% cut "application/json" %} ```json translate=no { "code": "not_found", "message": "Claim not found" } ``` {% endcut %} #||| **Name** | **Description** || || code* {.openapi-table-parameter-name} | **Type:** string Error code *Example:*{.openapi-description-annotation} `not_found` *Enum:*{.openapi-description-annotation} `not_found` || || message* {.openapi-table-parameter-name} | **Type:** string Error description *Example:*{.openapi-description-annotation} `Claim not found` |||#{.openapi-table}
## 429 Too Many Requests Too many requests
### Body {% cut "application/json" %} ```json translate=no { "code": "too_many_requests", "message": "Too many requests" } ``` {% endcut %} #||| **Name** | **Description** || || code* {.openapi-table-parameter-name} | **Type:** string Error code *Example:*{.openapi-description-annotation} `too_many_requests` *Enum:*{.openapi-description-annotation} `too_many_requests` || || message* {.openapi-table-parameter-name} | **Type:** string Error description *Example:*{.openapi-description-annotation} `Too many requests` |||#{.openapi-table}
[*Deprecated]: No longer supported, please use an alternative and newer version.