Adding couriers
After adding depots, add a list of couriers who will complete orders to the database.
Note
Use your company ID to access the Track & Trace API. If you don't have an ID, contact us.
In the Routing workspace
-
Open Routing Workspace.
-
In the menu on the left, go to Track & Trace → Couriers.
-
Enter each courier's information (phone number and username) and click Add.
If you use the courier's mobile phone number in
+1ххххххххххformat as their username, they won't have to enter a username to log in to the Yandex Courier app.To learn how to register couriers, see Working with the courier list.
- In the menu on the left, go to Settings → Mobile app.
- Enter the couriers' phone numbers and click Add. These couriers will be able to use the Yandex Courier app.
To learn how to add couriers, see Couriers.
In the API
Note
When you add a courier using the API, you can enter their phone number (phone), username (number), and name (name).
Send a request to the couriers-batch resource. The request must contain information about the employees.
To send API requests via Postman, you can use the RouteQ API collection.
Alert
The specification contains required fields for existing objects, but there are more fields for new objects. When you add new objects by sending a request to the couriers-batch resource, fill in all of the required fields for the couriers resource.
Request:
cURL
curl -H "Content-Type: application/json" -H "Authorization: OAuth <your-token>" -X POST -d @<File_path_in_UTF-8_encoding> https://courier.yandex.ru/api/v1/companies/<your-company-id>/couriers-batch
File
[
{
"number":"222",
"phone":"+15551234567",
"name":"Mark"
},
{
"number":"224",
"phone":"+15551234568",
"name":"Sarah"
}
]
cURL
curl -H "Content-Type: application/json" -H "Authorization: OAuth <your-OAuth-token>" -X POST -d '[{"number":"222", "phone":"+15551234567", "name":"Mark"}, {"number":"224", "phone":"+15551234568", "name":"Sara"}]' https://courier.yandex.ru/api/v1/companies/<your-company-id>/couriers-batch
Result:
{
"inserted": 2,
"updated": 0
}
Phone numbers for Yandex Courier
If couriers use the Yandex Courier app, add their numbers to the database from the interface. Otherwise, they won't be able to use the app.
-
Open Routing Workspace.
- In the menu on the left, go to Settings → Mobile app.
- Enter the courier's phone number and click Add.
You can add multiple couriers' phone numbers at once. To do so, enter the numbers separated by a comma.