8.2. Partially edit claim after confirmation
Partially edit claim after confirmation
HTTP Request
POST b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/apply-changes/request\
?claim_id={string}\
&request_id={string}
Query Parameters
claim_id * | string Claim ID, received upon creation of claim |
request_id * | string Unique change request ID (idempotency token) |
* Required parameter
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
{ "changes": [ { "comment": string, "contact": { "email": string, "name": string, "phone": string, "phone_additional_code": string }, "dropoff_point_id": integer, "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 } ], "kind": string, "pickup_point_id": integer, "point_id": integer } ], "last_known_revision": string }
Copied to clipboard
Representation
Fields
changes[] * | array A set of changes for the claim (either the whole set or no changes will be applied) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One Of:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | integer ID (int64) of the destination point where we're changing the list of items | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | array New list of items for this combination of points | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Currency of the price per piece in ISO 4217 format (used for value declaration/insurance and/or payment upon receipt). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Price per piece in the currency set in cost_currency. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Short unique ID of the item (the order number for a claim, usually identical to external_order_id) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | object Information on fiscalization (relevant for payment upon receipt) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Item SKU. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Price Decimal(19, 4) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Name type: Product or service.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | object Identifier of whether the product is labeled | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string The value of the product details in the kind format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Labeling type.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Supplier's INN (10 or 12 digits) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string VAT rate. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | integer Quantity of the specified item (int64) Minimum value: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | number Size in meters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | number Size in meters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | number Size in meters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Name of item unit | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Change type (change_items) Allowed values
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | integer ID (int64) of the pickup point where we're changing the list of items | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string New comment at the point | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Change type (change_comment) Allowed values
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | integer ID (int64) of the point where we're changing the comment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Email — required parameter for source and return points | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Name of the contact person | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Contact phone number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Extension number to call courier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Change type (change_contact) Allowed values
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | integer ID (int64) of the point where we're changing the contact | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_known_revision * | string The latest version of the claim known to the client (version obtained from /v2/claims/info) |
changes[] * | array A set of changes for the claim (either the whole set or no changes will be applied) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One Of:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | integer ID (int64) of the destination point where we're changing the list of items | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | array New list of items for this combination of points | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Currency of the price per piece in ISO 4217 format (used for value declaration/insurance and/or payment upon receipt). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Price per piece in the currency set in cost_currency. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Short unique ID of the item (the order number for a claim, usually identical to external_order_id) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | object Information on fiscalization (relevant for payment upon receipt) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Item SKU. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Price Decimal(19, 4) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Name type: Product or service.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | object Identifier of whether the product is labeled | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string The value of the product details in the kind format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Labeling type.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Supplier's INN (10 or 12 digits) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string VAT rate. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | integer Quantity of the specified item (int64) Minimum value: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | number Size in meters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | number Size in meters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | number Size in meters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Name of item unit | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Change type (change_items) Allowed values
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | integer ID (int64) of the pickup point where we're changing the list of items | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string New comment at the point | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Change type (change_comment) Allowed values
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | integer ID (int64) of the point where we're changing the comment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Email — required parameter for source and return points | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Name of the contact person | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Contact phone number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Extension number to call courier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | string Change type (change_contact) Allowed values
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
changes[]. | integer ID (int64) of the point where we're changing the contact | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
last_known_revision * | string The latest version of the claim known to the client (version obtained from /v2/claims/info) |
* Required parameter
Responses
Code 200
OK
Code 400
The limit on the maximum number of apply-changes requests has been reached
{ "code": string, "message": string }
Copied to clipboard
Representation
Fields
code * | string String error code Allowed values
|
message * | string Human-readable error message |
* Required parameter
Code 404
Claim not found
{ "code": string, "message": string }
Copied to clipboard
Representation
Fields
code * | string String error code Allowed values
|
message * | string Human-readable error message |
* Required parameter
Code 409
The passed request revision is outdated, you need to update the data via /v2/claims/info
{ "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
Request:
curl -X POST "b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/apply-changes/request?claim_id={string}\ &request_id={string}" \ -H "Accept-Language: {string}" \ -d '{ "changes": [ { "contact": { "email": "morty@yandex.ru", "name": "Morty", "phone": "+79099999998", "phone_additional_code": "602 17 500" }, "dropoff_point_id": 2, "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 } ], "kind": "change_contact", "pickup_point_id": 1, "point_id": 1 } ] }'
Copied to clipboard