8.2. Partially edit claim after confirmation

  1. HTTP Request
  2. Query Parameters
  3. Header Parameters
  4. Request Body
    1. Representation
    2. Fields
  5. Responses
    1. Code 200
    2. Code 400
      1. Representation
      2. Fields
    3. Code 404
      1. Representation
      2. Fields
    4. Code 409
      1. Representation
      2. Fields
  6. Example

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)

claim_id *

string

Claim ID, received upon creation of claim

request_id *

string

Unique change request ID (idempotency token)

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

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

Collapse all
Expand all

Fields

changes[] *

array

A set of changes for the claim (either the whole set or no changes will be applied)

One Of:

changes[].dropoff_point_id *

integer

ID (int64) of the destination point where we're changing the list of items

changes[].items[] *

array

New list of items for this combination of points

changes[].items[].cost_currency *

string

Currency of the price per piece in ISO 4217 format (used for value declaration/insurance and/or payment upon receipt).
Example: RUB

changes[].items[].cost_value *

string

Price per piece in the currency set in cost_currency.
To insure the cost, pass the actual price of the cargo.

changes[].items[].droppof_point *

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[].items[].extra_id

string

Short unique ID of the item (the order number for a claim, usually identical to external_order_id)

changes[].items[].fiscalization

object

Information on fiscalization (relevant for payment upon receipt)

changes[].items[].fiscalization.article

string

Item SKU.
Must be unique for items handed over at the point.

changes[].items[].fiscalization.excise

string

Price Decimal(19, 4)

changes[].items[].fiscalization.item_type

string

Name type: Product or service.
By default, we believe that it's 'product'

Allowed values
  1. product
  2. service

changes[].items[].fiscalization.mark

object

Identifier of whether the product is labeled
The acceptable quantity value for a labeled product is 1

changes[].items[].fiscalization.mark.code *

string

The value of the product details in the kind format

changes[].items[].fiscalization.mark.kind *

string

Labeling type.
Acceptable values:

  1. compiled: Already disassembled label with identified GTIN and Serial.
    Example:
    • 444D00000000003741
  2. gs1_data_matrix_base64: Product code in the GS1 Data Matrix format, subject to labeling by means of identification.
    Maximum of 200 characters.
    The product code must be passed in its entirety by encoding the string in base64 format.

changes[].items[].fiscalization.supplier_inn

string

Supplier's INN (10 or 12 digits)

changes[].items[].fiscalization.vat_code_str

string

VAT rate.
vat_none: No VAT.
vat0: Zero VAT rate (applies in rare cases).
vat10: 10% VAT.
vat20: 20% VAT.

changes[].items[].pickup_point *

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[].items[].quantity *

integer

Quantity of the specified item (int64)

Minimum value: 1.

changes[].items[].size

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,
the courier has the right to refuse to carry out the order when they arrive at the point.
In this case, the pickup cost will be deducted.

Courier: up to 0.80 m × 0.50 m × 0.50 m
Express: up to 1.00 m × 0.60 m × 0.50 m
Cargo:

  • Small van: up to 1.70 m × 0.96 m × 0.90 m
  • Medium van: up to 2.60 m × 1.30 m × 1.50 m
  • Large van: up to 3.80 m × 1.80 m × 1.80 m

changes[].items[].size.height *

number

Size in meters

changes[].items[].size.length *

number

Size in meters

changes[].items[].size.width *

number

Size in meters

changes[].items[].title *

string

Name of item unit

changes[].items[].weight

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
for the maximum dimensions accepted for the service class.

If the actual characteristics of the shipment exceed those allowed,
the courier has the right to refuse to carry out the order when they arrive at the point.
In this case, the pickup cost will be deducted.

Courier: Up to 10 kg
Express: Up to 20 kg
Cargo:

  • Small van: Up to 300 kg
  • Medium van: Up to 700 kg
  • Large van: Up to 1400 kg

changes[].kind *

string

Change type (change_items)

Allowed values
  1. change_items

changes[].pickup_point_id *

integer

ID (int64) of the pickup point where we're changing the list of items

changes[].dropoff_point_id *

integer

ID (int64) of the destination point where we're changing the list of items

changes[].items[] *

array

New list of items for this combination of points

changes[].items[].cost_currency *

string

Currency of the price per piece in ISO 4217 format (used for value declaration/insurance and/or payment upon receipt).
Example: RUB

changes[].items[].cost_value *

string

Price per piece in the currency set in cost_currency.
To insure the cost, pass the actual price of the cargo.

changes[].items[].droppof_point *

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[].items[].extra_id

string

Short unique ID of the item (the order number for a claim, usually identical to external_order_id)

changes[].items[].fiscalization

object

Information on fiscalization (relevant for payment upon receipt)

changes[].items[].fiscalization.article

string

Item SKU.
Must be unique for items handed over at the point.

changes[].items[].fiscalization.excise

string

Price Decimal(19, 4)

changes[].items[].fiscalization.item_type

string

Name type: Product or service.
By default, we believe that it's 'product'

Allowed values
  1. product
  2. service

changes[].items[].fiscalization.mark

object

Identifier of whether the product is labeled
The acceptable quantity value for a labeled product is 1

changes[].items[].fiscalization.mark.code *

string

The value of the product details in the kind format

changes[].items[].fiscalization.mark.kind *

string

Labeling type.
Acceptable values:

  1. compiled: Already disassembled label with identified GTIN and Serial.
    Example:
    • 444D00000000003741
  2. gs1_data_matrix_base64: Product code in the GS1 Data Matrix format, subject to labeling by means of identification.
    Maximum of 200 characters.
    The product code must be passed in its entirety by encoding the string in base64 format.

changes[].items[].fiscalization.supplier_inn

string

Supplier's INN (10 or 12 digits)

changes[].items[].fiscalization.vat_code_str

string

VAT rate.
vat_none: No VAT.
vat0: Zero VAT rate (applies in rare cases).
vat10: 10% VAT.
vat20: 20% VAT.

changes[].items[].pickup_point *

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[].items[].quantity *

integer

Quantity of the specified item (int64)

Minimum value: 1.

changes[].items[].size

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,
the courier has the right to refuse to carry out the order when they arrive at the point.
In this case, the pickup cost will be deducted.

Courier: up to 0.80 m × 0.50 m × 0.50 m
Express: up to 1.00 m × 0.60 m × 0.50 m
Cargo:

  • Small van: up to 1.70 m × 0.96 m × 0.90 m
  • Medium van: up to 2.60 m × 1.30 m × 1.50 m
  • Large van: up to 3.80 m × 1.80 m × 1.80 m

changes[].items[].size.height *

number

Size in meters

changes[].items[].size.length *

number

Size in meters

changes[].items[].size.width *

number

Size in meters

changes[].items[].title *

string

Name of item unit

changes[].items[].weight

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
for the maximum dimensions accepted for the service class.

If the actual characteristics of the shipment exceed those allowed,
the courier has the right to refuse to carry out the order when they arrive at the point.
In this case, the pickup cost will be deducted.

Courier: Up to 10 kg
Express: Up to 20 kg
Cargo:

  • Small van: Up to 300 kg
  • Medium van: Up to 700 kg
  • Large van: Up to 1400 kg

changes[].kind *

string

Change type (change_items)

Allowed values
  1. change_items

changes[].pickup_point_id *

integer

ID (int64) of the pickup point where we're changing the list of items

changes[].dropoff_point_id *

integer

ID (int64) of the destination point where we're changing the list of items

changes[].items[] *

array

New list of items for this combination of points

changes[].items[].cost_currency *

string

Currency of the price per piece in ISO 4217 format (used for value declaration/insurance and/or payment upon receipt).
Example: RUB

changes[].items[].cost_value *

string

Price per piece in the currency set in cost_currency.
To insure the cost, pass the actual price of the cargo.

changes[].items[].droppof_point *

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[].items[].extra_id

string

Short unique ID of the item (the order number for a claim, usually identical to external_order_id)

changes[].items[].fiscalization

object

Information on fiscalization (relevant for payment upon receipt)

changes[].items[].fiscalization.article

string

Item SKU.
Must be unique for items handed over at the point.

changes[].items[].fiscalization.excise

string

Price Decimal(19, 4)

changes[].items[].fiscalization.item_type

string

Name type: Product or service.
By default, we believe that it's 'product'

Allowed values
  1. product
  2. service

changes[].items[].fiscalization.mark

object

Identifier of whether the product is labeled
The acceptable quantity value for a labeled product is 1

changes[].items[].fiscalization.mark.code *

string

The value of the product details in the kind format

changes[].items[].fiscalization.mark.kind *

string

Labeling type.
Acceptable values:

  1. compiled: Already disassembled label with identified GTIN and Serial.
    Example:
    • 444D00000000003741
  2. gs1_data_matrix_base64: Product code in the GS1 Data Matrix format, subject to labeling by means of identification.
    Maximum of 200 characters.
    The product code must be passed in its entirety by encoding the string in base64 format.

changes[].items[].fiscalization.supplier_inn

string

Supplier's INN (10 or 12 digits)

changes[].items[].fiscalization.vat_code_str

string

VAT rate.
vat_none: No VAT.
vat0: Zero VAT rate (applies in rare cases).
vat10: 10% VAT.
vat20: 20% VAT.

changes[].items[].pickup_point *

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[].items[].quantity *

integer

Quantity of the specified item (int64)

Minimum value: 1.

changes[].items[].size

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,
the courier has the right to refuse to carry out the order when they arrive at the point.
In this case, the pickup cost will be deducted.

Courier: up to 0.80 m × 0.50 m × 0.50 m
Express: up to 1.00 m × 0.60 m × 0.50 m
Cargo:

  • Small van: up to 1.70 m × 0.96 m × 0.90 m
  • Medium van: up to 2.60 m × 1.30 m × 1.50 m
  • Large van: up to 3.80 m × 1.80 m × 1.80 m

changes[].items[].size.height *

number

Size in meters

changes[].items[].size.length *

number

Size in meters

changes[].items[].size.width *

number

Size in meters

changes[].items[].title *

string

Name of item unit

changes[].items[].weight

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
for the maximum dimensions accepted for the service class.

If the actual characteristics of the shipment exceed those allowed,
the courier has the right to refuse to carry out the order when they arrive at the point.
In this case, the pickup cost will be deducted.

Courier: Up to 10 kg
Express: Up to 20 kg
Cargo:

  • Small van: Up to 300 kg
  • Medium van: Up to 700 kg
  • Large van: Up to 1400 kg

changes[].kind *

string

Change type (change_items)

Allowed values
  1. change_items

changes[].pickup_point_id *

integer

ID (int64) of the pickup point where we're changing the list of items

changes[].comment *

string

New comment at the point

changes[].kind *

string

Change type (change_comment)

Allowed values
  1. change_comment

changes[].point_id *

integer

ID (int64) of the point where we're changing the comment

changes[].contact *

object

changes[].contact.email

string

Email — required parameter for source and return points

changes[].contact.name *

string

Name of the contact person

changes[].contact.phone *

string

Contact phone number

changes[].contact.phone_additional_code

string

Extension number to call courier

changes[].kind *

string

Change type (change_contact)

Allowed values
  1. change_contact

changes[].point_id *

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[].dropoff_point_id *

integer

ID (int64) of the destination point where we're changing the list of items

changes[].items[] *

array

New list of items for this combination of points

changes[].items[].cost_currency *

string

Currency of the price per piece in ISO 4217 format (used for value declaration/insurance and/or payment upon receipt).
Example: RUB

changes[].items[].cost_value *

string

Price per piece in the currency set in cost_currency.
To insure the cost, pass the actual price of the cargo.

changes[].items[].droppof_point *

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[].items[].extra_id

string

Short unique ID of the item (the order number for a claim, usually identical to external_order_id)

changes[].items[].fiscalization

object

Information on fiscalization (relevant for payment upon receipt)

changes[].items[].fiscalization.article

string

Item SKU.
Must be unique for items handed over at the point.

changes[].items[].fiscalization.excise

string

Price Decimal(19, 4)

changes[].items[].fiscalization.item_type

string

Name type: Product or service.
By default, we believe that it's 'product'

Allowed values
  1. product
  2. service

changes[].items[].fiscalization.mark

object

Identifier of whether the product is labeled
The acceptable quantity value for a labeled product is 1

changes[].items[].fiscalization.mark.code *

string

The value of the product details in the kind format

changes[].items[].fiscalization.mark.kind *

string

Labeling type.
Acceptable values:

  1. compiled: Already disassembled label with identified GTIN and Serial.
    Example:
    • 444D00000000003741
  2. gs1_data_matrix_base64: Product code in the GS1 Data Matrix format, subject to labeling by means of identification.
    Maximum of 200 characters.
    The product code must be passed in its entirety by encoding the string in base64 format.

changes[].items[].fiscalization.supplier_inn

string

Supplier's INN (10 or 12 digits)

changes[].items[].fiscalization.vat_code_str

string

VAT rate.
vat_none: No VAT.
vat0: Zero VAT rate (applies in rare cases).
vat10: 10% VAT.
vat20: 20% VAT.

changes[].items[].pickup_point *

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[].items[].quantity *

integer

Quantity of the specified item (int64)

Minimum value: 1.

changes[].items[].size

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,
the courier has the right to refuse to carry out the order when they arrive at the point.
In this case, the pickup cost will be deducted.

Courier: up to 0.80 m × 0.50 m × 0.50 m
Express: up to 1.00 m × 0.60 m × 0.50 m
Cargo:

  • Small van: up to 1.70 m × 0.96 m × 0.90 m
  • Medium van: up to 2.60 m × 1.30 m × 1.50 m
  • Large van: up to 3.80 m × 1.80 m × 1.80 m

changes[].items[].size.height *

number

Size in meters

changes[].items[].size.length *

number

Size in meters

changes[].items[].size.width *

number

Size in meters

changes[].items[].title *

string

Name of item unit

changes[].items[].weight

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
for the maximum dimensions accepted for the service class.

If the actual characteristics of the shipment exceed those allowed,
the courier has the right to refuse to carry out the order when they arrive at the point.
In this case, the pickup cost will be deducted.

Courier: Up to 10 kg
Express: Up to 20 kg
Cargo:

  • Small van: Up to 300 kg
  • Medium van: Up to 700 kg
  • Large van: Up to 1400 kg

changes[].kind *

string

Change type (change_items)

Allowed values
  1. change_items

changes[].pickup_point_id *

integer

ID (int64) of the pickup point where we're changing the list of items

changes[].dropoff_point_id *

integer

ID (int64) of the destination point where we're changing the list of items

changes[].items[] *

array

New list of items for this combination of points

changes[].items[].cost_currency *

string

Currency of the price per piece in ISO 4217 format (used for value declaration/insurance and/or payment upon receipt).
Example: RUB

changes[].items[].cost_value *

string

Price per piece in the currency set in cost_currency.
To insure the cost, pass the actual price of the cargo.

changes[].items[].droppof_point *

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[].items[].extra_id

string

Short unique ID of the item (the order number for a claim, usually identical to external_order_id)

changes[].items[].fiscalization

object

Information on fiscalization (relevant for payment upon receipt)

changes[].items[].fiscalization.article

string

Item SKU.
Must be unique for items handed over at the point.

changes[].items[].fiscalization.excise

string

Price Decimal(19, 4)

changes[].items[].fiscalization.item_type

string

Name type: Product or service.
By default, we believe that it's 'product'

Allowed values
  1. product
  2. service

changes[].items[].fiscalization.mark

object

Identifier of whether the product is labeled
The acceptable quantity value for a labeled product is 1

changes[].items[].fiscalization.mark.code *

string

The value of the product details in the kind format

changes[].items[].fiscalization.mark.kind *

string

Labeling type.
Acceptable values:

  1. compiled: Already disassembled label with identified GTIN and Serial.
    Example:
    • 444D00000000003741
  2. gs1_data_matrix_base64: Product code in the GS1 Data Matrix format, subject to labeling by means of identification.
    Maximum of 200 characters.
    The product code must be passed in its entirety by encoding the string in base64 format.

changes[].items[].fiscalization.supplier_inn

string

Supplier's INN (10 or 12 digits)

changes[].items[].fiscalization.vat_code_str

string

VAT rate.
vat_none: No VAT.
vat0: Zero VAT rate (applies in rare cases).
vat10: 10% VAT.
vat20: 20% VAT.

changes[].items[].pickup_point *

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[].items[].quantity *

integer

Quantity of the specified item (int64)

Minimum value: 1.

changes[].items[].size

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,
the courier has the right to refuse to carry out the order when they arrive at the point.
In this case, the pickup cost will be deducted.

Courier: up to 0.80 m × 0.50 m × 0.50 m
Express: up to 1.00 m × 0.60 m × 0.50 m
Cargo:

  • Small van: up to 1.70 m × 0.96 m × 0.90 m
  • Medium van: up to 2.60 m × 1.30 m × 1.50 m
  • Large van: up to 3.80 m × 1.80 m × 1.80 m

changes[].items[].size.height *

number

Size in meters

changes[].items[].size.length *

number

Size in meters

changes[].items[].size.width *

number

Size in meters

changes[].items[].title *

string

Name of item unit

changes[].items[].weight

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
for the maximum dimensions accepted for the service class.

If the actual characteristics of the shipment exceed those allowed,
the courier has the right to refuse to carry out the order when they arrive at the point.
In this case, the pickup cost will be deducted.

Courier: Up to 10 kg
Express: Up to 20 kg
Cargo:

  • Small van: Up to 300 kg
  • Medium van: Up to 700 kg
  • Large van: Up to 1400 kg

changes[].kind *

string

Change type (change_items)

Allowed values
  1. change_items

changes[].pickup_point_id *

integer

ID (int64) of the pickup point where we're changing the list of items

changes[].dropoff_point_id *

integer

ID (int64) of the destination point where we're changing the list of items

changes[].items[] *

array

New list of items for this combination of points

changes[].items[].cost_currency *

string

Currency of the price per piece in ISO 4217 format (used for value declaration/insurance and/or payment upon receipt).
Example: RUB

changes[].items[].cost_value *

string

Price per piece in the currency set in cost_currency.
To insure the cost, pass the actual price of the cargo.

changes[].items[].droppof_point *

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[].items[].extra_id

string

Short unique ID of the item (the order number for a claim, usually identical to external_order_id)

changes[].items[].fiscalization

object

Information on fiscalization (relevant for payment upon receipt)

changes[].items[].fiscalization.article

string

Item SKU.
Must be unique for items handed over at the point.

changes[].items[].fiscalization.excise

string

Price Decimal(19, 4)

changes[].items[].fiscalization.item_type

string

Name type: Product or service.
By default, we believe that it's 'product'

Allowed values
  1. product
  2. service

changes[].items[].fiscalization.mark

object

Identifier of whether the product is labeled
The acceptable quantity value for a labeled product is 1

changes[].items[].fiscalization.mark.code *

string

The value of the product details in the kind format

changes[].items[].fiscalization.mark.kind *

string

Labeling type.
Acceptable values:

  1. compiled: Already disassembled label with identified GTIN and Serial.
    Example:
    • 444D00000000003741
  2. gs1_data_matrix_base64: Product code in the GS1 Data Matrix format, subject to labeling by means of identification.
    Maximum of 200 characters.
    The product code must be passed in its entirety by encoding the string in base64 format.

changes[].items[].fiscalization.supplier_inn

string

Supplier's INN (10 or 12 digits)

changes[].items[].fiscalization.vat_code_str

string

VAT rate.
vat_none: No VAT.
vat0: Zero VAT rate (applies in rare cases).
vat10: 10% VAT.
vat20: 20% VAT.

changes[].items[].pickup_point *

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[].items[].quantity *

integer

Quantity of the specified item (int64)

Minimum value: 1.

changes[].items[].size

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,
the courier has the right to refuse to carry out the order when they arrive at the point.
In this case, the pickup cost will be deducted.

Courier: up to 0.80 m × 0.50 m × 0.50 m
Express: up to 1.00 m × 0.60 m × 0.50 m
Cargo:

  • Small van: up to 1.70 m × 0.96 m × 0.90 m
  • Medium van: up to 2.60 m × 1.30 m × 1.50 m
  • Large van: up to 3.80 m × 1.80 m × 1.80 m

changes[].items[].size.height *

number

Size in meters

changes[].items[].size.length *

number

Size in meters

changes[].items[].size.width *

number

Size in meters

changes[].items[].title *

string

Name of item unit

changes[].items[].weight

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
for the maximum dimensions accepted for the service class.

If the actual characteristics of the shipment exceed those allowed,
the courier has the right to refuse to carry out the order when they arrive at the point.
In this case, the pickup cost will be deducted.

Courier: Up to 10 kg
Express: Up to 20 kg
Cargo:

  • Small van: Up to 300 kg
  • Medium van: Up to 700 kg
  • Large van: Up to 1400 kg

changes[].kind *

string

Change type (change_items)

Allowed values
  1. change_items

changes[].pickup_point_id *

integer

ID (int64) of the pickup point where we're changing the list of items

changes[].comment *

string

New comment at the point

changes[].kind *

string

Change type (change_comment)

Allowed values
  1. change_comment

changes[].point_id *

integer

ID (int64) of the point where we're changing the comment

changes[].contact *

object

changes[].contact.email

string

Email — required parameter for source and return points

changes[].contact.name *

string

Name of the contact person

changes[].contact.phone *

string

Contact phone number

changes[].contact.phone_additional_code

string

Extension number to call courier

changes[].kind *

string

Change type (change_contact)

Allowed values
  1. change_contact

changes[].point_id *

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)

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

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. max_apply_changes

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. max_apply_changes

message *

string

Human-readable error message

Code 404

Claim not found

{
  "code": string,
  "message": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. not_found

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. not_found

message *

string

Human-readable error message

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

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. old_version

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. old_version

message *

string

Human-readable error message

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