| Action | Method | resource | Description |
|---|---|---|---|
| Get all | GET | /driver_companies | Get all driver companies. |
| Get | GET | /driver_companies/driver_company_id | Get driver company with id drivergroup_id. |
| Create | POST | /driver_companies | Create a driver company |
| Update | PUT | /driver_companies/driver_company_id | Update driver company with id driver_company_id. |
| Delete | DELETE | /driver_companies/driver_company_id | Delete driver group with id driver_company_id. |
The driver company model is composed of the following attributes:
| attribute | type | required | Description | whereable |
|---|---|---|---|---|
| name | string | no, required to create. | yes | |
| logo | string | no | yes | |
| address | string | no, required to create. | yes | |
| schedule | json | no | yes | |
| priority | integer | no | yes | |
| limit | integer | no | yes | |
| fixed_cost_delivery | numeric | no, required to create. | yes | |
| fixed_cost_per_km | numeric | no, required to create. | yes | |
| percentage_cost_per_order_subtotal | numeric | no, required to create. | yes | |
| webhook_new_order | string | no, required to create. | yes | |
| webhook_order_status_changed | string | no | yes | |
| webhook_cancel_request | string | no, required to create. | yes | |
| api_key | string | no | yes | |
| last_order_assigned_at | date | no | yes | |
| busy | boolean | no | yes | |
| enabled | boolean | no | yes |
Requirement for use Driver Copany Endpoints.
To create, update, delete driver groups user must be user level 0 (Type: Administrator).