Status model

This section covers:

  • The stages that a delivery claim goes through during processing.

  • The API methods available at specific order stages that change the order status.

Order completion diagram

Order creation diagram

Status descriptions

Status

Description

Basic methods

new

A new claim has been created.

Create claim

estimating

Claim estimation is in progress: the system is searching for a vehicle type that meets the item parameters and calculating the delivery cost.

To find out the estimation results, call the Get claim information method.

Get claim information

ready_for_approval

The claim has been successfully estimated and is awaiting confirmation.

Confirm the claim within 10 minutes after it receives the ready_for_approval status.
If you don't agree with the delivery cost or terms, try changing the claim parameters. After editing, the claim is automatically sent for re-estimation.

Confirm claim

Edit claim

accepted

The claim has been confirmed.

If you don't confirm the claim within 10 minutes after it receives the ready_for_approval status, the claim confirmation returns the failed status. In this case, create a new claim.

Confirm claim

Create claim

performer_lookup

The claim has been confirmed: the system is creating a new order with the associated route_id. The system begins searching for a courier.

Get claim information

performer_draft

The system is searching for a courier that meets the claim requirements.

Get claim information

performer_found

A courier has been found and is currently on their way to the sender (stop A).

From this point and until the order is completed, you can request the following information:

  • Courier and vehicle information (performer_info field in the Get claim information method response).

  • The courier's phone number. If the courier is reassigned for whatever reason, request the new phone number.

  • Coordinates of the courier's current location.

Get claim information

Get courier's phone number

Get courier's point

pickup_arrived

The courier has arrived at stop A to pick up the order.

Get claim information

ready_for_pickup_confirmation

The courier is waiting for the sender to provide the confirmation code (this status is only applicable if skip_confirmation = false).

The code is generated automatically once the courier notifies the system that they've arrived at the sender's location. You can obtain the code from your account page, via SMS, or using the relevant API method.

Get confirmation code

pickuped

The courier is entering the confirmation code into the system. The handover of the items to the courier has been confirmed. The Get claim information method returns information about the courier's visit to the stop in the visit_status field.

Get claim information

delivery_arrived

The courier has arrived at the recipient's location (stop B).

The courier attempts to call the recipient. If the recipient doesn't pick up within 10 minutes, the items are returned to the sender.

ready_for_delivery_confirmation

The courier notifies the system that they are ready to hand the items over to the recipient. A confirmation code is automatically generated and sent to the recipient via SMS. The recipient must provide this code to the courier.

pay_waiting

The order is pending payment (this status is applicable if payment on delivery is selected in the order parameters).

delivered

The courier has entered the confirmation code into the system and handed the items over to the recipient. The delivery is confirmed.

If the order includes multiple stops, the courier heads to the next recipient.

delivered_finish

The order is completed: the courier has delivered the items to all recipients included in the order.

returning

If one of the recipients is unavailable, the courier returns the items intended for that recipient.

By default, items are returned to the pickup location (stop A), but you can set a different return address if needed.

return_arrived

The courier has arrived at the return location.

ready_for_return_confirmation

The courier is waiting for the sender to provide the confirmation code at the return location.

The code is generated automatically once the courier notifies the system that they've arrived at the return location. You can obtain this code from your account page, via SMS, or using the relevant API method.

Get confirmation code

returned

The courier has entered the confirmation code into the system and returned the items to the sender. The return is confirmed.

returned_finish

The order has been completed with a return.

Claim cancellation statuses

cancelled_by_taxi

The order was canceled by the courier. The courier can cancel the order if they haven't received the items from the sender yet (pickuped status).

cancelled

The order was canceled free of charge.

cancelled_with_payment

The order was canceled with a fee and a return.

cancelled_with_items_on_hands

The order was canceled with a fee and without a return (the claim was created with the optional_return flag).

Error statuses

failed

An error occurred while processing the order. Further execution is impossible.

estimating_failed

The claim couldn't be estimated. To find out why, call the Get claim information method: the reason is specified in the error_messages response field.

To try again, edit the claim by calling the Edit claim method.

performer_not_found

No couriers found. Try creating a new claim later.