Delivery API REST API

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

authorization

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 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 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}

plan-fact

Adds route plans. POST /api/v1/companies/{company_id}/route-plans
Gets route plan info GET /api/v1/companies/{company_id}/route-plan-info
Adds route plans. POST /api/v1/companies/{company_id}/route-plans
Gets route plan info GET /api/v1/companies/{company_id}/route-plan-info

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

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