Checklist for implementing the API

API implementation is a complex process that involves a large number of people. To facilitate the implementation, use the following checklist:

  1. You received a company ID. The company ID is a number, such as 420.
  2. You have a Yandex ID username.
  3. You have access to the routing workspace under this username.
  4. You have the OAuth token for your app under the same username.
  5. You created at least one depot through the routing workspace or API.

    You can see if there's a depot under SettingsDepots in the routing workspace.

  6. You set up courier data export using the API. If couriers change, data should be exported on a regular basis. If not, exporting the data just once is fine.

    You can check courier data in the Couriers routing workspace section.

  7. You set up regular route formation order filling for the day.

    You can check route availability for any date on the main page of the routing workspace. Order availability can be checked in the Orders section.

  8. You have set up transfer of actual data:

    When using the Yandex Courier app

    1. You 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 SettingsCouriers page of the routing workspace.

    2. The couriers have installed the Yandex Courier app on their smartphones.
    3. The couriers use the app correctly and mark order deliveries.

    If you are using GPS trackers

    1. You set up data transfer from GPS devices to Yandex servers via the EGTS protocol.
    2. You set up IMEI transfer for routes for the day.

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

  9. Your orders are being delivered and information on them is available in the routing workspace.

Contact support