Claim search

claims

Type: V2ClaimInfo[]

List of found claims

[
  {
    "id": "741cedf82cd464fa6fa16d87155c636",
    "corp_client_id": "cd8cc018bde34597932855e3cfdce927",
    "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": "RUB",
        "quantity": 1,
        "fiscalization": {
          "excise": "12.50",
          "vat_code_str": "vat_none",
          "supplier_inn": "3664069397",
          "article": "20ML50OWKY4FC86",
          "mark": {},
          "item_type": "product"
        }
      }
    ],
    "route_points": [
      {
        "id": 1,
        "contact": {
          "name": "Rick",
          "phone": "+79123456789",
          "phone_additional_code": "602 17 500",
          "email": "example@yandex.ru"
        },
        "address": {
          "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A",
          "shortname": "Bol'shaya Monetnaya Street, 1f1A",
          "coordinates": [
            null,
            null
          ],
          "country": "Russia",
          "city": "Saint Petersburg",
          "building_name": "BC of Bol'shaya Monetnaya",
          "street": "Bol'shaya Monetnaya street",
          "building": "23f1A",
          "porch": "A",
          "floor": 1,
          "flat": 1,
          "sfloor": "1",
          "sflat": "1",
          "door_code": "169",
          "door_code_extra": "courtyard entrance code #1234, apartment code #4321",
          "doorbell_name": "Magidovich",
          "comment": "The intercom doesn't work",
          "uri": "ymapsbm1://geo?ll=38.805%2C55.084",
          "description": "Saint Petersburg, Russia"
        },
        "type": "source",
        "visit_order": 1,
        "visit_status": "pending",
        "skip_confirmation": false,
        "leave_under_door": true,
        "meet_outside": true,
        "no_door_call": true,
        "modifier_age_check": true,
        "payment_on_delivery": {
          "payment_ref_id": "123e4567-e89b-12d3-a456-426614174000",
          "client_order_id": "100",
          "is_paid": false,
          "customer": {},
          "payment_method": "card",
          "invoice_link": "https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024"
        },
        "external_order_id": "100",
        "external_order_cost": {
          "value": "100.0",
          "currency": "RUB",
          "currency_sign": "₽"
        },
        "expected_visit_interval": {
          "from": "2020-01-01T00:00:00+00:00",
          "to": "2020-01-02T00:00:00+00:00"
        },
        "pickup_code": "893422",
        "return_reasons": [
          "example"
        ],
        "return_comment": "example",
        "performer_cancel_reason": "example",
        "visited_at": {
          "expected": "2025-01-01T00:00:00Z",
          "expected_waiting_time_sec": 0,
          "actual": "2025-01-01T00:00:00Z"
        }
      },
      {
        "id": 1,
        "contact": {
          "name": "Rick",
          "phone": "+79123456789",
          "phone_additional_code": "602 17 500",
          "email": "example@yandex.ru"
        },
        "address": {
          "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A",
          "shortname": "Bol'shaya Monetnaya Street, 1f1A",
          "coordinates": [
            null,
            null
          ],
          "country": "Russia",
          "city": "Saint Petersburg",
          "building_name": "BC of Bol'shaya Monetnaya",
          "street": "Bol'shaya Monetnaya street",
          "building": "23f1A",
          "porch": "A",
          "floor": 1,
          "flat": 1,
          "sfloor": "1",
          "sflat": "1",
          "door_code": "169",
          "door_code_extra": "courtyard entrance code #1234, apartment code #4321",
          "doorbell_name": "Magidovich",
          "comment": "The intercom doesn't work",
          "uri": "ymapsbm1://geo?ll=38.805%2C55.084",
          "description": "Saint Petersburg, Russia"
        },
        "type": "source",
        "visit_order": 1,
        "visit_status": "pending",
        "skip_confirmation": false,
        "leave_under_door": true,
        "meet_outside": true,
        "no_door_call": true,
        "modifier_age_check": true,
        "payment_on_delivery": {
          "payment_ref_id": "123e4567-e89b-12d3-a456-426614174000",
          "client_order_id": "100",
          "is_paid": false,
          "customer": {},
          "payment_method": "card",
          "invoice_link": "https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024"
        },
        "external_order_id": "100",
        "external_order_cost": {
          "value": "100.0",
          "currency": "RUB",
          "currency_sign": "₽"
        },
        "expected_visit_interval": {
          "from": "2020-01-01T00:00:00+00:00",
          "to": "2020-01-02T00:00:00+00:00"
        },
        "pickup_code": "893422",
        "return_reasons": [
          "example"
        ],
        "return_comment": "example",
        "performer_cancel_reason": "example",
        "visited_at": {
          "expected": "2025-01-01T00:00:00Z",
          "expected_waiting_time_sec": 0,
          "actual": "2025-01-01T00:00:00Z"
        }
      }
    ],
    "current_point_id": 372036854775807,
    "status": "new",
    "version": 0,
    "user_request_revision": "example",
    "error_messages": [
      {
        "code": "some_error",
        "message": "Some error"
      }
    ],
    "emergency_contact": {
      "name": "Rick",
      "phone": "+79826810246",
      "phone_additional_code": "602 17 500"
    },
    "skip_door_to_door": false,
    "skip_client_notify": false,
    "skip_emergency_notify": false,
    "skip_act": false,
    "optional_return": false,
    "eta": 10,
    "created_ts": "2020-01-01T00:00:00+00:00",
    "updated_ts": "2020-01-01T00:00:00+00:00",
    "taxi_offer": {
      "offer_id": "28ae5f1d72364468be3f5e26cd6a66bf",
      "price_raw": 12,
      "price": null
    },
    "pricing": {
      "offer": {
        "offer_id": null,
        "price_raw": 12,
        "price": null,
        "valid_until": "2020-01-01T00:00:00+00:00",
        "price_with_vat": null
      },
      "currency": "RUB",
      "currency_rules": {
        "code": null,
        "text": "rub.",
        "template": "$VALUE$ $SIGN$$CURRENCY$",
        "sign": "₽"
      },
      "final_pricing_calc_id": "example",
      "final_price": null
    },
    "available_cancel_state": "free",
    "client_requirements": {
      "taxi_class": "express",
      "taxi_classes": [
        "express"
      ],
      "cargo_type": "lcv_m",
      "cargo_loaders": 0,
      "cargo_options": [
        "thermobag"
      ],
      "pro_courier": false,
      "assign_robot": true
    },
    "matched_cars": [
      {
        "taxi_class": "express",
        "client_taxi_class": "cargo",
        "cargo_type": "lcv_m",
        "cargo_type_int": "2 is equal to \"lcv_m\"",
        "cargo_loaders": 0,
        "door_to_door": false,
        "pro_courier": false
      }
    ],
    "warnings": [
      {
        "source": "client_requirements",
        "code": "not_fit_in_car",
        "message": "warning"
      }
    ],
    "performer_info": {
      "courier_name": "Person",
      "legal_name": "Sole Trader Birdperson",
      "car_model": "Hyundai Solaris",
      "car_number": "Y100BJF",
      "car_color": "red",
      "car_color_hex": "FF00000",
      "transport_type": "car"
    },
    "callback_properties": {
      "callback_url": "https://www.example.com/"
    },
    "due": "2020-01-01T00:00:00+00:00",
    "shipping_document": "example",
    "comment": "Restaurant",
    "revision": 1,
    "route_id": "example",
    "same_day_data": {
      "delivery_interval": {
        "from": "2020-01-01T07:00:00+00:00",
        "to": "2020-01-01T07:00:00+00:00"
      }
    }
  }
]

cursor

Type: string

Cursor of the previous search page

Example: example

height

Type: number

Height in meters

length

Type: number

Length in meters

width

Type: number

Width in meters

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

article

Type: ItemArticle

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

Example: 20ML50OWKY4FC86

excise

Type: Money

Amount of excise tax

Delivery cost in Decimal(18, 4) format

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

Example: 12.50

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

{
  "kind": "gs1_data_matrix_base64",
  "code": "444D00000000003741"
}

supplier_inn

Type: SupplierInn

Supplier's ITN (10 or 12 digits).

Pattern: ^(\d{10}|\d{12})$

Example: 3664069397

vat_code_str

Type: VatCodeStrApi

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

Example: vat_none

cost_currency

Type: Currency

Three-digit code of the payment currency

Min length: 3

Max length: 3

Example: RUB

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

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

pickup_point

Type: integer

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

quantity

Type: integer

Number of units (int64)

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)

Max length: 512

Example: BP-208

fiscalization

Type: ItemFiscalization

Fiscalization information (valid for payment upon receipt)

{
  "excise": "12.50",
  "vat_code_str": "vat_none",
  "supplier_inn": "3664069397",
  "article": "20ML50OWKY4FC86",
  "mark": {
    "kind": "gs1_data_matrix_base64",
    "code": "444D00000000003741"
  },
  "item_type": "product"
}

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

{
  "length": 0.1,
  "width": 0.2,
  "height": 0.3
}

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

name

Type: string

Name of the contact person

Example: Rick

phone

Type: string

Phone number of the contact person

Max length: 30

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

Example: +79123456789

email

Type: string

Email is a mandatory parameter for source and return points

Max length: 320

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

Example: example@yandex.ru

phone_additional_code

Type: string

Extension number to call the courier

Example: 602 17 500

fullname

Type: AddressFullname

Full address with an indication of the city, street, and house number.
You don't need to specify the flat, the entrance number, or the floor.

Example: Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A

building

Type: string

Building

Example: 23f1A

building_name

Type: string

Apartment building name

Example: BC of Bol'shaya Monetnaya

city

Type: string

City

Example: Saint Petersburg

comment

Type: string

Comment for the courier.
For the dispatch point, use the template: "Delivery from store <>. Inform the manager that the order is for Yandex Delivery. Provide your order number <> and collect the parcel. The order was paid using cashless payment. So, there's no need to ask the recipient to pay for the delivery when handing over the order."
For delivery points, leave the recipient's wishes in the comments. For example, "the intercom doesn't work" / "the gate is closed, call 10 minutes in advance" / "don't call, the baby is asleep".

Max length: 7000

Example: The intercom doesn't work

coordinates

Type: number[]

Coordinates of points in the form of an array of two real numbers: longitude and latitude — exactly in that order.
Rounded coordinate values are specified.

Min items: 2

Max items: 2

[
  0.5,
  0.5
]

country

Type: string

Country

Example: Russia

description

Type: string

A geographic area that turns a short address into a global match

Example: Saint Petersburg, Russia

door_code

Type: string

Intercom code

Example: 169

door_code_extra

Type: string

Additional instructions for intercoms

Example: courtyard entrance code #1234, apartment code #4321

doorbell_name

Type: string

Name on the doorbell

Example: Magidovich

flat

Type: integer

Flat (DEPRECATED) (int64)

Max value: 2147483647

floor

Type: integer

Floor (DEPRECATED) (int64)

Max value: 2147483647

porch

Type: string

Entrance (may be A)

Example: A

sflat

Type: string

Flat

Example: 1

sfloor

Type: string

Floor

Example: 1

shortname

Type: string

Short address within the city (like on a Taximeter)

Example: Bol'shaya Monetnaya Street, 1f1A

street

Type: string

Street

Example: Bol'shaya Monetnaya street

uri

Type: string

URI of the geo object on maps

Example: ymapsbm1://geo?ll=38.805%2C55.084

email

Type: string

User's email address. If not specified, the recipient's email address from the destination point will be used

Example: example@yandex.ru

full_name

Type: string

For legal entities — organization name, for individual entrepreneurs and individuals — full name

Example: Morty

inn

Type: Inn

User's ITN (10 or 12 digits)

Pattern: ^(\d{10}|\d{12})$

Example: 3664069397

phone

Type: string

User's phone number in +X XXX XXX XX XX format. If not specified, the recipient's phone number from the destination point will be used

Example: +79123456789

is_paid

Type: PaymentComplete

Order payment indication

Example: false

client_order_id

Type: ClientOrderId

customer order's external ID

Example: 100

customer

Type: CustomerFiscalization

Information about the customer (recipient)

{
  "full_name": "Morty",
  "inn": "3664069397",
  "email": "example@yandex.ru",
  "phone": "+79123456789"
}

invoice_link

Type: InvoiceLink

Invoice link

Example: https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024

payment_method

Type: PaymentMethod

Selected payment method.
card — payment by card.
cash — cash payment (not yet available).

Enum: card, cash

payment_ref_id

Type: PaymentId

Payment ID

Example: 123e4567-e89b-12d3-a456-426614174000

currency

Type: string

Currency

Example: RUB

currency_sign

Type: string

Currency symbol

Example: ₽

value

Type: string

Cost

Example: 100.0

from

Type: string<date-time>

Interval start

Example: 2020-01-01T00:00:00+00:00

to

Type: string<date-time>

Interval end

Example: 2020-01-02T00:00:00+00:00

actual

Type: string<date-time>

Actual point visit time.
Filled in only for visited points.

Example: 2025-01-01T00:00:00Z

expected

Type: string<date-time>

Estimated time of arrival. Can be filled in only for unvisited points.

Example: 2025-01-01T00:00:00Z

expected_waiting_time_sec

Type: integer

Estimated waiting time at the point. (int64)

address

Type: CargoPointAddress

Point address

{
  "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A",
  "shortname": "Bol'shaya Monetnaya Street, 1f1A",
  "coordinates": [
    0.5,
    0.5
  ],
  "country": "Russia",
  "city": "Saint Petersburg",
  "building_name": "BC of Bol'shaya Monetnaya",
  "street": "Bol'shaya Monetnaya street",
  "building": "23f1A",
  "porch": "A",
  "floor": 1,
  "flat": 1,
  "sfloor": "1",
  "sflat": "1",
  "door_code": "169",
  "door_code_extra": "courtyard entrance code #1234, apartment code #4321",
  "doorbell_name": "Magidovich",
  "comment": "The intercom doesn't work",
  "uri": "ymapsbm1://geo?ll=38.805%2C55.084",
  "description": "Saint Petersburg, Russia"
}

contact

Type: ContactOnPoint

Information about the contact person

{
  "name": "Rick",
  "phone": "+79123456789",
  "phone_additional_code": "602 17 500",
  "email": "example@yandex.ru"
}

id

Type: integer

Integer point ID (int64)

type

Type: PointType

Point type:

• source: the point of departure where the courier picks up the item
• destination: destination points where the courier delivers the items
• return: item return point (added automatically and matches the point of departure by default, but a different point can also be selected)

Enum: source, destination, return

visit_order

Type: integer

The order in which the points are visited (numbering starts with 1) (int64)

visit_status

Type: PointVisitStatus

Point visit status:

• pending — not yet visited.
• arrived — the courier arrived at the point.
• visited — the courier handed over/picked up the cargo at the point.
• skipped — skipped (if the item wasn't accepted).

Enum: pending, arrived, visited, skipped

visited_at

Type: PointVisitTime

Information about the point visit time

{
  "expected": "2025-01-01T00:00:00Z",
  "expected_waiting_time_sec": 0,
  "actual": "2025-01-01T00:00:00Z"
}

expected_visit_interval

Type: ExpectedVisitInterval

Time interval of the courier's visit to the point according to the selected offer

{
  "from": "2020-01-01T00:00:00+00:00",
  "to": "2020-01-02T00:00:00+00:00"
}

external_order_cost

Type: ExternalOrderCost

Cost of the external order linked to the point

{
  "value": "100.0",
  "currency": "RUB",
  "currency_sign": "₽"
}

external_order_id

Type: string

Order number from the customer's system.
Entered for destination points

Example: 100

leave_under_door

Type: boolean

Leave the parcel at the door

meet_outside

Type: boolean

The courier will be met outside, at the entrance

modifier_age_check

Type: boolean

Check documents for the purchase of alcohol/tobacco products

no_door_call

Type: boolean

Don't ring the doorbell

payment_on_delivery

Type: ResponsePaymentOnDelivery

Parameters of payment upon receipt

{
  "payment_ref_id": "123e4567-e89b-12d3-a456-426614174000",
  "client_order_id": "100",
  "is_paid": false,
  "customer": {
    "full_name": "Morty",
    "inn": "3664069397",
    "email": "example@yandex.ru",
    "phone": "+79123456789"
  },
  "payment_method": "card",
  "invoice_link": "https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024"
}

performer_cancel_reason

Type: string

Reason for canceling the order

Example: example

pickup_code

Type: PickupCode

Parcel pick-up code.
The courier needs to enter this code to confirm that they have picked up the parcel.
This requires your employees to be at the point of dispatch to provide this code to the courier.
Relevant for source points.
Code format: 6 digits
|
Item pick-up code (pick-up point)

Min length: 6

Max length: 6

Pattern: \d{6}

Example: 893422

return_comment

Type: string

Comments on the reasons for returning the cargo

Example: example

return_reasons

Type: string[]

Reasons for returning the cargo

[
  "example"
]

skip_confirmation

Type: CargoPointSkipConfirmation

Skip SMS confirmation at the given point
Default value: false (confirmation required).

Default: false

Example: false

code

Type: string

Error code

Example: some_error

message

Type: string

Error description

Example: Some error

name

Type: string

Name of the contact person

Example: Rick

phone

Type: string

Phone number of the contact person

Max length: 30

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

Example: +79826810246

phone_additional_code

Type: string

Extension number to call the courier

Example: 602 17 500

offer_id

Type: TaxiOfferId

Offer ID

Example: 28ae5f1d72364468be3f5e26cd6a66bf

price

Type: Money

decimal offer price

Delivery cost in Decimal(18, 4) format

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

Example: 12.50

price_raw

Type: integer

(deprecated) Offer price in the currency specified in the contract (int64)

offer_id

Type: TaxiOfferId

Offer ID

Example: 28ae5f1d72364468be3f5e26cd6a66bf

price

Type: Money

Offer price without VAT

Delivery cost in Decimal(18, 4) format

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

Example: 12.50

price_raw

Type: integer

(deprecated) Offer price in the currency specified (int64) in the contract

price_with_vat

Type: Money

Delivery cost in Decimal(18, 4) format

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

Example: 12.50

valid_until

Type: string<date-time>

Time until which the offer to accept the claim is valid. If there is no value, there are no limits on the offer duration

Example: 2020-01-01T00:00:00+00:00

code

Type: Currency

Three-digit code of the payment currency

Min length: 3

Max length: 3

Example: RUB

template

Type: string

Currency display template

Example: $VALUE$ $SIGN$$CURRENCY$

text

Type: string

Short currency name

Example: rub.

sign

Type: string

Currency symbol

Example: ₽

currency

Type: string

Three-digit code of the payment currency

Example: RUB

currency_rules

Type: CurrencyRules

Currency display rules

{
  "code": "RUB",
  "text": "rub.",
  "template": "$VALUE$ $SIGN$$CURRENCY$",
  "sign": "₽"
}

final_price

Type: Money

Final delivery price, including VAT.
Filled in after the delivery/return is completed.

Delivery cost in Decimal(18, 4) format

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

Example: 12.50

final_pricing_calc_id

Type: string

Cost calculation ID

Example: example

offer

Type: TaxiOffer

Offer from Yandex Delivery (valid for some time).

{
  "offer_id": "28ae5f1d72364468be3f5e26cd6a66bf",
  "price_raw": 12,
  "price": "12.50",
  "valid_until": "2020-01-01T00:00:00+00:00",
  "price_with_vat": null
}

taxi_class

Type: string

Delivery rate. Possible values: courier, express, cargo

Example: express

assign_robot

Type: boolean

Allow the order to be fulfilled by rover (six-wheeled robot)

cargo_loaders

Type: integer

Number of loaders for the cargo rate.
Possible values: 0, 1, 2.
For an exact list of possible values for a particular point, use the method for obtaining rates tariffs.

Min value: 0

cargo_options

Type: CargoOptions

List of additional rate options.

Possible separate options:

• auto_courier (a courier with a vehicle only)
• thermobag (a courier with a thermobag)

Example of a list of options: ["auto_courier"].

For an exact list of possible values for a particular geo point,
use the method for obtaining rates tariffs

[
  "thermobag"
]

cargo_type

Type: CargoType

Body type (size) for the cargo rate.\nPossible values:

• van ("Small body")
• lcv_m ("Medium body")
• lcv_l ("Large body")
• lcv_xl ("XL body")
  For an exact list of possible values for a particular geo point,\nuse the method for obtaining rates tariffs

Enum: van, lcv_m, lcv_l, lcv_xl

pro_courier

Type: boolean

Enable the "Pro" option for "Express" and "Courier" rates.
In this case, we will look only for experienced couriers.

taxi_classes

Type: string[]

Taxi service classes. These classes must be used, without additional checks

Min items: 1

[
  "express"
]

taxi_class

Type: string

Delivery rate. Possible values: courier, express, cargo

Example: express

cargo_loaders

Type: integer

Required number of loaders (int64)

Min value: 0

cargo_type

Type: string

Body type

Example: lcv_m

cargo_type_int

Type: integer

Body type (int64)

client_taxi_class

Type: string

Customer rate

Example: cargo

door_to_door

Type: boolean

The "door-to-door" option for the "Express" rate

pro_courier

Type: boolean

Enable the "Pro" option for "Express" and "Courier" rates.
In this case, we will look only for experienced couriers.

code

Type: ClaimWarningCodeApi

Warning type:

• not_fit_in_car: the cargo may not fit in the vehicle.
• requirement_unavailable: the specified requirement isn't available and has been ignored.
• address_not_found - the specified address wasn't found in Yandex Maps.
• address_too_far: the coordinates from Yandex Maps the specified address are far from the transmitted coordinates.

Example: not_fit_in_car

source

Type: ClaimWarningSourceApi

Warning source:

• client_requirements — the warning is related to customer requirements.
• route_points — the warning is related
  to the transmitted addresses.

Example: client_requirements

message

Type: string

Warning description

Example: warning

courier_name

Type: string

Name of the courier who is delivering a parcel

Example: Person

legal_name

Type: string

Data on the legal entity that performs the delivery

Example: Sole Trader Birdperson

car_color

Type: string

Vehicle color

Example: red

car_color_hex

Type: string

RGB code of the vehicle color

Example: FF00000

car_model

Type: string

Vehicle model

Example: Hyundai Solaris

car_number

Type: string

License plate number of the vehicle

Example: Y100BJF

transport_type

Type: string

Type of courier transport

Example: car

callback_url

Type: string

The URL used in the case of a status change for the claim.
This mechanism is deprecated, use the claims/journal operation instead.

Pattern: ^https?:.*

Example: https://www.example.com/

delivery_interval

Parcel pick-up and delivery interval

{
  "from": "2020-01-01T07:00:00+00:00",
  "to": "2020-01-01T07:00:00+00:00"
}

created_ts

Type: string<date-time>

Date and time of claim creation

Example: 2020-01-01T00:00:00+00:00

id

Type: ClaimId

Claim ID obtained at the claim creation stage

Min length: 32

Max length: 64

Example: 741cedf82cd464fa6fa16d87155c636

items

Type: V2CargoItem[]

Item parameters

Min items: 1

[
  {
    "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": "RUB",
    "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"
    }
  }
]

revision

Type: integer

Revision (int64)

route_points

Type: V2ResponseCargoRoutePoints

Route point information

Min items: 2

[
  {
    "id": 1,
    "contact": {
      "name": "Rick",
      "phone": "+79123456789",
      "phone_additional_code": "602 17 500",
      "email": "example@yandex.ru"
    },
    "address": {
      "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A",
      "shortname": "Bol'shaya Monetnaya Street, 1f1A",
      "coordinates": [
        0.5,
        0.5
      ],
      "country": "Russia",
      "city": "Saint Petersburg",
      "building_name": "BC of Bol'shaya Monetnaya",
      "street": "Bol'shaya Monetnaya street",
      "building": "23f1A",
      "porch": "A",
      "floor": 1,
      "flat": 1,
      "sfloor": "1",
      "sflat": "1",
      "door_code": "169",
      "door_code_extra": "courtyard entrance code #1234, apartment code #4321",
      "doorbell_name": "Magidovich",
      "comment": "The intercom doesn't work",
      "uri": "ymapsbm1://geo?ll=38.805%2C55.084",
      "description": "Saint Petersburg, Russia"
    },
    "type": "source",
    "visit_order": 1,
    "visit_status": "pending",
    "skip_confirmation": false,
    "leave_under_door": true,
    "meet_outside": true,
    "no_door_call": true,
    "modifier_age_check": true,
    "payment_on_delivery": {
      "payment_ref_id": "123e4567-e89b-12d3-a456-426614174000",
      "client_order_id": "100",
      "is_paid": false,
      "customer": {
        "full_name": "Morty",
        "inn": "3664069397",
        "email": "example@yandex.ru",
        "phone": "+79123456789"
      },
      "payment_method": "card",
      "invoice_link": "https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024"
    },
    "external_order_id": "100",
    "external_order_cost": {
      "value": "100.0",
      "currency": "RUB",
      "currency_sign": "₽"
    },
    "expected_visit_interval": {
      "from": "2020-01-01T00:00:00+00:00",
      "to": "2020-01-02T00:00:00+00:00"
    },
    "pickup_code": "893422",
    "return_reasons": [
      "example"
    ],
    "return_comment": "example",
    "performer_cancel_reason": "example",
    "visited_at": {
      "expected": "2025-01-01T00:00:00Z",
      "expected_waiting_time_sec": 0,
      "actual": "2025-01-01T00:00:00Z"
    }
  },
  {
    "id": 1,
    "contact": {
      "name": "Rick",
      "phone": "+79123456789",
      "phone_additional_code": "602 17 500",
      "email": "example@yandex.ru"
    },
    "address": {
      "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A",
      "shortname": "Bol'shaya Monetnaya Street, 1f1A",
      "coordinates": [
        0.5,
        0.5
      ],
      "country": "Russia",
      "city": "Saint Petersburg",
      "building_name": "BC of Bol'shaya Monetnaya",
      "street": "Bol'shaya Monetnaya street",
      "building": "23f1A",
      "porch": "A",
      "floor": 1,
      "flat": 1,
      "sfloor": "1",
      "sflat": "1",
      "door_code": "169",
      "door_code_extra": "courtyard entrance code #1234, apartment code #4321",
      "doorbell_name": "Magidovich",
      "comment": "The intercom doesn't work",
      "uri": "ymapsbm1://geo?ll=38.805%2C55.084",
      "description": "Saint Petersburg, Russia"
    },
    "type": "source",
    "visit_order": 1,
    "visit_status": "pending",
    "skip_confirmation": false,
    "leave_under_door": true,
    "meet_outside": true,
    "no_door_call": true,
    "modifier_age_check": true,
    "payment_on_delivery": {
      "payment_ref_id": "123e4567-e89b-12d3-a456-426614174000",
      "client_order_id": "100",
      "is_paid": false,
      "customer": {
        "full_name": "Morty",
        "inn": "3664069397",
        "email": "example@yandex.ru",
        "phone": "+79123456789"
      },
      "payment_method": "card",
      "invoice_link": "https://ofd.yandex.ru/vaucher/0005312316002718/9410/2604520024"
    },
    "external_order_id": "100",
    "external_order_cost": {
      "value": "100.0",
      "currency": "RUB",
      "currency_sign": "₽"
    },
    "expected_visit_interval": {
      "from": "2020-01-01T00:00:00+00:00",
      "to": "2020-01-02T00:00:00+00:00"
    },
    "pickup_code": "893422",
    "return_reasons": [
      "example"
    ],
    "return_comment": "example",
    "performer_cancel_reason": "example",
    "visited_at": {
      "expected": "2025-01-01T00:00:00Z",
      "expected_waiting_time_sec": 0,
      "actual": "2025-01-01T00:00:00Z"
    }
  }
]

status

Type: ClaimStatus

Claim status. To learn more, see Status model

Enum: new, estimating, estimating_failed, ready_for_approval, accepted, performer_lookup, performer_draft, performer_found, performer_not_found, pickup_arrived, ready_for_pickup_confirmation, pickuped, delivery_arrived, ready_for_delivery_confirmation, delivered, delivered_finish, returning, return_arrived, ready_for_return_confirmation, returned, returned_finish, failed, cancelled, cancelled_with_payment, cancelled_by_taxi, cancelled_with_items_on_hands

updated_ts

Type: string<date-time>

Date and time of the last claim update

Example: 2020-01-01T00:00:00+00:00

user_request_revision

Type: string

The current version of changes in the claim entered by the user

Example: example

version

Type: integer

Version (int64)

available_cancel_state

Type: AvailableCancelState

(deprecated) Indication of the paid/free cancellation option.
The mechanism is deprecated, use the cancel_state field of the method claim/cancel-info

Enum: free, paid

callback_properties

Type: CallbackProperties

Parameters for notifying the client's server about the claim status change.
A notification is a POST request to the specified URL to which information about the date of the last claim change and claim ID in the format
'updated_ts=&claim_id=' will be added. Which means that this URL
'https://example.com/?my_order_id=123&' format will be expanded into
'https://example.com/?my_order_id=123&updated_ts=...&claim_id=...'.
Note that parameters are added by concatenation to callback_url, which means that the URL such as 'https://example.com' will turn into this invalid format: 'https://example.comupdated_ts=...&claim_id=...'.
Only HTTP and HTTPS are supported. In the case of HTTPS, an SSL certificate must be issued by a certification authority known to the server.
Notifications should be viewed as a push ahead of polling, a way of speeding up information on status changes. The server expects the 200 response, and if there are timeouts or any other response, it will attempt to deliver the notification and then stop the attempts.
So in order to reliably obtain the claim status, the client needs to request information using the method claims/info.
The client should note that the response of the claims/info operation may contain an older claim state (the value of the updated_ts field should be used as a reference). In this case, the operation call must be repeated after some time (from 5 to 30 seconds).

{
  "callback_url": "https://www.example.com/"
}

client_requirements

Type: ClientRequirements

Customer requirements specified when creating or editing a claim

{
  "taxi_class": "express",
  "taxi_classes": [
    "express"
  ],
  "cargo_type": "lcv_m",
  "cargo_loaders": 0,
  "cargo_options": [
    "thermobag"
  ],
  "pro_courier": false,
  "assign_robot": true
}

comment

Type: string

General comment to the order

Max length: 7000

Example: Restaurant

corp_client_id

Type: CorpClientId

Yandex Delivery corporate client ID (from the OAuth token)

Min length: 32

Max length: 32

Example: cd8cc018bde34597932855e3cfdce927

current_point_id

Type: ClaimPointId

Integer point ID (int64) generated on the Yandex Delivery side.
It is in the route_points[].id field. Applicable to source, destination, and return points.

Example: 372036854775807

due

Type: Due

Estimated time of arrival of the courier. (In Russia, you can postpone the estimated time of arrival by 30-60 minutes from the current moment).
If this parameter isn''t specified, we will look for a courier as soon as possible.

Example: 2020-01-01T00:00:00+00:00

emergency_contact

Type: ContactWithPhone

Information about the contact person with a phone number

{
  "name": "Rick",
  "phone": "+79826810246",
  "phone_additional_code": "602 17 500"
}

error_messages

Type: HumanErrorMessage[]

List of error messages

[
  {
    "code": "some_error",
    "message": "Some error"
  }
]

eta

Type: Eta

Estimated order fulfillment time in minutes (int64)

Example: 10

matched_cars

Type: MatchedCar[]

Information about the selected rate

[
  {
    "taxi_class": "express",
    "client_taxi_class": "cargo",
    "cargo_type": "lcv_m",
    "cargo_type_int": "2 is equal to \"lcv_m\"",
    "cargo_loaders": 0,
    "door_to_door": false,
    "pro_courier": false
  }
]

optional_return

Type: OptionalReturn

Disable item return in case of order cancellation.

Possible values:

• true (the courier keeps the item)
• false (by default, the item must be returned)

Default: false

Example: false

performer_info

Type: PerformerInfo

Information about the executor

Information about the courier

{
  "courier_name": "Person",
  "legal_name": "Sole Trader Birdperson",
  "car_model": "Hyundai Solaris",
  "car_number": "Y100BJF",
  "car_color": "red",
  "car_color_hex": "FF00000",
  "transport_type": "car"
}

pricing

Type: ClaimPricing

Information about the order cost

{
  "offer": {
    "offer_id": "28ae5f1d72364468be3f5e26cd6a66bf",
    "price_raw": 12,
    "price": "12.50",
    "valid_until": "2020-01-01T00:00:00+00:00",
    "price_with_vat": null
  },
  "currency": "RUB",
  "currency_rules": {
    "code": "RUB",
    "text": "rub.",
    "template": "$VALUE$ $SIGN$$CURRENCY$",
    "sign": "₽"
  },
  "final_pricing_calc_id": "example",
  "final_price": null
}

route_id

Type: string

ID of the route within which the order is delivered
If multiple orders are delivered by one courier, all of them will have the same route_id (Relevant only for the "Same-day delivery")

Example: example

same_day_data

Type: SameDayData

Additional information for Same-day delivery claims. The option is unavailable in Russia.

{
  "delivery_interval": {
    "from": "2020-01-01T07:00:00+00:00",
    "to": "2020-01-01T07:00:00+00:00"
  }
}

shipping_document

Type: string

Shipping documents

Example: example

skip_act

Type: SkipAct

Don't show an acceptance certificate

Example: false

skip_client_notify

Type: SkipClientNotify

Don't send SMS notifications to the sender/recipient when a courier is on their way.
Default value: false (send notifications)

Default: false

Example: false

skip_door_to_door

Type: SkipDoorToDoor

Disable door-to-door delivery (disable the "Door-to-door" option).

Possible values:

• true (the courier will deliver the order only at the entrance outside)
• false (the courier will deliver the order to the door) - default value

Default: false

Example: false

skip_emergency_notify

Type: SkipEmergencyNotify

Don't send a notification to the emergency contact person
Default value: false (send notifications)

Default: false

Example: false

taxi_offer

Type: TaxiOfferDeprecated

Offer from Taxi (valid for some time). This mechanism is deprecated, use pricing.offer

{
  "offer_id": "28ae5f1d72364468be3f5e26cd6a66bf",
  "price_raw": 12,
  "price": "12.50"
}

warnings

Type: ClaimWarning[]

Warnings during claim processing

[
  {
    "source": "client_requirements",
    "code": "not_fit_in_car",
    "message": "warning"
  }
]

code

Type: string

Error code

Const: validation_error

Example: validation_error

message

Type: string

The person understood the error message

Example: Validation error

code

Type: string

Error code

Const: too_many_requests

Example: too_many_requests

message

Type: string

Error description

Example: Too many requests