Get claim information

Name

Description

created_ts*

Type: string<date-time>

Date and time of claim creation

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

id*

Type: string

Claim ID obtained at the claim creation stage

Example: 741cedf82cd464fa6fa16d87155c636

Min length: 32

Max length: 64

items*

Type: V2CargoItem[]

Item parameters

Min items: 1

revision*

Type: integer<int64>

Revision (int64)

Example: 1

route_points*

Type: V2ResponseCargoPoint[]

Route point information
Route point information

Min items: 2

status*

Type: ClaimStatus

Claim status. To learn more, see Status model

Example: new

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

version*

Type: integer<int64>

Version (int64)

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).

client_requirements

Type: ClientRequirements

Customer requirements specified when creating or editing a claim

comment

Type: string

General comment to the order

Example: Restaurant

Max length: 7000

corp_client_id

Type: string

Yango Delivery corporate client ID (from the OAuth token)

Example: cd8cc018bde34597932855e3cfdce927

Min length: 32

Max length: 32

current_point_id

Type: integer<int64>

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

Example: 372036854775807

due

Type: string<date-time>

Estimated time of arrival of the courier.
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

error_messages

Type: HumanErrorMessage[]

List of error messages
Error code and description

eta

Type: integer<int64>

Estimated order fulfillment time in minutes (int64)

Example: 10

matched_cars

Type: MatchedCar[]

Information about the selected rate

optional_return

Type: boolean

Disable item return in case of order cancellation.

Possible values:

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

performer_info

Type: PerformerInfo

Information about the executor

pricing

Type: ClaimPricing

Information about the order cost

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")

same_day_data

Type: SameDayData

Additional information for "Same-day delivery" claims

shipping_document

Type: string

Shipping documents

skip_act

Type: boolean

Don't show an acceptance certificate

skip_client_notify

Type: boolean

Don't send SMS notifications to the sender/recipient
when a courier is on their way.

Default value: false (send notifications)

skip_door_to_door

Type: boolean

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

skip_emergency_notify

Type: boolean

Don't send a notification to the emergency contact person

Default value: false (send notifications)

warnings

Type: ClaimWarning[]

Warnings during claim processing

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

address*

Type: CargoPointAddress

Point address

contact*

Type: ContactOnPoint

Information about the contact person

id*

Type: integer<int64>

Integer point ID (int64)

Example: 1

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)

Example: source

Enum: source, destination, return

visit_order*

Type: integer<int64>

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

Example: 1

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).

Example: pending

Enum: pending, arrived, visited, skipped

visited_at*

Type: PointVisitTime

Information about the point visit time

expected_visit_interval

Type: ExpectedVisitInterval

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

external_order_cost

Type: ExternalOrderCost

Cost of the external order linked to the point

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

no_door_call

Type: boolean

Don't ring the doorbell

payment_on_delivery

Type: ResponsePaymentOnDelivery

Parameters of payment upon receipt

pickup_code

Type: string

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)

Example: 893422

Min length: 6

Max length: 6

Pattern: \d{6}

return_comment

Type: string

Comments on the reasons for returning the cargo

return_reasons

Type: string[]

Reasons for returning the cargo

skip_confirmation

Type: boolean

Skip SMS confirmation at the given point

Default value: false (confirmation required).

Type

Description

ClaimStatus

Example: new

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

Name

Description

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.

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

Pattern: ^https?:.*

Name

Description

taxi_class*

Type: string

Delivery rate. Possible values: courier, express, cargo

Example: express

cargo_loaders

Type: integer<int64>

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.

cargo_options

Type: string[]

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

Example: thermobag

cargo_type

Type: CargoType

Body type (size) for the cargo rate.
Possible values:
- van ("Small body")
- lcv_m ("Medium body")
- lcv_l ("Large body").

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

Example: lcv_m

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.

Name

Description

name*

Type: string

Name of the contact person

Example: Rick

phone*

Type: string

Phone number of the contact person

Example: +97142772222

Max length: 30

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

phone_additional_code

Type: string

Extension number to call the courier

Example: 602 17 500

Name

Description

code*

Type: string

Error code

Example: some_error

message*

Type: string

Error description

Example: Some error

Name

Description

taxi_class*

Type: string

Delivery rate. Possible values: courier, express, cargo

Example: express

cargo_loaders

Type: integer<int64>

Required number of loaders (int64)

cargo_type

Type: string

Body type

Example: lcv_m

cargo_type_int

Type: integer<int64>

Body type (int64)

Example: 2 is equal to "lcv_m"

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.

Name

Description

courier_name*

Type: string

Name of the courier who is delivering a parcel

Example: Mark Smith

legal_name*

Type: string

Data on the legal entity that performs the delivery

Example: Individual entrepreneur Mark Smith

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

transport_type

Type: string

Type of courier transport

Example: car

Name

Description

currency

Type: string

Three-digit code of the payment currency

Example: AED

currency_rules

Type: CurrencyRules

Currency display rules

final_price

Type: string

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

Example: 12.50

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

final_pricing_calc_id

Type: string

Cost calculation ID

offer

Type: TaxiOffer

Offer from Yango Delivery (valid for some time).

Name

Description

delivery_interval*

Type: object

Parcel pick-up and delivery interval

Name

Description

code*

Type: string

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 maps.
• address_too_far: the coordinates from maps the specified address are far from the transmitted coordinates.

Example: not_fit_in_car

source*

Type: string

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

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

Name

Description

fullname*

Type: string

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: One Central Building 5, Trade Center Second, Dubai

building

Type: string

Building

Example: building number

building_name

Type: string

Apartment building name

Example: Dubai

city

Type: string

City

Example: Dubai

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 Yango 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".

Example: The intercom doesn't work

Max length: 7000

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.

Max items: 2

Min items: 2

country

Type: string

Country

Example: UAE

description

Type: string

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

Example: Yango Dubai Office, One Central Building 5, Trade Center Second, Dubai

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

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: One Central Building 5, Trade Center Second

street

Type: string

Street

Example: Trade Center Second

uri

Type: string

URI of the geo object on maps

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

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

Type

Description

PointType

Example: source

Enum: source, destination, return

Type

Description

PointVisitStatus

Example: pending

Enum: pending, arrived, visited, skipped

Name

Description

actual

Type: string<date-time>

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

expected

Type: string<date-time>

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

expected_waiting_time_sec

Type: integer<int64>

Estimated waiting time at the point. (int64)

Name

Description

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

Name

Description

currency*

Type: string

Currency

Example: AED

currency_sign*

Type: string

Currency symbol

Example: currency sign (if exists)

value*

Type: string

Cost

Example: 100.0

Name

Description

is_paid*

Type: boolean

Order payment indication

client_order_id

Type: string

customer order's external ID

Example: 100

customer

Type: CustomerFiscalization

Information about the customer (recipient)

invoice_link

Type: string

Invoice link

Example: url

payment_method

Type: PaymentMethod

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

Enum: card, cash

payment_ref_id

Type: string<uuid>

Payment ID

Type

Description

CargoType

Example: lcv_m

Enum: van, lcv_m, lcv_l, lcv_xl

Name

Description

code*

Type: string

Three-digit code of the payment currency

Example: AED

Min length: 3

Max length: 3

template*

Type: string

Currency display template

Example: $VALUE$ $SIGN$$CURRENCY$

text*

Type: string

Short currency name

Example: AED

sign

Type: string

Currency symbol

Example: ₽

Name

Description

offer_id*

Type: string

Offer ID

Example: 28ae5f1d72364468be3f5e26cd6a66bf

price*

Type: string

Offer price without VAT

Example: 12.50

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

price_with_vat

Type: string

Delivery cost in Decimal(18, 4) format

Example: 12.50

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

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

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

Name

Description

email

Type: string

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

Example: customer-BryanBurns@yango.com

full_name

Type: string

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

Example: Morty

inn

Type: string

User's ITN (10 or 12 digits)

Example: 3664069397

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

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: +97142774444

Type

Description

PaymentMethod

Enum: card, cash

Name

Description

code*

Type: string

Error code

Example: bad_request

Enum: bad_request

message*

Type: string

Error description

Example: Incorrect request body

Name

Description

code*

Type: string

Error code

Example: not_found

Enum: not_found

message*

Type: string

Error description

Example: Claim not found

Name

Description

code*

Type: string

Error code

Example: too_many_requests

Enum: too_many_requests

message*

Type: string

Error description

Example: Too many requests