Checklist for implementing the API

Implementing an API is a complex process that involves a lot of people. For easy implementation, use the following checklist:

1. You have the company ID. The company ID is a number, such as 410.

2. You have a Yandex ID username.

3. You can access Routing workspace with this username.

4. You have an OAuth token for your app obtained using the same username.

5. You have created at least one depot through Routing workspace or API. You can find created depots by going to Settings → Depots in Routing workspace.

6. You have set up courier data export using the API. If couriers change often, data should be exported on a regular basis. If they don't, exporting data just once is fine. You can check courier data in the Couriers section in Routing workspace.

7. You have configured regular route generation for the day and assignment of orders to these routes. You can check if there are routes for any date on Routing workspace home page. Orders can be checked on the home page or the Orders section.

8. You have set up transfer of actual data:

   When using the Yandex Courier app

   1. You have added the phone numbers of couriers allowed to use the Yandex Courier app to the database. The list of added phone numbers is available on the Settings → Couriers page in Routing workspace.
   2. The couriers have installed the Yandex Courier app on their smartphones.
   3. The couriers have watched the video tutorial for the app.
   4. The couriers use the app correctly and mark deliveries.

   When using GPS trackers

   1. You have set up data transfer from GPS trackers to Yandex servers via the EGTS protocol.
   2. You have set up the transfer of GPS tracker numbers for routes for the day.

   If configured correctly, information about the courier's GPS tracker will be available for routes in Routing workplace.

9. Your orders are being delivered and delivery details are available in Routing workplace.

Contact support