Edit a claim after confirmation

Name

Description

changes*

Type: (ChangeItemsRequest
or ChangeCommentRequest
or ChangeContactRequest)[]

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

Min items: 1

last_known_revision*

Type: string

The latest claim version that the customer knows (version obtained from claims/info)

Name

Description

dropoff_point_id*

Type: integer<int64>

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

Example: 2

items*

Type: V2CargoItem[]

A new list of items for this combination of points

Min items: 1

kind*

Type: string

Change type (change_items)

Example: change_items

Enum: change_items

pickup_point_id*

Type: integer<int64>

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

Example: 1

Name

Description

comment*

Type: string

A new comment at the point

Max length: 7000

kind*

Type: string

Change type (change_comment)

Example: change_comment

Enum: change_comment

point_id*

Type: integer<int64>

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

Example: 1

Name

Description

contact*

Type: ContactOnPoint

Information about the contact person

kind*

Type: string

Change type (change_contact)

Example: change_contact

Enum: change_contact

point_id*

Type: integer<int64>

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

Example: 1

Name

Description

cost_currency*

Type: string

Three-digit code of the payment currency

Example: AED

Min length: 3

Max length: 3

cost_value*

Type: string

Price per item in cost_currency.
To insure the cost, enter the actual cargo price

Example: 2.00

droppof_point*

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: 2

pickup_point*

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: 1

quantity*

Type: integer<int64>

Number of units (int64)

Example: 1

Min value: 1

title*

Type: string

Item name

Example: Plumbus

extra_id

Type: string

Short unique item ID (order number in the claim, usually identical to external_order_id)

Example: BP-208

Max length: 512

fiscalization

Type: ItemFiscalization

Fiscalization information (valid for payment upon receipt)

size

Type: 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

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: 2

Name

Description

name*

Type: string

Name of the contact person

Example: Bryan Burns

phone*

Type: string

Phone number of the contact person

Example: +97142774444

Max length: 30

Pattern: [0-9 \\(\\)\\-\\+]+

email

Type: string

Email is a mandatory parameter for source and return points

Example: customer-BryanBurns@yango.com

Max length: 320

Pattern: \S+@\S+.\S+

phone_additional_code

Type: string

Extension number to call the courier

Example: 602 17 500

Name

Description

article

Type: string

Item SKU.
Must be unique for items delivered from one point.

Example: 20ML50OWKY4FC86

excise

Type: string

Amount of excise tax

Example: 12.50

Pattern: ^-?[0-9]{1,14}(\.[0-9]{0,4})?$

item_type

Type: ItemType

Name type: product or service.
Default value: product

Enum: product, service

mark

Type: 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

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: 3664069397

Pattern: ^(\d{10}<code>&#124;</code>\d{12})$

vat_code_str

Type: string

VAT rate. Possible values:
vat_none — without VAT.
vat0 — 0% VAT (applied in rare cases).
vat10 — 10% VAT.
vat20 — 20% VAT.

Example: vat_none

Name

Description

height*

Type: number

Height in meters

Example: 0.3

length*

Type: number

Length in meters

Example: 0.1

width*

Type: number

Width in meters

Example: 0.2

Type

Description

ItemType

Enum: product, service

Name

Description

code*

Type: string

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

Example: 444D00000000003741

kind*

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: gs1_data_matrix_base64