Contents

Track & Trace

API Resources

Technical support

Track & Trace API REST API

items-validations

order-notifications

rented_couriers

Track & Trace

General description

Interface description

Reports

Courier performance report

Coordinates of couriers

How to implement the API

Getting an OAuth token

Adding couriers

Setting routes for the day

Setting up data transfer from devices

Checklist for implementing the API

Special considerations and limitations

Function description

Set up SMS notifications

Photo proof of delivery

Estimated Time of Arrival (ETA)

Order sharing between companies

Courier push notifications

Courier updates to order coordinates

Courier mileage

Courier downtime

Courier visits to the depot

Detect route location visits

Automatic delivery detection

Plan / Fact

Working with reports

Working with graphs

Custom route fields

Additional options

Changing the courier delivery interval

Partial delivery

Delivery by order statuses

Display and edit the order list

Yandex Courier app

API Resources

Track & Trace API REST API

Gets authorization result

Gets delivery quality information

Gets delivery quality information with pagination

Deletes courier

Edits multiple couriers

Gets courier by ID

Edits depot visit

Gets depot visits of the route

Edits multiple depots

Gets multiple depots

Adds order items request for procesing.

Gets order items request information.

items-validations

Adds order items request for validation.

Gets order items request validation information.

Gets list of child tasks

Gets list of rented vehicles for the task

Gets task result

order-notifications

Gets order notifications

Edits multiple orders

Gets multiple orders

Adds route plans.

Get versioned plan-fact for nodes

Get versioned plan-fact for routes

Gets route plan info

Adds presets to the company.

Deletes the preset of the company by ID.

Gets company presets.

Gets public preset

Gets public presets.

Gets the preset of the company by ID.

Updates the preset of the company by ID.

rented_couriers

Adds a rented courier

Gets rented courier

Gets route info

Edits multiple routes

Gets multiple routes

Gets order sequence

Sets route nodes and their sequence in the route

Sets the order of deliveries in the route

Gets order info

Pushes courier positions from client

Adds the phone number of the courier who will work with the mobile application

Gets multiple users

Gets order information

Adds work breaks

Deletes work break

Gets work breaks

Adds company zones to reference book

Deletes company zone

Gets company zone

Gets company zone reference book

Gets public zone

Gets public zone reference book

Patches company zone

Adds items associated with the order (sinchronously).

Adds or edits contractor number

Deletes all items associated with the order.

Deletes contractor number

Deletes the item with specified item ID.

Gets contractor number

Gets multiple contractor numbers

Gets positions of courier on the route for the specified time interval. The interval is not longer than 2 hours.

Gets the items associated with the order.

Specify items for return.

Technical support

Frequently asked questions

API Resources

photos

photos

Methods

Methods

Gets photos GET /api/v1/companies/{company_id}/photos

Gets photos GET /api/v1/companies/{company_id}/photos

Was the article useful?

Please specify why

I don't like how this feature works
article is hard to understand
didn't answer my question
article content does not match its stated topic
recommendations did not help me
other reason

Thank you for your feedback!

Please tell us what you didn't like about this article:

Contents