7.1. Get information on several claims
Returns information on a number of claims taking multiple route points into account. You can use the operation to get information about a claim created via v1/claims/create.
HTTP Request
POST b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/bulk_info
Header Parameters
Accept-Language * | string Preferred language of response. Examples: "ru" — Russian, "en" — English |
Accept-Language * | string Preferred language of response. Examples: "ru" — Russian, "en" — English |
* Required parameter
Request Body
{ "claim_ids": [ "string" ] }
Copied to clipboard
Representation
Fields
claim_ids[] * | array Array of claim IDs to get information for |
claim_ids[] * | array Array of claim IDs to get information for |
* Required parameter
Responses
Code 200
Information on claims
{ "claims": [ { "available_cancel_state": string, "callback_properties": { "callback_url": string }, "carrier_info": { "address": string, "inn": string, "name": string }, "client_requirements": { "assign_robot": boolean, "cargo_loaders": integer, "cargo_options": [ string ], "cargo_type": string, "pro_courier": boolean, "taxi_class": string }, "comment": string, "corp_client_id": string, "created_ts": string, "current_point_id": integer, "due": string, "emergency_contact": { "name": string, "phone": string, "phone_additional_code": string }, "error_messages": [ { "code": string, "message": string } ], "eta": integer, "id": string, "items": [ { "cost_currency": string, "cost_value": string, "droppof_point": integer, "extra_id": string, "fiscalization": { "article": string, "excise": string, "item_type": string, "mark": { "code": string, "kind": string }, "supplier_inn": string, "vat_code_str": string }, "pickup_point": integer, "quantity": integer, "size": { "height": number, "length": number, "width": number }, "title": string, "weight": number } ], "matched_cars": [ { "cargo_loaders": integer, "cargo_type": string, "cargo_type_int": integer, "client_taxi_class": string, "door_to_door": boolean, "pro_courier": boolean, "taxi_class": string } ], "optional_return": boolean, "performer_info": { "car_color": string, "car_color_hex": string, "car_model": string, "car_number": string, "courier_name": string, "legal_name": string, "transport_type": string }, "pricing": { "currency": string, "currency_rules": { "code": string, "sign": string, "template": string, "text": string }, "final_price": string, "final_pricing_calc_id": string, "offer": { "offer_id": string, "price": string, "price_raw": integer, "price_with_vat": string, "valid_until": string } }, "revision": integer, "route_id": string, "route_points": [ { "address": { "building": string, "building_name": string, "city": string, "comment": string, "coordinates": [ number ], "country": string, "description": string, "door_code": string, "door_code_extra": string, "doorbell_name": string, "flat": integer, "floor": integer, "fullname": string, "porch": string, "sflat": string, "sfloor": string, "shortname": string, "street": string, "uri": string }, "contact": { "email": string, "name": string, "phone": string, "phone_additional_code": string }, "expected_visit_interval": { "from": string, "to": string }, "external_order_cost": { "currency": string, "currency_sign": string, "value": string }, "external_order_id": string, "id": integer, "leave_under_door": boolean, "meet_outside": boolean, "modifier_age_check": boolean, "no_door_call": boolean, "payment_on_delivery": { "client_order_id": string, "cost": string, "customer": { "email": string, "full_name": string, "inn": string, "phone": string }, "is_paid": boolean, "payment_method": string, "payment_ref_id": string }, "pickup_code": string, "return_comment": string, "return_reasons": [ string ], "skip_confirmation": boolean, "type": string, "visit_order": integer, "visit_status": string, "visited_at": { "actual": string, "expected": string, "expected_waiting_time_sec": integer } } ], "same_day_data": { "delivery_interval": { "from": string, "to": string } }, "shipping_document": string, "skip_act": boolean, "skip_client_notify": boolean, "skip_door_to_door": boolean, "skip_emergency_notify": boolean, "status": string, "taxi_offer": { "offer_id": string, "price": string, "price_raw": integer }, "updated_ts": string, "user_request_revision": string, "version": integer, "warnings": [ { "code": string, "message": string, "source": string } ] } ] }
Copied to clipboard
Representation
Fields
claims[] * | array List of found claims |
claims[]. | string (deprecated) Identifier for possibility of paid or free cancellation. This mechanism is outdated, use the cancel_state field of the claim/cancel-info method Allowed values
|
claims[]. | object Parameters for notifying the client server when the claim status changes. The notification is a POST request to the specified URL, Important! Parameters are concatenated to the callback_url, which means that a Only HTTP and HTTPS are supported. For HTTPS, the SSL certificate must Notifications should be treated like push ahead of polling that lets you The client should allow that the response of the v1/claims/info operation may |
claims[]. | string URL that will be called when changing statuses for a claim. This mechanism is deprecated, use the v1/claims/journal operation instead. |
claims[]. | object Information about the carrier |
claims[]. | string Carrier's address |
claims[]. | string Carrier's INN (TIN) |
claims[]. | string Name of the carrier |
claims[]. | object Client's requirements specified when creating or editing claim |
claims[]. | boolean Should the system try to assign the order to a rover (six-wheeled robot) |
claims[]. | integer Number of loaders (int64) for the cargo class. Use the service class get method (v1/tariffs) Minimum value: |
claims[]. | array List of additional options in the service class. Acceptable individual options: - auto_courier (only couriers delivering orders by car) - thermobag (courier with an insulated bag) Example of an option list: ["auto_courier"]. Use the service class get method (v1/tariffs) to fetch an exact list of possible values for a specific geo point |
claims[]. | string Body type (size) for the cargo class. Use the service class get method (v1/tariffs) to fetch an exact list of possible values for a specific geo point |
claims[]. | boolean Pro option for the Express and Courier service classes |
claims[]. | string Ride class. Acceptable values: courier, express, cargo |
claims[]. | string General comments on the order |
claims[]. | string Corporate client ID (from OAuth token) |
claims[]. | string Date and time of creation |
claims[]. | integer The integer ID (int64) of the point generated by Delivery. source, destination, return |
claims[]. | string Create an order for a specific time (for example, an order for tomorrow). |
claims[]. | object Contact information with phone number |
claims[]. | string Name of the contact person |
claims[]. | string Contact phone number |
claims[]. | string Extension number to call courier |
claims[]. | array List of error messages |
claims[]. | string Machine-readable error code |
claims[]. | string Human-readable localized error text |
claims[]. | integer Expected time of execution of the order in minutes (int64) |
claims[]. | string Claim ID, received upon creation of claim |
claims[]. | array List of shipment names to be sent |
claims[]. | string Currency of the price per piece in ISO 4217 format (used for value declaration/insurance and/or payment upon receipt). |
claims[]. | string Price per piece in the currency set in cost_currency. |
claims[]. | integer ID (int64) of the delivery point (different from the ID in the claim). It can be an arbitrary number. It must match the value of route_points[].point_id at the destination |
claims[]. | string Short unique ID of the item (the order number for a claim, usually identical to external_order_id) |
claims[]. | object Information on fiscalization (relevant for payment upon receipt) |
claims[]. | string Item SKU. |
claims[]. | string Price Decimal(19, 4) |
claims[]. | string Name type: Product or service.
|
claims[]. | object Identifier of whether the product is labeled |
claims[]. | string The value of the product details in the kind format |
claims[]. | string Labeling type.
|
claims[]. | string Supplier's INN (10 or 12 digits) |
claims[]. | string VAT rate. |
claims[]. | integer ID (int64) of the pickup point (different from the ID in the claim). It can be an arbitrary number. It must match the value of route_points[].point_id at the pickup point |
claims[]. | integer Quantity of the specified item (int64) Minimum value: |
claims[]. | object Item's dimensions in meters. Make sure to pass actual values in the fields. If the dimensions are not passed, the order is considered to be for the maximum dimensions accepted for the service class. If the actual characteristics of the shipment exceed those allowed, Courier: up to 0.80 m × 0.50 m × 0.50 m
|
claims[]. | number Size in meters |
claims[]. | number Size in meters |
claims[]. | number Size in meters |
claims[]. | string Name of item unit |
claims[]. | number Unit weight in kg. Actual values should be passed in the field. If the weight is not passed, the order is considered to be If the actual characteristics of the shipment exceed those allowed, Courier: Up to 10 kg
|
claims[]. | array Information about the performer (array, at the moment always 1 element) |
claims[]. | integer Required number of loaders (int64) Minimum value: |
claims[]. | string Type of truck |
claims[]. | integer Type of truck (int64) |
claims[]. | string Substituted class (for example, "cargo" substituted when "cars" has "cargocorp") |
claims[]. | boolean Door-to-door option for the Express service class |
claims[]. | boolean Pro option for the Express and Courier service classes |
claims[]. | string Ride class. Acceptable values: courier, express, cargo |
claims[]. | boolean Return of products not required if order canceled. Acceptable values:
|
claims[]. | object Information about the courier |
claims[]. | string Color of the vehicle |
claims[]. | string RGB code of the vehicle color |
claims[]. | string Vehicle model |
claims[]. | string Vehicle number |
claims[]. | string Name of the courier delivering the parcel |
claims[]. | string Information about the legal entity fulfilling the delivery |
claims[]. | string Performer's mode of transport: |
claims[]. | object Information about price of claim |
claims[]. | string Three-digit code of the currency used for the calculation |
claims[]. | object Currency display rules |
claims[]. | string Three-digit code of the currency used for the calculation |
claims[]. | string Currency symbol |
claims[]. | string Template |
claims[]. | string Abbreviated name of the currency |
claims[]. | string Price Decimal(19, 4) |
claims[]. | string |
claims[]. | object Offer from Yandex Taxi (valid for some time). |
claims[]. | string Offer identifier |
claims[]. | string Price Decimal(19, 4) |
claims[]. | integer (deprecated) Offer price in the currency specified in the contract (int64) |
claims[]. | string Price Decimal(19, 4) |
claims[]. | string Yandex Taxi offer's time of validity. If the value is omitted, the offer's validity is unlimited |
claims[]. | integer Revision (int64) |
claims[]. | string ID of the route on which the order is delivered |
claims[]. | array Information on route points |
claims[]. | object |
claims[]. | string Building |
claims[]. | string Name of the apartment (building) |
claims[]. | string City |
claims[]. | string Comments for the courier. For point A (pickup point), use the template: "Delivery from the store <>. Inform the manager that it's a Yandex Delivery order. State the order number <> and collect the parcel. The order is for non-cash payment, the delivery must be completed without requiring delivery payment from the recipient." For B points (destination), pass the recipient's requests or instructions via the comment field. For example, "the intercom does not work", "the barrier is closed, call 10 minutes in advance", "do not call, the baby is asleep". |
claims[]. | array Array of two real numbers [longitude, latitude]. The order is important! Rounded coordinate values are specified. |
claims[]. | string Country |
claims[]. | string Geographic area that specifies shortname to global match |
claims[]. | string Intercom code |
claims[]. | string Additional instructions on intercoms |
claims[]. | string Name on the doorbell |
claims[]. | integer Apartment (DEPRECATED) (int64) |
claims[]. | integer Floor (DEPRECATED) (int64) |
claims[]. | string Full name indicating the city (Moscow, Sadovnicheskaya Naberezhnaya, 82 bld. 2). |
claims[]. | string Entrance (can be A) |
claims[]. | string Apartment |
claims[]. | string Floor |
claims[]. | string Address within the city as shown in Taximeter (Sadovnicheskaya Naberezhnaya, 82 bld. 2) |
claims[]. | string Street |
claims[]. | string Map uri of geo object |
claims[]. | object |
claims[]. | string Email — required parameter for source and return points |
claims[]. | string Name of the contact person |
claims[]. | string Contact phone number |
claims[]. | string Extension number to call courier |
claims[]. | object The time interval, returned to the client |
claims[]. | string Start of the time interval |
claims[]. | string End of the time interval |
claims[]. | object The cost of an external order linked to the point |
claims[]. | string |
claims[]. | string |
claims[]. | string |
claims[]. | string Order number from the client's system. |
claims[]. | integer Integer ID of the point (int64) |
claims[]. | boolean Leave the package at the door |
claims[]. | boolean Someone will meet the courier on the street at the entrance |
claims[]. | boolean Check documents for the purchase of alcohol/tobacco products |
claims[]. | boolean Don't ring the doorbell |
claims[]. | object Payment parameters upon receipt |
claims[]. | string Order ID |
claims[]. | string Price Decimal(19, 4) |
claims[]. | object Client information |
claims[]. | string User's email in the format morty@yandex.ru. If not specified, the recipient's email from the point will be used |
claims[]. | string Company name for legal entities, full name for individual entrepreneurs and individuals |
claims[]. | string User's TIN (10 or 12 digits) |
claims[]. | string User's phone number in the format +79990001122. If not specified, the recipient's phone number from the point will be used |
claims[]. | boolean Order payment identifier |
claims[]. | string Selected payment type.
|
claims[]. | string Payment ID |
claims[]. | string Code of parcel delivery to the courier. |
claims[]. | string Comment to reasons for the return of the shipment |
claims[]. | array Reasons for the return of the shipment |
claims[]. | boolean Skip SMS confirmation at this point Default: false (confirmation required) |
claims[]. | string point type:
|
claims[]. | integer Point visit sequence number (numbering starts from 1) (int64) |
claims[]. | string Status of visiting this point: pending: the point has not yet been visited; arrived: the driver arrived at the point; visited: the driver delivered or picked up the shipment at the point; partial_delivery: the point was visited, but part of the shipment wasn't delivered; skipped: the point was skipped (in the case of a return when the client couldn't receive the shipment) Allowed values
|
claims[]. | object Information about the time of visit to the point |
claims[]. | string Actual time of visit to the point. |
claims[]. | string Expected time of visit. Can be filled out (in some cases) only for unvisited points. |
claims[]. | integer Expected waiting time at the point (int64). |
claims[]. | object Additional information for "Same day" claims |
claims[]. | object Parcel pickup and delivery interval |
claims[]. | string Start of the time interval |
claims[]. | string End of the time interval |
claims[]. | string Accompanying documentation |
claims[]. | boolean Do not show delivery receipt |
claims[]. | boolean Do not send SMS notifications to the sender or recipient Default: false (send notifications) |
claims[]. | boolean Opting out of delivery to the door. (Disable the "Door-to-door" option). Acceptable values: - true (the courier will deliver the order to the outdoor entrance) - false (default, door-to-door delivery) |
claims[]. | boolean Do not send emergency notifications to the contact Default: false (send notifications) |
claims[]. | string Claim status Allowed values
|
claims[]. | object Offer from Yandex Taxi (valid for some time). This mechanism is outdated, use pricing.offer |
claims[]. | string Offer identifier |
claims[]. | string Price Decimal(19, 4) |
claims[]. | integer (deprecated) Offer price in the currency specified in the contract (int64) |
claims[]. | string Date and time of last update |
claims[]. | string Current version of changes in the user's claim |
claims[]. | integer Version (int64) |
claims[]. | array Claim cycle warnings |
claims[]. | string Warning type. not_fit_in_car: the shipment may not fit in the vehicle, requirement_unavailable: the specified requirement is unavailable and was ignored, address_not_found: Yandex Maps didn't find the specified address, address_too_far: coordinates from Yandex Maps at the specified address are far from the passed coordinates |
claims[]. | string Localized information with the reason for the warning |
claims[]. | string Warning source. client_requirements: warning related to client requirements, taxi_requirements: warning related to Taxi requirements, route_points: warning related to passed addresses |
claims[] * | array List of found claims |
claims[]. | string (deprecated) Identifier for possibility of paid or free cancellation. This mechanism is outdated, use the cancel_state field of the claim/cancel-info method Allowed values
|
claims[]. | object Parameters for notifying the client server when the claim status changes. The notification is a POST request to the specified URL, Important! Parameters are concatenated to the callback_url, which means that a Only HTTP and HTTPS are supported. For HTTPS, the SSL certificate must Notifications should be treated like push ahead of polling that lets you The client should allow that the response of the v1/claims/info operation may |
claims[]. | string URL that will be called when changing statuses for a claim. This mechanism is deprecated, use the v1/claims/journal operation instead. |
claims[]. | object Information about the carrier |
claims[]. | string Carrier's address |
claims[]. | string Carrier's INN (TIN) |
claims[]. | string Name of the carrier |
claims[]. | object Client's requirements specified when creating or editing claim |
claims[]. | boolean Should the system try to assign the order to a rover (six-wheeled robot) |
claims[]. | integer Number of loaders (int64) for the cargo class. Use the service class get method (v1/tariffs) Minimum value: |
claims[]. | array List of additional options in the service class. Acceptable individual options: - auto_courier (only couriers delivering orders by car) - thermobag (courier with an insulated bag) Example of an option list: ["auto_courier"]. Use the service class get method (v1/tariffs) to fetch an exact list of possible values for a specific geo point |
claims[]. | string Body type (size) for the cargo class. Use the service class get method (v1/tariffs) to fetch an exact list of possible values for a specific geo point |
claims[]. | boolean Pro option for the Express and Courier service classes |
claims[]. | string Ride class. Acceptable values: courier, express, cargo |
claims[]. | string General comments on the order |
claims[]. | string Corporate client ID (from OAuth token) |
claims[]. | string Date and time of creation |
claims[]. | integer The integer ID (int64) of the point generated by Delivery. source, destination, return |
claims[]. | string Create an order for a specific time (for example, an order for tomorrow). |
claims[]. | object Contact information with phone number |
claims[]. | string Name of the contact person |
claims[]. | string Contact phone number |
claims[]. | string Extension number to call courier |
claims[]. | array List of error messages |
claims[]. | string Machine-readable error code |
claims[]. | string Human-readable localized error text |
claims[]. | integer Expected time of execution of the order in minutes (int64) |
claims[]. | string Claim ID, received upon creation of claim |
claims[]. | array List of shipment names to be sent |
claims[]. | string Currency of the price per piece in ISO 4217 format (used for value declaration/insurance and/or payment upon receipt). |
claims[]. | string Price per piece in the currency set in cost_currency. |
claims[]. | integer ID (int64) of the delivery point (different from the ID in the claim). It can be an arbitrary number. It must match the value of route_points[].point_id at the destination |
claims[]. | string Short unique ID of the item (the order number for a claim, usually identical to external_order_id) |
claims[]. | object Information on fiscalization (relevant for payment upon receipt) |
claims[]. | string Item SKU. |
claims[]. | string Price Decimal(19, 4) |
claims[]. | string Name type: Product or service.
|
claims[]. | object Identifier of whether the product is labeled |
claims[]. | string The value of the product details in the kind format |
claims[]. | string Labeling type.
|
claims[]. | string Supplier's INN (10 or 12 digits) |
claims[]. | string VAT rate. |
claims[]. | integer ID (int64) of the pickup point (different from the ID in the claim). It can be an arbitrary number. It must match the value of route_points[].point_id at the pickup point |
claims[]. | integer Quantity of the specified item (int64) Minimum value: |
claims[]. | object Item's dimensions in meters. Make sure to pass actual values in the fields. If the dimensions are not passed, the order is considered to be for the maximum dimensions accepted for the service class. If the actual characteristics of the shipment exceed those allowed, Courier: up to 0.80 m × 0.50 m × 0.50 m
|
claims[]. | number Size in meters |
claims[]. | number Size in meters |
claims[]. | number Size in meters |
claims[]. | string Name of item unit |
claims[]. | number Unit weight in kg. Actual values should be passed in the field. If the weight is not passed, the order is considered to be If the actual characteristics of the shipment exceed those allowed, Courier: Up to 10 kg
|
claims[]. | array Information about the performer (array, at the moment always 1 element) |
claims[]. | integer Required number of loaders (int64) Minimum value: |
claims[]. | string Type of truck |
claims[]. | integer Type of truck (int64) |
claims[]. | string Substituted class (for example, "cargo" substituted when "cars" has "cargocorp") |
claims[]. | boolean Door-to-door option for the Express service class |
claims[]. | boolean Pro option for the Express and Courier service classes |
claims[]. | string Ride class. Acceptable values: courier, express, cargo |
claims[]. | boolean Return of products not required if order canceled. Acceptable values:
|
claims[]. | object Information about the courier |
claims[]. | string Color of the vehicle |
claims[]. | string RGB code of the vehicle color |
claims[]. | string Vehicle model |
claims[]. | string Vehicle number |
claims[]. | string Name of the courier delivering the parcel |
claims[]. | string Information about the legal entity fulfilling the delivery |
claims[]. | string Performer's mode of transport: |
claims[]. | object Information about price of claim |
claims[]. | string Three-digit code of the currency used for the calculation |
claims[]. | object Currency display rules |
claims[]. | string Three-digit code of the currency used for the calculation |
claims[]. | string Currency symbol |
claims[]. | string Template |
claims[]. | string Abbreviated name of the currency |
claims[]. | string Price Decimal(19, 4) |
claims[]. | string |
claims[]. | object Offer from Yandex Taxi (valid for some time). |
claims[]. | string Offer identifier |
claims[]. | string Price Decimal(19, 4) |
claims[]. | integer (deprecated) Offer price in the currency specified in the contract (int64) |
claims[]. | string Price Decimal(19, 4) |
claims[]. | string Yandex Taxi offer's time of validity. If the value is omitted, the offer's validity is unlimited |
claims[]. | integer Revision (int64) |
claims[]. | string ID of the route on which the order is delivered |
claims[]. | array Information on route points |
claims[]. | object |
claims[]. | string Building |
claims[]. | string Name of the apartment (building) |
claims[]. | string City |
claims[]. | string Comments for the courier. For point A (pickup point), use the template: "Delivery from the store <>. Inform the manager that it's a Yandex Delivery order. State the order number <> and collect the parcel. The order is for non-cash payment, the delivery must be completed without requiring delivery payment from the recipient." For B points (destination), pass the recipient's requests or instructions via the comment field. For example, "the intercom does not work", "the barrier is closed, call 10 minutes in advance", "do not call, the baby is asleep". |
claims[]. | array Array of two real numbers [longitude, latitude]. The order is important! Rounded coordinate values are specified. |
claims[]. | string Country |
claims[]. | string Geographic area that specifies shortname to global match |
claims[]. | string Intercom code |
claims[]. | string Additional instructions on intercoms |
claims[]. | string Name on the doorbell |
claims[]. | integer Apartment (DEPRECATED) (int64) |
claims[]. | integer Floor (DEPRECATED) (int64) |
claims[]. | string Full name indicating the city (Moscow, Sadovnicheskaya Naberezhnaya, 82 bld. 2). |
claims[]. | string Entrance (can be A) |
claims[]. | string Apartment |
claims[]. | string Floor |
claims[]. | string Address within the city as shown in Taximeter (Sadovnicheskaya Naberezhnaya, 82 bld. 2) |
claims[]. | string Street |
claims[]. | string Map uri of geo object |
claims[]. | object |
claims[]. | string Email — required parameter for source and return points |
claims[]. | string Name of the contact person |
claims[]. | string Contact phone number |
claims[]. | string Extension number to call courier |
claims[]. | object The time interval, returned to the client |
claims[]. | string Start of the time interval |
claims[]. | string End of the time interval |
claims[]. | object The cost of an external order linked to the point |
claims[]. | string |
claims[]. | string |
claims[]. | string |
claims[]. | string Order number from the client's system. |
claims[]. | integer Integer ID of the point (int64) |
claims[]. | boolean Leave the package at the door |
claims[]. | boolean Someone will meet the courier on the street at the entrance |
claims[]. | boolean Check documents for the purchase of alcohol/tobacco products |
claims[]. | boolean Don't ring the doorbell |
claims[]. | object Payment parameters upon receipt |
claims[]. | string Order ID |
claims[]. | string Price Decimal(19, 4) |
claims[]. | object Client information |
claims[]. | string User's email in the format morty@yandex.ru. If not specified, the recipient's email from the point will be used |
claims[]. | string Company name for legal entities, full name for individual entrepreneurs and individuals |
claims[]. | string User's TIN (10 or 12 digits) |
claims[]. | string User's phone number in the format +79990001122. If not specified, the recipient's phone number from the point will be used |
claims[]. | boolean Order payment identifier |
claims[]. | string Selected payment type.
|
claims[]. | string Payment ID |
claims[]. | string Code of parcel delivery to the courier. |
claims[]. | string Comment to reasons for the return of the shipment |
claims[]. | array Reasons for the return of the shipment |
claims[]. | boolean Skip SMS confirmation at this point Default: false (confirmation required) |
claims[]. | string point type:
|
claims[]. | integer Point visit sequence number (numbering starts from 1) (int64) |
claims[]. | string Status of visiting this point: pending: the point has not yet been visited; arrived: the driver arrived at the point; visited: the driver delivered or picked up the shipment at the point; partial_delivery: the point was visited, but part of the shipment wasn't delivered; skipped: the point was skipped (in the case of a return when the client couldn't receive the shipment) Allowed values
|
claims[]. | object Information about the time of visit to the point |
claims[]. | string Actual time of visit to the point. |
claims[]. | string Expected time of visit. Can be filled out (in some cases) only for unvisited points. |
claims[]. | integer Expected waiting time at the point (int64). |
claims[]. | object Additional information for "Same day" claims |
claims[]. | object Parcel pickup and delivery interval |
claims[]. | string Start of the time interval |
claims[]. | string End of the time interval |
claims[]. | string Accompanying documentation |
claims[]. | boolean Do not show delivery receipt |
claims[]. | boolean Do not send SMS notifications to the sender or recipient Default: false (send notifications) |
claims[]. | boolean Opting out of delivery to the door. (Disable the "Door-to-door" option). Acceptable values: - true (the courier will deliver the order to the outdoor entrance) - false (default, door-to-door delivery) |
claims[]. | boolean Do not send emergency notifications to the contact Default: false (send notifications) |
claims[]. | string Claim status Allowed values
|
claims[]. | object Offer from Yandex Taxi (valid for some time). This mechanism is outdated, use pricing.offer |
claims[]. | string Offer identifier |
claims[]. | string Price Decimal(19, 4) |
claims[]. | integer (deprecated) Offer price in the currency specified in the contract (int64) |
claims[]. | string Date and time of last update |
claims[]. | string Current version of changes in the user's claim |
claims[]. | integer Version (int64) |
claims[]. | array Claim cycle warnings |
claims[]. | string Warning type. not_fit_in_car: the shipment may not fit in the vehicle, requirement_unavailable: the specified requirement is unavailable and was ignored, address_not_found: Yandex Maps didn't find the specified address, address_too_far: coordinates from Yandex Maps at the specified address are far from the passed coordinates |
claims[]. | string Localized information with the reason for the warning |
claims[]. | string Warning source. client_requirements: warning related to client requirements, taxi_requirements: warning related to Taxi requirements, route_points: warning related to passed addresses |
* Required parameter
Code 429
Too many requests
{ "code": string, "message": string }
Copied to clipboard
Representation
Fields
code * | string String error code Allowed values
|
message * | string Human-readable error message |
* Required parameter
Example
Responses:
{ "claims": [ { "available_cancel_state": "free", "callback_properties": { "callback_url": "https://www.example.com" }, "carrier_info": { "address": "Flower city, Daisy lane 1", "inn": "123456789", "name": "Chamomile LLC" }, "client_requirements": { "cargo_loaders": 0, "cargo_options": "thermobag", "cargo_type": "lcv_m", "pro_courier": false, "taxi_class": "express" }, "comment": "Restaurant", "corp_client_id": "cd8cc018bde34597932855e3cfdce927", "created_ts": "2020-01-01T00:00:00+00:00", "current_point_id": 6987, "due": "2020-01-01T00:00:00+00:00", "emergency_contact": { "name": "Rick", "phone": "+79099999999", "phone_additional_code": "602 17 500" }, "error_messages": [ { "code": "some_error", "message": "Some error" } ], "eta": 10, "id": "741cedf82cd464fa6fa16d87155c636", "items": [ { "cost_currency": "RUB", "cost_value": "2.00", "droppof_point": 2, "extra_id": "BP-208", "fiscalization": { "article": "20ML50OWKY4FC86", "excise": "12.50", "mark": { "code": "444D00000000003741", "kind": "gs1_data_matrix_base64" }, "supplier_inn": 3664069397, "vat_code_str": "vat_none" }, "pickup_point": 1, "quantity": 1, "size": { "height": 0.1, "length": 0.1, "width": 0.1 }, "title": "Plumbus", "weight": 2 } ], "matched_cars": [ { "cargo_loaders": 0, "cargo_type": "lcv_m", "cargo_type_int": "2 is equal to \"lcv_m\"", "client_taxi_class": "cargo", "door_to_door": false, "pro_courier": false, "taxi_class": "express" } ], "optional_return": false, "performer_info": { "car_color": "red", "car_color_hex": "FF00000", "car_model": "Hyundai Solaris", "car_number": "А100РА100", "courier_name": "Smith", "legal_name": "Individual entrepreneur Mark Smith", "transport_type": "car" }, "pricing": { "currency": "RUB", "currency_rules": { "code": "RUB", "sign": "₽", "template": "$VALUE$ $SIGN$$CURRENCY$", "text": "rub." }, "final_price": "12.50", "offer": { "offer_id": "28ae5f1d72364468be3f5e26cd6a66bf", "price": "12.50", "price_raw": 12, "price_with_vat": "12.50", "valid_until": "2020-01-01T00:00:00+00:00" } }, "revision": 1, "route_points": [ { "address": { "building": "23k1A", "building_name": "Krasnaya Roza business center", "city": "Saint Petersburg", "comment": "The intercom doesn't work", "country": "Russian Federation", "description": "Odintsovo, Moscow oblast, Russia", "door_code": "169", "door_code_extra": "code to enter the yard #1234, apartment code #4321", "doorbell_name": "Magidovich", "flat": 1, "floor": 1, "fullname": "St. Petersburg, Bolshaya Monetnaya Ulitsa, 1 bld. 1A", "porch": "A", "sflat": "1", "sfloor": "1", "shortname": "Bolshaya Monetnaya Ulitsa, 1, apt. 1A", "street": "Bolshaya Monetnaya ulitsa", "uri": "ymapsbm1://geo?ll=38.805%2C55.084" }, "contact": { "email": "morty@yandex.ru", "name": "Morty", "phone": "+79099999998", "phone_additional_code": "602 17 500" }, "expected_visit_interval": { "from": "2020-01-01T00:00:00+00:00", "to": "2020-01-02T00:00:00+00:00" }, "external_order_cost": { "currency": "RUB", "currency_sign": "₽", "value": "100.0" }, "external_order_id": "100", "id": 1, "payment_on_delivery": { "client_order_id": "100", "cost": "12.50", "customer": { "email": "morty@yandex.ru", "full_name": "Morty", "inn": 3664069397, "phone": "79000000000" }, "is_paid": false }, "pickup_code": "893422", "skip_confirmation": false, "type": "source", "visit_order": 1, "visit_status": "pending" } ], "same_day_data": { "delivery_interval": { "from": "2020-01-01T07:00:00+00:00", "to": "2020-01-01T07:00:00+00:00" } }, "skip_act": false, "skip_client_notify": false, "skip_door_to_door": false, "skip_emergency_notify": false, "status": "new", "taxi_offer": { "offer_id": "28ae5f1d72364468be3f5e26cd6a66bf", "price": "12.50", "price_raw": 12 }, "updated_ts": "2020-01-01T00:00:00+00:00", "warnings": [ { "code": "not_fit_in_car", "message": "Warning", "source": "client_requirements" } ] } ] }
Copied to clipboard
{ "code": "too_many_requests", "message": "Too many requests" }
Copied to clipboard