Track & Trace API REST API

  1. authorization
  2. courier_report
  3. couriers
  4. depot_visit
  5. depots
  6. items-addings
  7. items-validations
  8. mvrp
  9. order-notifications
  10. orders
  11. photos
  12. plan-fact
  13. presets
  14. rented_couriers
  15. route-info
  16. routes
  17. tracking
  18. user
  19. verification
  20. work_breaks
  21. zones
  22. Прочие методы

authorization

Получает результат авторизации GET /api/v1/test
Получает результат авторизации GET /api/v1/test

courier_report

Получает информацию о качестве доставки GET /api/v1/companies/{company_id}/courier-quality
Получает информацию о качестве доставки с пагинацией GET /api/v2/companies/{company_id}/courier-quality
Получает информацию о качестве доставки GET /api/v1/companies/{company_id}/courier-quality
Получает информацию о качестве доставки с пагинацией GET /api/v2/companies/{company_id}/courier-quality

couriers

Добавляет курьера POST /api/v1/companies/{company_id}/couriers
Получает курьера GET /api/v1/companies/{company_id}/couriers
Получает курьера по его ID GET /api/v1/companies/{company_id}/couriers/{courier_id}
Редактирует курьера PATCH /api/v1/companies/{company_id}/couriers/{courier_id}
Редактирует нескольких курьеров POST /api/v1/companies/{company_id}/couriers-batch
Удаляет курьера DELETE /api/v1/companies/{company_id}/couriers/{courier_id}
Добавляет курьера POST /api/v1/companies/{company_id}/couriers
Получает курьера GET /api/v1/companies/{company_id}/couriers
Получает курьера по его ID GET /api/v1/companies/{company_id}/couriers/{courier_id}
Редактирует курьера PATCH /api/v1/companies/{company_id}/couriers/{courier_id}
Редактирует нескольких курьеров POST /api/v1/companies/{company_id}/couriers-batch
Удаляет курьера DELETE /api/v1/companies/{company_id}/couriers/{courier_id}

depot_visit

Получает посещения складов маршрута GET /api/v1/companies/{company_id}/routes/{route_id}/depot-visits
Редактирует посещение склада PATCH /api/v1/companies/{company_id}/routes/{route_id}/depot-visits/{depot_visit_id}
Получает посещения складов маршрута GET /api/v1/companies/{company_id}/routes/{route_id}/depot-visits
Редактирует посещение склада PATCH /api/v1/companies/{company_id}/routes/{route_id}/depot-visits/{depot_visit_id}

depots

Добавляет склад POST /api/v1/companies/{company_id}/depots
Получает несколько складов GET /api/v1/companies/{company_id}/depots
Получает склад GET /api/v1/companies/{company_id}/depots/{depot_id}
Редактирует несколько складов POST /api/v1/companies/{company_id}/depots-batch
Редактирует склад PATCH /api/v1/companies/{company_id}/depots/{depot_id}
Удаляет склад DELETE /api/v1/companies/{company_id}/depots/{depot_id}
Добавляет склад POST /api/v1/companies/{company_id}/depots
Получает несколько складов GET /api/v1/companies/{company_id}/depots
Получает склад GET /api/v1/companies/{company_id}/depots/{depot_id}
Редактирует несколько складов POST /api/v1/companies/{company_id}/depots-batch
Редактирует склад PATCH /api/v1/companies/{company_id}/depots/{depot_id}
Удаляет склад DELETE /api/v1/companies/{company_id}/depots/{depot_id}

items-addings

Загружает запрос на добавление товарного состава к заказам на обработку. POST /companies/{company_id}/orders/-/items-addings
Получает информацию об запросе добавления товарного состава. GET /companies/{company_id}/orders/-/items-addings/{order_items_adding_id}
Загружает запрос на добавление товарного состава к заказам на обработку. POST /companies/{company_id}/orders/-/items-addings
Получает информацию об запросе добавления товарного состава. GET /companies/{company_id}/orders/-/items-addings/{order_items_adding_id}

items-validations

Загружает запрос на добавление товарного состава к заказам на валидацию. POST /companies/{company_id}/orders/-/items-validations
Получает информацию об операции валидации товарного состава. GET /companies/{company_id}/orders/-/items-validations/{order_items_validation_id}
Загружает запрос на добавление товарного состава к заказам на валидацию. POST /companies/{company_id}/orders/-/items-validations
Получает информацию об операции валидации товарного состава. GET /companies/{company_id}/orders/-/items-validations/{order_items_validation_id}

mvrp

Добавляет задачу POST /api/v1/vrs/add/mvrp
Получает результат задачи GET /api/v1/vrs/result/mvrp/{task_id}
Получает список арендованных транспортных средств для задачи GET /api/v1/vrs/mvrp/{task_id}/rented-vehicle
Получает список дочерних задач GET /api/v1/vrs/children
Добавляет задачу POST /api/v1/vrs/add/mvrp
Получает результат задачи GET /api/v1/vrs/result/mvrp/{task_id}
Получает список арендованных транспортных средств для задачи GET /api/v1/vrs/mvrp/{task_id}/rented-vehicle
Получает список дочерних задач GET /api/v1/vrs/children

order-notifications

Получает уведомления о заказе GET /api/v1/companies/{company_id}/order-notifications
Получает уведомления о заказе GET /api/v1/companies/{company_id}/order-notifications

orders

Добавляет заказ POST /api/v1/companies/{company_id}/orders
Получает заказ GET /api/v1/companies/{company_id}/orders/{order_id}
Получает несколько заказов GET /api/v1/companies/{company_id}/orders
Редактирует заказ PATCH /api/v1/companies/{company_id}/orders/{order_id}
Редактирует несколько заказов POST /api/v1/companies/{company_id}/orders-batch
Удаляет заказ DELETE /api/v1/companies/{company_id}/orders/{order_id}
Добавляет заказ POST /api/v1/companies/{company_id}/orders
Получает заказ GET /api/v1/companies/{company_id}/orders/{order_id}
Получает несколько заказов GET /api/v1/companies/{company_id}/orders
Редактирует заказ PATCH /api/v1/companies/{company_id}/orders/{order_id}
Редактирует несколько заказов POST /api/v1/companies/{company_id}/orders-batch
Удаляет заказ DELETE /api/v1/companies/{company_id}/orders/{order_id}

photos

Получает фото GET /api/v1/companies/{company_id}/photos
Получает фото GET /api/v1/companies/{company_id}/photos

plan-fact

Добавляет планы маршрутов. POST /api/v1/companies/{company_id}/route-plans
Получает информацию о плане маршрута GET /api/v1/companies/{company_id}/route-plan-info
Получить план-факт для маршрутов по версии GET /api/v1/analytics/companies/{company_id}/plan-fact/versioned/routes
Получить план-факт для точек по версии GET /api/v1/analytics/companies/{company_id}/plan-fact/versioned/nodes
Добавляет планы маршрутов. POST /api/v1/companies/{company_id}/route-plans
Получает информацию о плане маршрута GET /api/v1/companies/{company_id}/route-plan-info
Получить план-факт для маршрутов по версии GET /api/v1/analytics/companies/{company_id}/plan-fact/versioned/routes
Получить план-факт для точек по версии GET /api/v1/analytics/companies/{company_id}/plan-fact/versioned/nodes

presets

Добавляет пресеты к компании. POST /api/v1/reference-book/companies/{company_id}/presets
Обновляет пресет компании по идентификатору. PATCH /api/v1/reference-book/companies/{company_id}/presets/{preset_id}
Получает пресет компании по идентификатору. GET /api/v1/reference-book/companies/{company_id}/presets/{preset_id}
Получает пресеты компании. GET /api/v1/reference-book/companies/{company_id}/presets
Получает публичные пресеты. GET /api/v1/reference-book/public/presets
Получает публичный пресет. GET /api/v1/reference-book/public/presets/{preset_id}
Удаляет пресет компании по идентификатору. DELETE /api/v1/reference-book/companies/{company_id}/presets/{preset_id}
Добавляет пресеты к компании. POST /api/v1/reference-book/companies/{company_id}/presets
Обновляет пресет компании по идентификатору. PATCH /api/v1/reference-book/companies/{company_id}/presets/{preset_id}
Получает пресет компании по идентификатору. GET /api/v1/reference-book/companies/{company_id}/presets/{preset_id}
Получает пресеты компании. GET /api/v1/reference-book/companies/{company_id}/presets
Получает публичные пресеты. GET /api/v1/reference-book/public/presets
Получает публичный пресет. GET /api/v1/reference-book/public/presets/{preset_id}
Удаляет пресет компании по идентификатору. DELETE /api/v1/reference-book/companies/{company_id}/presets/{preset_id}

rented_couriers

Добавляет нанятого курьера POST /api/v1/companies/{company_id}/rented-couriers
Получает нанятого курьера GET /api/v1/companies/{company_id}/rented-couriers/{rented_courier_id}
Добавляет нанятого курьера POST /api/v1/companies/{company_id}/rented-couriers
Получает нанятого курьера GET /api/v1/companies/{company_id}/rented-couriers/{rented_courier_id}

route-info

Получает информацию о маршруте GET /api/v1/companies/{company_id}/route-info
Получает информацию о маршруте GET /api/v1/companies/{company_id}/route-info

routes

Возвращает последовательность заказов GET /api/v1/companies/{company_id}/routes/{route_id}/order-sequence
Добавляет маршрут POST /api/v1/companies/{company_id}/routes
Задает порядок доставки заказов в маршруте POST /api/v1/companies/{company_id}/routes/{route_id}/order-sequence
Задает узлы маршрута и их последовательность POST /api/v1/companies/{company_id}/routes/{route_id}/nodes
Получает маршрут GET /api/v1/companies/{company_id}/routes/{route_id}
Получает несколько маршрутов GET /api/v1/companies/{company_id}/routes
Редактирует маршрут PATCH /api/v1/companies/{company_id}/routes/{route_id}
Редактирует несколько маршрутов POST /api/v1/companies/{company_id}/routes-batch
Удаляет маршрут DELETE /api/v1/companies/{company_id}/routes/{route_id}
Возвращает последовательность заказов GET /api/v1/companies/{company_id}/routes/{route_id}/order-sequence
Добавляет маршрут POST /api/v1/companies/{company_id}/routes
Задает порядок доставки заказов в маршруте POST /api/v1/companies/{company_id}/routes/{route_id}/order-sequence
Задает узлы маршрута и их последовательность POST /api/v1/companies/{company_id}/routes/{route_id}/nodes
Получает маршрут GET /api/v1/companies/{company_id}/routes/{route_id}
Получает несколько маршрутов GET /api/v1/companies/{company_id}/routes
Редактирует маршрут PATCH /api/v1/companies/{company_id}/routes/{route_id}
Редактирует несколько маршрутов POST /api/v1/companies/{company_id}/routes-batch
Удаляет маршрут DELETE /api/v1/companies/{company_id}/routes/{route_id}

tracking

Отправляет позиции курьеров в базу данных POST /api/v1/couriers/{courier_id}/routes/{route_id}/push-positions-v3
Получает информацию о заказе GET /api/v1/companies/{company_id}/orders/{order_id}/order-info
Отправляет позиции курьеров в базу данных POST /api/v1/couriers/{courier_id}/routes/{route_id}/push-positions-v3
Получает информацию о заказе GET /api/v1/companies/{company_id}/orders/{order_id}/order-info

user

Добавляет номер телефона курьера, для которого будет работать мобильное приложение POST /api/v1/companies/{company_id}/app-user
Добавляет пользователя POST /api/v1/companies/{company_id}/users
Получает несколько пользователей GET /api/v1/companies/{company_id}/users
Получает пользователя GET /api/v1/companies/{company_id}/users/{user_id}
Редактирует пользователя PATCH /api/v1/companies/{company_id}/users/{user_id}
Удаляет пользователя DELETE /api/v1/companies/{company_id}/users/{user_id}
Добавляет номер телефона курьера, для которого будет работать мобильное приложение POST /api/v1/companies/{company_id}/app-user
Добавляет пользователя POST /api/v1/companies/{company_id}/users
Получает несколько пользователей GET /api/v1/companies/{company_id}/users
Получает пользователя GET /api/v1/companies/{company_id}/users/{user_id}
Редактирует пользователя PATCH /api/v1/companies/{company_id}/users/{user_id}
Удаляет пользователя DELETE /api/v1/companies/{company_id}/users/{user_id}

verification

Получает информацию о заказе GET /api/v1/companies/{company_id}/verification
Получает информацию о заказе GET /api/v1/companies/{company_id}/verification

work_breaks

Добавляет перерывы на отдых в маршрут POST /api/v1/companies/{company_id}/routes/{route_id}/work_breaks
Получает перерывы на отдых GET /api/v1/companies/{company_id}/routes/{route_id}/work_breaks
Удаляет перерыв на отдых DELETE /api/v1/companies/{company_id}/routes/{route_id}/work_breaks/{work_break_id}
Добавляет перерывы на отдых в маршрут POST /api/v1/companies/{company_id}/routes/{route_id}/work_breaks
Получает перерывы на отдых GET /api/v1/companies/{company_id}/routes/{route_id}/work_breaks
Удаляет перерыв на отдых DELETE /api/v1/companies/{company_id}/routes/{route_id}/work_breaks/{work_break_id}

zones

Добавляет зоны компании в справочник POST /api/v1/reference-book/companies/{company_id}/zones
Изменяет параметры зоны компании PATCH /api/v1/reference-book/companies/{company_id}/zones/{instance_id}
Получает зону компании GET /api/v1/reference-book/companies/{company_id}/zones/{instance_id}
Получает публичную зону GET /api/v1/reference-book/public/zones/{instance_id}
Получает справочник зон компании GET /api/v1/reference-book/companies/{company_id}/zones
Получает справочник публичных зон GET /api/v1/reference-book/public/zones
Удаляет зону компании DELETE /api/v1/reference-book/companies/{company_id}/zones/{instance_id}
Добавляет зоны компании в справочник POST /api/v1/reference-book/companies/{company_id}/zones
Изменяет параметры зоны компании PATCH /api/v1/reference-book/companies/{company_id}/zones/{instance_id}
Получает зону компании GET /api/v1/reference-book/companies/{company_id}/zones/{instance_id}
Получает публичную зону GET /api/v1/reference-book/public/zones/{instance_id}
Получает справочник зон компании GET /api/v1/reference-book/companies/{company_id}/zones
Получает справочник публичных зон GET /api/v1/reference-book/public/zones
Удаляет зону компании DELETE /api/v1/reference-book/companies/{company_id}/zones/{instance_id}

Прочие методы

Добавляет или изменяет номер подрядчика POST /api/v1/companies/{company_id}/numbers/{contractor_company_id}
Добавляет информацию о возврате товаров. POST /companies/{company_id}/orders/{order_id}:return
Добавляет товарный состав заказа (синхронно). POST /api/v1/companies/{company_id}/orders/{order_id}/items
Получает номер подрядчика GET /api/v1/companies/{company_id}/numbers/{contractor_company_id}
Получает номера подрядчиков GET /api/v1/companies/{company_id}/numbers
Получает позиции курьера за определенный временной иинтервал. Интервал должен быть не более 2 часов. GET /api/v2/companies/{company_id}/routes/{route_id}/courier-positions
Получает товарный состав заказа. GET /api/v1/companies/{company_id}/orders/{order_id}/items
Удаляет весь товарный состав заказа. DELETE /api/v1/companies/{company_id}/orders/{order_id}/items
Удаляет номер подрядчика DELETE /api/v1/companies/{company_id}/numbers/{contractor_company_id}
Удаляет товар по его ID. DELETE /api/v1/companies/{company_id}/orders/{order_id}/items/{item_id}
Добавляет или изменяет номер подрядчика POST /api/v1/companies/{company_id}/numbers/{contractor_company_id}
Добавляет информацию о возврате товаров. POST /companies/{company_id}/orders/{order_id}:return
Добавляет товарный состав заказа (синхронно). POST /api/v1/companies/{company_id}/orders/{order_id}/items
Получает номер подрядчика GET /api/v1/companies/{company_id}/numbers/{contractor_company_id}
Получает номера подрядчиков GET /api/v1/companies/{company_id}/numbers
Получает позиции курьера за определенный временной иинтервал. Интервал должен быть не более 2 часов. GET /api/v2/companies/{company_id}/routes/{route_id}/courier-positions
Получает товарный состав заказа. GET /api/v1/companies/{company_id}/orders/{order_id}/items
Удаляет весь товарный состав заказа. DELETE /api/v1/companies/{company_id}/orders/{order_id}/items
Удаляет номер подрядчика DELETE /api/v1/companies/{company_id}/numbers/{contractor_company_id}
Удаляет товар по его ID. DELETE /api/v1/companies/{company_id}/orders/{order_id}/items/{item_id}