Track & Trace API REST API

  1. authorization
  2. courier_report
  3. couriers
  4. depot_visit
  5. depots
  6. mvrp
  7. order-notifications
  8. orders
  9. photos
  10. plan-fact
  11. presets
  12. rented_couriers
  13. route-info
  14. routes
  15. tracking
  16. user
  17. verification
  18. work_breaks
  19. zones
  20. Other Methods

authorization

Gets authorization result GET /api/v1/test
Gets authorization result GET /api/v1/test

courier_report

Gets delivery quality information GET /api/v1/companies/{company_id}/courier-quality
Gets delivery quality information GET /api/v1/companies/{company_id}/courier-quality

couriers

Adds a courier POST /api/v1/companies/{company_id}/couriers
Deletes courier DELETE /api/v1/companies/{company_id}/couriers/{courier_id}
Edits courier PATCH /api/v1/companies/{company_id}/couriers/{courier_id}
Edits multiple couriers POST /api/v1/companies/{company_id}/couriers-batch
Gets courier GET /api/v1/companies/{company_id}/couriers
Gets courier by ID GET /api/v1/companies/{company_id}/couriers/{courier_id}
Adds a courier POST /api/v1/companies/{company_id}/couriers
Deletes courier DELETE /api/v1/companies/{company_id}/couriers/{courier_id}
Edits courier PATCH /api/v1/companies/{company_id}/couriers/{courier_id}
Edits multiple couriers POST /api/v1/companies/{company_id}/couriers-batch
Gets courier GET /api/v1/companies/{company_id}/couriers
Gets courier by ID GET /api/v1/companies/{company_id}/couriers/{courier_id}

depot_visit

Edits depot visit PATCH /api/v1/companies/{company_id}/routes/{route_id}/depot-visits/{depot_visit_id}
Gets depot visits of the route GET /api/v1/companies/{company_id}/routes/{route_id}/depot-visits
Edits depot visit PATCH /api/v1/companies/{company_id}/routes/{route_id}/depot-visits/{depot_visit_id}
Gets depot visits of the route GET /api/v1/companies/{company_id}/routes/{route_id}/depot-visits

depots

Adds a depot POST /api/v1/companies/{company_id}/depots
Deletes depot DELETE /api/v1/companies/{company_id}/depots/{depot_id}
Edits depot PATCH /api/v1/companies/{company_id}/depots/{depot_id}
Edits multiple depots POST /api/v1/companies/{company_id}/depots-batch
Gets depot GET /api/v1/companies/{company_id}/depots/{depot_id}
Gets multiple depots GET /api/v1/companies/{company_id}/depots
Adds a depot POST /api/v1/companies/{company_id}/depots
Deletes depot DELETE /api/v1/companies/{company_id}/depots/{depot_id}
Edits depot PATCH /api/v1/companies/{company_id}/depots/{depot_id}
Edits multiple depots POST /api/v1/companies/{company_id}/depots-batch
Gets depot GET /api/v1/companies/{company_id}/depots/{depot_id}
Gets multiple depots GET /api/v1/companies/{company_id}/depots

mvrp

Adds a task POST /api/v1/vrs/add/mvrp
Gets list of child tasks GET /api/v1/vrs/children
Gets list of rented vehicles for the task GET /api/v1/vrs/mvrp/{task_id}/rented-vehicle
Gets task result GET /api/v1/vrs/result/mvrp/{task_id}
Adds a task POST /api/v1/vrs/add/mvrp
Gets list of child tasks GET /api/v1/vrs/children
Gets list of rented vehicles for the task GET /api/v1/vrs/mvrp/{task_id}/rented-vehicle
Gets task result GET /api/v1/vrs/result/mvrp/{task_id}

order-notifications

Gets order notifications GET /api/v1/companies/{company_id}/order-notifications
Gets order notifications GET /api/v1/companies/{company_id}/order-notifications

orders

Adds an order POST /api/v1/companies/{company_id}/orders
Deletes order DELETE /api/v1/companies/{company_id}/orders/{order_id}
Edits multiple orders POST /api/v1/companies/{company_id}/orders-batch
Edits order PATCH /api/v1/companies/{company_id}/orders/{order_id}
Gets multiple orders GET /api/v1/companies/{company_id}/orders
Gets order GET /api/v1/companies/{company_id}/orders/{order_id}
Adds an order POST /api/v1/companies/{company_id}/orders
Deletes order DELETE /api/v1/companies/{company_id}/orders/{order_id}
Edits multiple orders POST /api/v1/companies/{company_id}/orders-batch
Edits order PATCH /api/v1/companies/{company_id}/orders/{order_id}
Gets multiple orders GET /api/v1/companies/{company_id}/orders
Gets order GET /api/v1/companies/{company_id}/orders/{order_id}

photos

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

plan-fact

Adds route plans. POST /api/v1/companies/{company_id}/route-plans
Get versioned plan-fact for nodes GET /api/v1/analytics/companies/{company_id}/plan-fact/versioned/nodes
Get versioned plan-fact for routes GET /api/v1/analytics/companies/{company_id}/plan-fact/versioned/routes
Gets route plan info GET /api/v1/companies/{company_id}/route-plan-info
Adds route plans. POST /api/v1/companies/{company_id}/route-plans
Get versioned plan-fact for nodes GET /api/v1/analytics/companies/{company_id}/plan-fact/versioned/nodes
Get versioned plan-fact for routes GET /api/v1/analytics/companies/{company_id}/plan-fact/versioned/routes
Gets route plan info GET /api/v1/companies/{company_id}/route-plan-info

presets

Adds presets to the company. POST /api/v1/reference-book/companies/{company_id}/presets
Deletes the preset of the company by ID. DELETE /api/v1/reference-book/companies/{company_id}/presets/{preset_id}
Gets company presets. GET /api/v1/reference-book/companies/{company_id}/presets
Gets public preset GET /api/v1/reference-book/public/presets/{preset_id}
Gets public presets. GET /api/v1/reference-book/public/presets
Gets the preset of the company by ID. GET /api/v1/reference-book/companies/{company_id}/presets/{preset_id}
Updates the preset of the company by ID. PATCH /api/v1/reference-book/companies/{company_id}/presets/{preset_id}
Adds presets to the company. POST /api/v1/reference-book/companies/{company_id}/presets
Deletes the preset of the company by ID. DELETE /api/v1/reference-book/companies/{company_id}/presets/{preset_id}
Gets company presets. GET /api/v1/reference-book/companies/{company_id}/presets
Gets public preset GET /api/v1/reference-book/public/presets/{preset_id}
Gets public presets. GET /api/v1/reference-book/public/presets
Gets the preset of the company by ID. GET /api/v1/reference-book/companies/{company_id}/presets/{preset_id}
Updates the preset of the company by ID. PATCH /api/v1/reference-book/companies/{company_id}/presets/{preset_id}

rented_couriers

Adds a rented courier POST /api/v1/companies/{company_id}/rented-couriers
Gets rented courier GET /api/v1/companies/{company_id}/rented-couriers/{rented_courier_id}
Adds a rented courier POST /api/v1/companies/{company_id}/rented-couriers
Gets rented courier GET /api/v1/companies/{company_id}/rented-couriers/{rented_courier_id}

route-info

Gets route info GET /api/v1/companies/{company_id}/route-info
Gets route info GET /api/v1/companies/{company_id}/route-info

routes

Adds a route POST /api/v1/companies/{company_id}/routes
Deletes route DELETE /api/v1/companies/{company_id}/routes/{route_id}
Edits multiple routes POST /api/v1/companies/{company_id}/routes-batch
Edits route PATCH /api/v1/companies/{company_id}/routes/{route_id}
Gets multiple routes GET /api/v1/companies/{company_id}/routes
Gets order sequence GET /api/v1/companies/{company_id}/routes/{route_id}/order-sequence
Gets route GET /api/v1/companies/{company_id}/routes/{route_id}
Sets route nodes and their sequence in the route POST /api/v1/companies/{company_id}/routes/{route_id}/nodes
Sets the order of deliveries in the route POST /api/v1/companies/{company_id}/routes/{route_id}/order-sequence
Adds a route POST /api/v1/companies/{company_id}/routes
Deletes route DELETE /api/v1/companies/{company_id}/routes/{route_id}
Edits multiple routes POST /api/v1/companies/{company_id}/routes-batch
Edits route PATCH /api/v1/companies/{company_id}/routes/{route_id}
Gets multiple routes GET /api/v1/companies/{company_id}/routes
Gets order sequence GET /api/v1/companies/{company_id}/routes/{route_id}/order-sequence
Gets route GET /api/v1/companies/{company_id}/routes/{route_id}
Sets route nodes and their sequence in the route POST /api/v1/companies/{company_id}/routes/{route_id}/nodes
Sets the order of deliveries in the route POST /api/v1/companies/{company_id}/routes/{route_id}/order-sequence

tracking

Gets order info GET /api/v1/companies/{company_id}/orders/{order_id}/order-info
Gets order info GET /api/v1/companies/{company_id}/orders/{order_id}/order-info

user

Adds a user POST /api/v1/companies/{company_id}/users
Adds the phone number of the courier who will work with the mobile application POST /api/v1/companies/{company_id}/app-user
Deletes user DELETE /api/v1/companies/{company_id}/users/{user_id}
Edits user PATCH /api/v1/companies/{company_id}/users/{user_id}
Gets multiple users GET /api/v1/companies/{company_id}/users
Gets user GET /api/v1/companies/{company_id}/users/{user_id}
Adds a user POST /api/v1/companies/{company_id}/users
Adds the phone number of the courier who will work with the mobile application POST /api/v1/companies/{company_id}/app-user
Deletes user DELETE /api/v1/companies/{company_id}/users/{user_id}
Edits user PATCH /api/v1/companies/{company_id}/users/{user_id}
Gets multiple users GET /api/v1/companies/{company_id}/users
Gets user GET /api/v1/companies/{company_id}/users/{user_id}

verification

Gets order information GET /api/v1/companies/{company_id}/verification
Gets order information GET /api/v1/companies/{company_id}/verification

work_breaks

Adds work breaks POST /api/v1/companies/{company_id}/routes/{route_id}/work_breaks
Deletes work break DELETE /api/v1/companies/{company_id}/routes/{route_id}/work_breaks/{work_break_id}
Gets work breaks GET /api/v1/companies/{company_id}/routes/{route_id}/work_breaks
Adds work breaks POST /api/v1/companies/{company_id}/routes/{route_id}/work_breaks
Deletes work break DELETE /api/v1/companies/{company_id}/routes/{route_id}/work_breaks/{work_break_id}
Gets work breaks GET /api/v1/companies/{company_id}/routes/{route_id}/work_breaks

zones

Adds company zones to reference book POST /api/v1/reference-book/companies/{company_id}/zones
Deletes company zone DELETE /api/v1/reference-book/companies/{company_id}/zones/{instance_id}
Gets company zone GET /api/v1/reference-book/companies/{company_id}/zones/{instance_id}
Gets company zone reference book GET /api/v1/reference-book/companies/{company_id}/zones
Gets public zone GET /api/v1/reference-book/public/zones/{instance_id}
Gets public zone reference book GET /api/v1/reference-book/public/zones
Patches company zone PATCH /api/v1/reference-book/companies/{company_id}/zones/{instance_id}
Adds company zones to reference book POST /api/v1/reference-book/companies/{company_id}/zones
Deletes company zone DELETE /api/v1/reference-book/companies/{company_id}/zones/{instance_id}
Gets company zone GET /api/v1/reference-book/companies/{company_id}/zones/{instance_id}
Gets company zone reference book GET /api/v1/reference-book/companies/{company_id}/zones
Gets public zone GET /api/v1/reference-book/public/zones/{instance_id}
Gets public zone reference book GET /api/v1/reference-book/public/zones
Patches company zone PATCH /api/v1/reference-book/companies/{company_id}/zones/{instance_id}

Other Methods

Adds or edits contractor number POST /api/v1/companies/{company_id}/numbers/{contractor_company_id}
Deletes contractor number DELETE /api/v1/companies/{company_id}/numbers/{contractor_company_id}
Gets contractor number GET /api/v1/companies/{company_id}/numbers/{contractor_company_id}
Gets multiple contractor numbers GET /api/v1/companies/{company_id}/numbers
Adds or edits contractor number POST /api/v1/companies/{company_id}/numbers/{contractor_company_id}
Deletes contractor number DELETE /api/v1/companies/{company_id}/numbers/{contractor_company_id}
Gets contractor number GET /api/v1/companies/{company_id}/numbers/{contractor_company_id}
Gets multiple contractor numbers GET /api/v1/companies/{company_id}/numbers