---
metadata:
  - name: generator
    content: Diplodoc Platform v5.15.5
alternate:
  - https://delivery.yango.com/docs/en/api/express/openapi/ClaimsApplyChangesRequest.md
---
> **Documentation Index:** Fetch the complete configuration index at https://delivery.yango.com/docs/en/llms.txt

<div class="openapi">

# Edit a claim after confirmation

The method enables you to change some parameters of the claim after it is confirmed

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-post);margin-bottom: 12px">

<div class="openapi__request">

POST {.openapi__method} 
```text translate=no
b2b.delivery.yango.tech/b2b/cargo/integration/v2/claims/apply-changes/request
```



</div>

Service URL

</div>

</div>

### Query parameters

#|||
 **Name** 
|
 **Description** 
||

||
 claim_id<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Claim ID received at the claim creation stage<br>

*Min length:*{.openapi-description-annotation} `32`

*Max length:*{.openapi-description-annotation} `64`
 
||

||
 request_id<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Unique edit request ID (idempotency token)<br>

*Min length:*{.openapi-description-annotation} `1`

*Max length:*{.openapi-description-annotation} `63`
 
|||#{.openapi-table}

### Headers

#|||
 **Name** 
|
 **Description** 
||

||
 Accept-Language<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Preferred response language. Examples: "en" — English<br>Example: `en` 
|||#{.openapi-table}

<div class="openapi-entity">

### Body

{% cut "application/json" %}


```json translate=no
{
    "last_known_revision": "string",
    "changes": [
        {
            "kind": "change_items",
            "pickup_point_id": 1,
            "dropoff_point_id": 2,
            "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"
                    }
                }
            ]
        },
        {
            "kind": "change_comment",
            "point_id": 1,
            "comment": "string"
        },
        {
            "kind": "change_contact",
            "point_id": 1,
            "contact": {
                "name": "Bryan Burns",
                "phone": "+97142774444",
                "phone_additional_code": "602 17 500",
                "email": "customer-BryanBurns@yango.com"
            }
        }
    ]
}
```


{% endcut %}


#|||
 **Name** 
|
 **Description** 
||

||
 changes<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** ([ChangeItemsRequest](#changeitemsrequest) 
or [ChangeCommentRequest](#changecommentrequest) 
or [ChangeContactRequest](#changecontactrequest))[]

A set of changes to the claim (the entire set or nothing will apply).<br>

*Min items:*{.openapi-description-annotation} `1`
 
||

||
 last_known_revision<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

The latest claim version that the customer knows (version obtained from [claims/info](https://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2ClaimsInfo.md)) 
|||#{.openapi-table}

</div>

<div class="openapi-entity">

### ChangeItemsRequest

Request to change a list of items in the order

#|||
 **Name** 
|
 **Description** 
||

||
 dropoff_point_id<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** integer&lt;int64&gt;

ID of the destination point where a list of items is changed (int64)

*Example:*{.openapi-description-annotation} `2`
 
||

||
 items<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** [V2CargoItem](#v2cargoitem)[]

A new list of items for this combination of points<br>

*Min items:*{.openapi-description-annotation} `1`
 
||

||
 kind<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Change type (change_items)

*Example:*{.openapi-description-annotation} `change_items`

*Enum:*{.openapi-description-annotation} `change_items`
 
||

||
 pickup_point_id<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** integer&lt;int64&gt;

ID of the dispatch point where a list of items is changed (int64)

*Example:*{.openapi-description-annotation} `1`
 
|||#{.openapi-table}

</div>

<div class="openapi-entity">

### ChangeCommentRequest

Request to change a comment at the route point

#|||
 **Name** 
|
 **Description** 
||

||
 comment<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

A new comment at the point

*Max length:*{.openapi-description-annotation} `7000`
 
||

||
 kind<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Change type (change_comment)

*Example:*{.openapi-description-annotation} `change_comment`

*Enum:*{.openapi-description-annotation} `change_comment`
 
||

||
 point_id<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** integer&lt;int64&gt;

ID of the point for which a comment is changed (int64)

*Example:*{.openapi-description-annotation} `1`
 
|||#{.openapi-table}

</div>

<div class="openapi-entity">

### ChangeContactRequest

Request to change the contact person at the point

#|||
 **Name** 
|
 **Description** 
||

||
 contact<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** [ContactOnPoint](#contactonpoint)

Information about the contact person 
||

||
 kind<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Change type (change_contact)

*Example:*{.openapi-description-annotation} `change_contact`

*Enum:*{.openapi-description-annotation} `change_contact`
 
||

||
 point_id<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** integer&lt;int64&gt;

ID of the point where the contact person is changed (int64)

*Example:*{.openapi-description-annotation} `1`
 
|||#{.openapi-table}

</div>

<div class="openapi-entity">

### V2CargoItem

#|||
 **Name** 
|
 **Description** 
||

||
 cost_currency<span class="openapi__required">*</span> {.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<span class="openapi__required">*</span> {.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<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** integer&lt;int64&gt;

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<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** integer&lt;int64&gt;

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<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** integer&lt;int64&gt;

Number of units (int64)

*Example:*{.openapi-description-annotation} `1`

*Min value:*{.openapi-description-annotation} `1`
 
||

||
 title<span class="openapi__required">*</span> {.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}

</div>

<div class="openapi-entity">

### ContactOnPoint

Information about the contact person

#|||
 **Name** 
|
 **Description** 
||

||
 name<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Name of the contact person

*Example:*{.openapi-description-annotation} `Bryan Burns`
 
||

||
 phone<span class="openapi__required">*</span> {.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}

</div>

<div class="openapi-entity">

### 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}<code>&#124;</code>\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}

</div>

<div class="openapi-entity">

### CargoItemSizes

Unit dimensions in meters. The actual values should be added to the fields.
If the dimensions aren't added, the order is placed, taking into account the maximum dimensions allowed for the selected rate.
If the actual characteristics of the unit exceed the allowed dimensions, the courier has the right to refuse to fulfill the order on site.
In this case, the minimum fee will be withheld.
Courier: up to 0.80 m × 0.50 m × 0.50 м
Express: up to 1.00 m × 0.60 m × 0.50 m
Cargo:
- Small body: up to 1.70 m × 0.96 m × 0.90 m
- Medium body: up to 2.60 m × 1.30 m × 1.50 m
- Large body: up to 3.80 m × 1.80 m × 1.80 m


#|||
 **Name** 
|
 **Description** 
||

||
 height<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** number

Height in meters

*Example:*{.openapi-description-annotation} `0.3`
 
||

||
 length<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** number

Length in meters

*Example:*{.openapi-description-annotation} `0.1`
 
||

||
 width<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** number

Width in meters

*Example:*{.openapi-description-annotation} `0.2`
 
|||#{.openapi-table}

</div>

<div class="openapi-entity">

### ItemType

Name type: product or service.
Default value: product


#|||
 **Type** 
|
 **Description** 
||

||
 [ItemType](#itemtype) 
|
 

*Enum:*{.openapi-description-annotation} `product`, `service`
 
|||#{.openapi-table}

</div>

<div class="openapi-entity">

### ItemMark

Unique item code (control identification sign). Valid for Russia.
If items have a unique code, a separate block must be created for each of them


#|||
 **Name** 
|
 **Description** 
||

||
 code<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Unit marking code in accordance with the format ''kind''

*Example:*{.openapi-description-annotation} `444D00000000003741`
 
||

||
 kind<span class="openapi__required">*</span> {.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}

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

Limit on the maximum number of apply-changes request calls reached

<div class="openapi-entity">

### Body

{% cut "application/json" %}


```json translate=no
{
    "code": "max_apply_changes",
    "message": "Claim changed, refresh the page"
}
```


{% endcut %}


#|||
 **Name** 
|
 **Description** 
||

||
 code<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Error code

*Example:*{.openapi-description-annotation} `max_apply_changes`

*Enum:*{.openapi-description-annotation} `max_apply_changes`
 
||

||
 message<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

The person understood the error message

*Example:*{.openapi-description-annotation} `Claim changed, refresh the page`
 
|||#{.openapi-table}

</div>

</div>

<div class="openapi__response__code__404">

## 404 Not Found

Claim not found

<div class="openapi-entity">

### Body

{% cut "application/json" %}


```json translate=no
{
    "code": "not_found",
    "message": "Claim not found"
}
```


{% endcut %}


#|||
 **Name** 
|
 **Description** 
||

||
 code<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Error code

*Example:*{.openapi-description-annotation} `not_found`

*Enum:*{.openapi-description-annotation} `not_found`
 
||

||
 message<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Error description

*Example:*{.openapi-description-annotation} `Claim not found`
 
|||#{.openapi-table}

</div>

</div>

<div class="openapi__response__code__409">

## 409 Conflict

The entered request revision is outdated. You need to update the data via [claims/info](https://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2ClaimsInfo.md).

<div class="openapi-entity">

### Body

{% cut "application/json" %}


```json translate=no
{
    "code": "old_version",
    "message": "Claim changed, refresh the page"
}
```


{% endcut %}


#|||
 **Name** 
|
 **Description** 
||

||
 code<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Error code

*Example:*{.openapi-description-annotation} `old_version`

*Enum:*{.openapi-description-annotation} `old_version`
 
||

||
 message<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

The person understood the error message

*Example:*{.openapi-description-annotation} `Claim changed, refresh the page`
 
|||#{.openapi-table}

</div>

</div>
<!-- markdownlint-disable-file -->

</div>



[*Deprecated]: No longer supported, please use an alternative and newer version.