Client widget

Description

A client widget shows delivery information for a specific order.

A widget link like https://yandex.ru/courier/tracking/<tracking ID> is unique for each order.

You can obtain it by sending a GET request to the following resources:

In the Track & Trace interface, you can find a widget link on the order card:

  1. Select Track & TraceOrders and go to the order list.
  2. Open the order card.
  3. At the top of the card, double-click the order number.

  4. You'll see the Get a link button at the bottom of the card. Click it.
  5. The button will be replaced with the link. Copy the URL and send it to the customer in any convenient way.

The order is en route

A customer gets a widget link in an SMS with information about order delivery if the Send SMS to customers option is enabled in the company settings (see Set up SMS notifications for customers). They can open the link both on a mobile device and PC.

The widget shows the courier expected arrival time. While the order is en route, the estimated arrival time may change. The widget also shows the order and recipient data and the approximate location of the car delivering the order.



1. estimated_delivery_time

The ETA value rounded to the nearest 30-minute interval.

2. shift_start

The time of route start from the depot. For more information about notifying customers about the route start, see Set up SMS notifications.

The order is delivered

The delivered order widget displays the order and recipient data and the tracking history with significant route points.



1. status

The current order status. For more information, see Gets order info.

2. number

Order number. Used for syncing with the delivery company's system.

Set in the scheduling file or via the API.

3. time_interval

The desired order delivery window.

Set in the scheduling file or via the API.
4. address

Delivery address in text format.

Set in the scheduling file or via the API.

5. customer_name

Recipient's name.

Set in the scheduling file or via the API.

Widget customization

You cannot customize the client widget using the service tools.

If you need to implement your own widget version on your website, in a customer's personal dashboard, or in your mobile app, get information for a custom widget via the API.

To display the map on the website, use the Yandex Maps API, and to show it in the mobile app, use the MapKit.

Contact support