# Driver Related
# Driver Balance Management
Feature: View and manage balances and calculate driver earnings
Method: POST
URL: /fleet/open-api/drivers/getBalance
Requested Parameters:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| fleet_id | int64 | Yes | Fleet ID |
| driver_id | int64 | Yes | Driver ID |
| location_country | string | Yes | Country |
| lang | string | Yes | Language |
Returned Parameters:
| Parameter | Type | Description |
|---|---|---|
| driver_balance | string | Driver balance |
| currency_code | string | Currency code |
Return example:
Normal condition
{
"errno": 0,
"msg": "success",
"data": {
"response": {
"driver_balance": "-217.01",
"currency_code": "₽"
},
"trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
}
}
2
3
4
5
6
7
8
9
10
11
Abnormal condition
{
"errno": 20002,
"msg": "the driver does not exist."
}
2
3
4
Note: “response” in the return example is json data obtained through decryption and deserialization
# Driver Trip Management
Feature: Get driver’s trip list with the fleet
Method: POST
URL: /fleet/open-api/drivers/getOrderList
Requested Parameters:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| fleet_id | int64 | Yes | Fleet ID |
| location_country | string | Yes | Country |
| lang | string | Yes | Language |
| page | int32 | Yes | Page number, range: [1,1000000] |
| size | int32 | Yes | Number of trips on each page, range: [1,100] |
| driver_id | int64 | No | Driver ID |
| driver_phone | string | No | Mobile number |
| start_time | string | No | Request acceptance start time, the time format is ISO8601, e.g.: "2006-01-02T15:04:05-07:00" |
| end_time | string | No | Request acceptance end time, the time format is ISO8601, e.g.: "2006-01-02T15:04:05-07:00" |
Returned Parameters:
| Parameter | Type | Description |
|---|---|---|
| driver_id | int64 | Driver ID |
| driver_name | string | Driver name |
| fleet_id | int64 | Fleet ID |
| driver_phone | string | Driver’s mobile number |
| order_id | int64 | Trip id |
| acceptance_time | string | Acceptance time |
| start_at | string | Pickup point |
| end_at | string | Dropoff point |
| order_distance | string | Distance |
| order_status | int32 | Trip status; Enumeration values: Refer to Appendix “Trip Status” |
| order_status_desc | string | Order status description |
| is_pay | int32 | Is it paid? 0: unpaid 1:paid |
| pay_type | int32 | Payment Method,Enumeration values: Refer to Appendix “Payment Methods” |
| pay_type_desc | string | Pay type description |
| total_fee | string | Total fees |
| currency_code | string | Currency code |
Return example:
Normal condition
{
"errno": 0,
"msg": "success",
"data": {
"response": {
"list": [
{
"driver_id": 50000000000000,
"driver_name": "Test50000000000000",
"fleet_id": 10000000000000,
"driver_phone": "************",
"order_id": 80000000000000,
"acceptance_time": "2021-09-01T00:00:00+08:00",
"start_at": "*************",
"end_at": "************",
"order_status": 1,
"order_status_desc": "Accepted",
"is_pay": 1,
"pay_type": 1024,
"pay_type_desc": "Cash Payment",
"total_fee": "478.0",
"currency_code": "RUB"
}
],
"count": 1
},
"trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
Abnormal condition
{
"errno": 20002,
"msg": "the driver does not exist."
}
2
3
4
Note: “response” in the return example is json data obtained through decryption and deserialization
# Check Driver Status
Feature: Use driver’s mobile number to check whether they can be added to the fleet
Method: POST
URL: /fleet/open-api/drivers/checkDriverExist
Requested Parameters:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| fleet_id | int64 | Yes | Fleet ID |
| driver_phone | string | Yes | Driver’s mobile number,the format is country code + phone number, e.g. "+700016****44" |
| location_country | string | Yes | Country |
| lang | string | Yes | Language |
Returned Parameters:
| Parameter | Type | Description |
|---|---|---|
| is_exists | int32 | Indicates whether the driver’s information exists in Driver System: 0-Does not exist 1-Exists |
| driver_id | int64 | Driver id |
| driver_name | string | Driver name |
Return example:
Normal condition
{
"errno": 0,
"msg": "success",
"data": {
"response": {
"driver_info": {
"driver_id": 50000000000000,
"driver_name": ""
},
"is_exists": 1
},
"trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
Abnormal condition
{
"errno": 10001,
"msg": "driver phone is empty."
}
2
3
4
Note: “response” in the return example is json data obtained through decryption and deserialization
# Add New Drivers
Feature: Fleet partner adds new drivers
Precondition: Check whether the driver is a new driver before calling the API. The user can get the driver’s status through the “Check Driver Status” API. If the returned “is_exists” parameter value is 0, the driver is a new driver.
Method: POST
URL: /fleet/open-api/drivers/bindNewDriver
Requested Parameters:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| fleet_id | int64 | Yes | Fleet ID |
| driver_phone | string | Yes | Driver’s mobile number,the format is country code + phone number, e.g. "+700016****44" |
| driver_info | object | Yes | Driver info |
| identity_info | object | Yes | Document info |
| strategy_info | object | Yes | Work regime info |
| location_country | string | Yes | Country |
| lang | string | Yes | Language |
| uranus_product_id | int32 | No | Product line (default value: 2), Refer to Appendix “Product Lines” for enumeration values |
driver_info Object Content:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| license_no | string | Yes | Driver info: Driver’s License No. |
| family_name | string | Yes | Driver info: Last name |
| given_name | string | Yes | Driver info: First name |
| father_name | string | No | Driver info: Patronymic (Russia) |
| license_issue_date | string | Yes | Driver info: Driver’s License issue date, date format e.g.: 2020-01-01 |
| license_valid_date | string | Yes | Driver info: Driver’s License expiration date, date format e.g.: 2020-01-01 |
| birthday | string | Yes | Driver info: Date of birth, date format e.g.: 2020-01-01 |
| license_kind | string | Yes | Driver info: Driver’s License type. Enumeration values: Refer to Appendix “Driver License Types” |
| license_issue_country | string | Yes | Driver info: Country of issue of Driver’s License (English abbreviation). Refer to “Abbreviation” in Appendix “Countries and Languages” |
| driver_special_marks | string | No | Driver info: Special driver logo |
| area_id | int64 | Yes | Driver info: City code. Retrieved from the “Get Launched Cities Information” API |
| license_f_img | string | Yes | Driver info: URL of front side photo of Driver’s License. To get image URL, please first call “Upload Image Information” API |
| license_b_img | string | Yes | Driver info: URL of back side photo of Driver’s License. To get image URL, please first call “Upload Image Information” API |
Identity_info Object Content:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| identity_type | string | Yes | Document info: Document type. Enumeration values: Refer to Appendix “Document Types” |
| identity_id | string | Yes | Document info: Document ID |
| id_valid_date | string | Yes | Document info: Document validity period, date format e.g.: 2020-01-01 |
| driver_nationality | string | Yes | Document info: Country of document |
| identity_img | string | Yes | Document info: URL of document photo. To get image URL, please first call “Upload Image Information” API |
strategy_info Object Content:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| amount | int64 | No | Amount withheld based on trip fare |
| cap_amount | int64 | No | Maximum percentage-based trip commission. If the value is 0, no limit applies |
| start_time | string | No | Start time. If left blank, the current time is used by default,the time format is 2021-10-01 |
| percent | int32 | No | Deduction percentage for each trip |
| deduct_type | int32 | No | Deduction type. Enumeration values: 0-By percentage; 1-By amount |
| strategy_type | int32 | Yes | Work regime type: 0-Trip work regime; 2-Recurring work regime |
| name | string | No | Work regime name. Refer to Appendix “Types of Cycle Billing Fees” |
| strategy_fee_type | int32 | No | Fee type. Enumeration values: Refer to Appendix “Types of Cycle Billing Fees” |
| period_type | int32 | No | Billing period type, limited to non-trip fees. Enumeration values: Refer to Appendix “Billing Period Types” |
Request example of trip work regime by percentage:
[{
"cap_amount": 2000,
"deduct_type": 0,
"start_time": "",
"strategy_type": 0,
"percent": 18
}
]
2
3
4
5
6
7
8
Request example of trip work regime by amount:
[{
"amount": 20,
"deduct_type": 1,
"start_time": "",
"strategy_type": 0
}
]
2
3
4
5
6
7
Request example of recurring work regime:
[{
"name": "Cleaning fee",
"amount": 10,
"start_time": "2021-10-02",
"period_type": 0,
"strategy_type": 2,
"strategy_fee_type": 1002
}
]
2
3
4
5
6
7
8
9
Request example:
{
"fleet_id": 10000000000000,
"location_country": "RU",
"lang": "ru-RU",
"drive_id": 50000000000000,
"driver_phone": "+700016****44",
"driver_info": {
"license_no": "6622573****450081D",
"family_name": "",
"given_name": "",
"father_name": "",
"license_issue_date": "2017-09-27",
"license_valid_date": "2027-09-27",
"birthday": "1995-09-01",
"license_kind": "B",
"license_issue_country": "RU",
"area_id": 7800600,
"license_f_img": "/upload/rooster20210901/5739e4c49e2d/3569dd813b2",
"license_b_img": "/upload/rooster20210901/57bae93fda8e9/00239d7b4d"
},
"identity_info": {
"identity_type": "passport",
"identity_id": "7765****8865",
"id_valid_date": "2027-09-01",
"driver_nationality": "RU",
"identity_img": "/upload/rooster20210901/57bae93fda8e9/00239d7b4d"
},
"strategy_info": [{
"cap_amount": 2000,
"deduct_type": 0,
"start_time": "",
"strategy_type": 0,
"percent": 18
}]
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Return example:
Normal condition
{
"errno": 0,
"msg": "success"
}
2
3
4
Abnormal condition
{
"errno": 10001,
"msg": "parameter error."
}
2
3
4
Note: “response” in the return example is json data obtained through decryption and deserialization
# Add Existing Drivers
Feature: Fleet partner adds existing drivers
Precondition: Check whether the driver is an existing driver before calling the API. The user can get driver’s status through “Check Driver Status” API. If the returned “is_exists” parameter value is 1, the driver is an existing driver.
Method: POST
URL: /fleet/open-api/drivers/bindOldDriver
Requested Parameters:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| fleet_id | int64 | Yes | Fleet ID |
| driver_phone | string | Yes | Driver’s mobile number,the format is country code + phone number, e.g. "+700016****44" |
| strategy_info | object | Yes | Work regime list |
| location_country | string | Yes | Country |
| lang | string | Yes | Language |
| uranus_product_id | int32 | No | Product line (default value: 2), Refer to Appendix “Product Lines” for enumeration values |
strategy_info Object Content:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| amount | int64 | No | Amount withheld based on trip fare |
| cap_amount | int64 | No | Maximum percentage-based trip commission. If the value is 0, no limit applies |
| start_time | string | No | Start time. If left blank, the current time is used by default,the time format is 2021-10-01 |
| percent | int32 | No | Deduction percentage for each trip |
| deduct_type | int32 | No | Deduction type. Enumeration values: 0-By percentage; 1-By amount |
| strategy_type | int32 | Yes | Work regime type:0-Trip work regime; 2-Recurring work regime |
| name | string | No | Work regime name. Enumeration values: Refer to Appendix “Types of Cycle Billing Fees” |
| strategy_fee_type | int32 | No | Fee type. Enumeration values: Refer to Appendix “Types of Cycle Billing Fees” |
| period_type | int32 | No | Billing period type, limited to non-trip fees. Enumeration values: Refer to Appendix “Billing Period Types” |
Request example:
{
"fleet_id": 10000000000000,
"drive_id": 50000000000000,
"location_country": "RU",
"lang": "ru-RU",
"driver_phone": "+700016****44",
"strategy_info": [{
"cap_amount": 2000,
"deduct_type": 0,
"start_time": "",
"strategy_type": 0,
"percent": 18
}]
}
2
3
4
5
6
7
8
9
10
11
12
13
14
Return example:
Normal condition
{
"errno": 0,
"msg": "success"
}
2
3
4
Abnormal condition
{
"errno": 20020,
"msg": "the driver has been bound by other fleet."
}
2
3
4
Note: “response” in the return example is json data obtained through decryption and deserialization
# Remove Driver
Feature: Fleet partner removes drivers
Method: POST
URL: /fleet/open-api/drivers/unbind
Requested Parameters:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| fleet_id | int64 | Yes | Fleet ID |
| driver_id | int64 | Yes | Driver ID |
| location_country | string | Yes | Country |
| lang | string | Yes | Language |
| uranus_product_id | int32 | No | Product line (default value: 2), Refer to Appendix “Product Lines” for enumeration values |
Return example:
Normal condition
{
"errno": 0,
"msg": "success",
"data": "",
"trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
}
2
3
4
5
6
Abnormal condition
{
"errno": 20007,
"msg": "failed to get driver binding relationship.",
"data": "",
"trace_id": "0a6072d45f3cd92f5883b3f9e57d0fb0"
}
2
3
4
5
6
Note: “response” in the return example is json data obtained through decryption and deserialization
# Get Driver Work Arrangements
Feature: Get driver work arrangements
Method: POST
URL: /fleet/open-api/drivers/getWorkCondition
Requested Parameters:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| fleet_id | int64 | Yes | Fleet ID |
| driver_id | int64 | Yes | Driver ID |
| location_country | string | Yes | Country |
| lang | string | Yes | Language |
Returned Parameters:
| Parameter | Type | Description |
|---|---|---|
| id | int64 | ID: work regime’s unique id |
| name | string | Work regime name |
| amount | int64 | Amount |
| cap_amount | int64 | Maximum percentage-based trip commission. If the value is 0, no limit applies |
| start_time | string | Start time |
| percent | int32 | Deduction percentage for each trip |
| deduct_type | int32 | Deduction type. Enumeration values: 0-By percentage; 1-By amount |
| strategy_type | int32 | Work regime type: 0-Trip work regime; 2-Recurring work regime |
| strategy_fee_type | int32 | Fee type. Enumeration values: Refer to Appendix “Types of Cycle Billing Fees” |
| period_type | int32 | Billing period type, limited to non-trip fees. Enumeration values: Refer to Appendix “Billing Period Types” |
Return example:
Normal condition
{
"errno": 0,
"msg": "success",
"data": {
"response": {
"list":[{
"id": 2198,
"cap_amount": 2000,
"deduct_type": 0,
"start_time": "2021-10-02T00:00:00+03:00",
"strategy_type": 0,
"percent": 18,
"strategy_fee_type": 0
}],
"count": 1
},
"trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Abnormal condition
{
"errno": 20002,
"msg": "the driver does not exist."
}
2
3
4
Note: “response” in the return example is json data obtained through decryption and deserialization
# Update Driver Work Arrangements
Feature: Update driver work arrangements
Method: POST
URL: /fleet/open-api/drivers/updateWorkCondition
Requested Parameters:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| fleet_id | int64 | Yes | Fleet ID |
| driver_id | int64 | Yes | Driver ID |
| strategy_info | object | Yes | Work regime list |
| location_country | string | Yes | Country |
| lang | string | Yes | Language |
strategy_info Object Content:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| id | int64 | Yes | ID: work regime’s unique id |
| amount | int64 | No | Amount withheld based on trip fare |
| cap_amount | int64 | No | Maximum percentage-based trip commission. If the value is 0, no limit applies |
| start_time | string | No | Start time. If left blank, the current time is used by default,the time format is 2021-10-01 |
| percent | int32 | No | Deduction percentage for each trip |
| deduct_type | int32 | No | Deduction type. Enumeration values: 0-By percentage; 1-By amount |
| strategy_type | int32 | Yes | Work regime type:0-Trip work regime; 2-Recurring work regime |
| name | string | No | Work regime name. Enumeration values: Refer to Appendix “Types of Cycle Billing Fees” |
| strategy_fee_type | int32 | No | Fee type. Enumeration values: Refer to Appendix “Types of Cycle Billing Fees” |
| period_type | int32 | No | Billing period type, limited to non-trip fees. Enumeration values: Refer to Appendix “Billing Period Types” |
Request example of trip work regime by percentage:
{
"id": 2198,
"cap_amount": 2000,
"deduct_type": 0,
"start_time": "",
"strategy_type": 0,
"percent": 18
}
2
3
4
5
6
7
8
Request example of trip work regime by amount:
{
"id": 2198,
"amount": 20,
"deduct_type": 1,
"start_time": "",
"strategy_type": 0
}
2
3
4
5
6
7
Request example of recurring work regime:
{
"id": 2198,
"name": "Cleaning fee",
"amount": 10,
"start_time": "2021-10-02",
"period_type": 0,
"strategy_type": 2,
"strategy_fee_type": 1002
}
2
3
4
5
6
7
8
9
Request example:
{
"fleet_id": 10000000000000,
"drive_id": 50000000000000,
"location_country": "RU",
"lang": "ru-RU",
"strategy_info": {
"id": 2198,
"cap_amount": 2000,
"deduct_type": 0,
"start_time": "",
"strategy_type": 0,
"percent": 18
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
Return example:
Normal condition
{
"errno": 0,
"msg": "success"
}
2
3
4
Abnormal condition
{
"errno": 10001,
"msg": "parameter error."
}
2
3
4
Note: “response” in the return example is json data obtained through decryption and deserialization
# Add Driver Work Arrangements
Feature: Add Driver Work Arrangements
Method: POST
URL: /fleet/open-api/drivers/addWorkCondition
Requested Parameters:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| fleet_id | int64 | Yes | Fleet ID |
| driver_id | int64 | Yes | Driver ID |
| strategy_info | object | Yes | Work regime list |
| location_country | string | Yes | Country |
| lang | string | Yes | Language |
strategy_info Object Content:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| amount | int64 | No | Amount withheld based on trip fare |
| cap_amount | int64 | No | Maximum percentage-based trip commission. If the value is 0, no limit applies |
| start_time | string | No | Start time. If left blank, the current time is used by default,the time format is 2021-10-01 |
| percent | int32 | No | Deduction percentage for each trip |
| deduct_type | int32 | No | Deduction type. Enumeration values: 0-By percentage; 1-By amount |
| strategy_type | int32 | Yes | Work regime type:0-Trip work regime; 2-Recurring work regime |
| name | string | No | Work regime name. Enumeration values: Refer to Appendix “Types of Cycle Billing Fees” |
| strategy_fee_type | int32 | No | Fee type. Enumeration values: Refer to Appendix “Types of Cycle Billing Fees” |
| period_type | int32 | No | Billing period type, limited to non-trip fees. Enumeration values: Refer to Appendix “Billing Period Types” |
Request example of trip work regime by percentage:
{
"cap_amount": 2000,
"deduct_type": 0,
"start_time": "",
"strategy_type": 0,
"percent": 18
}
2
3
4
5
6
7
Request example of trip work regime by amount:
{
"amount": 20,
"deduct_type": 1,
"start_time": "",
"strategy_type": 0
}
2
3
4
5
6
Request example of recurring work regime:
{
"name": "Cleaning fee",
"amount": 10,
"start_time": "2021-10-02",
"period_type": 0,
"strategy_type": 2,
"strategy_fee_type": 1002
}
2
3
4
5
6
7
8
Request example:
{
"fleet_id": 10000000000000,
"drive_id": 50000000000000,
"location_country": "RU",
"lang": "ru-RU",
"strategy_info": {
"cap_amount": 2000,
"deduct_type": 0,
"start_time": "",
"strategy_type": 0,
"percent": 18
}
}
2
3
4
5
6
7
8
9
10
11
12
13
Return example:
Normal condition
{
"errno": 0,
"msg": "success"
}
2
3
4
Abnormal condition
{
"errno": 10001,
"msg": "parameter error."
}
2
3
4
Note: “response” in the return example is json data obtained through decryption and deserialization
# Delete Driver Work Arrangements
Feature: Delete Driver Work Arrangements
Method: POST
URL: /fleet/open-api/drivers/delWorkCondition
Requested Parameters:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| fleet_id | int64 | Yes | Fleet ID |
| driver_id | int64 | Yes | Driver ID |
| id | int64 | Yes | ID: work regime’s unique id |
| location_country | string | Yes | Country |
| lang | string | Yes | Language |
Return example:
Normal condition
{
"errno": 0,
"msg": "success"
}
2
3
4
Abnormal condition
{
"errno": 10004,
"msg": "fleet have no permission for this driver"
}
{
"errno":-1
"msg":"order strategy can not be delete"
}
2
3
4
5
6
7
8
Note: “response” in the return example is json data obtained through decryption and deserialization
# Get Driver Info
Feature: Get driver information and returns information on drivers in the fleet
Method: POST
URL: /fleet/open-api/drivers/getDriverList
Requested Parameters:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| fleet_id | int64 | Yes | Fleet ID |
| location_country | string | Yes | Country |
| lang | string | Yes | Language |
| page | int32 | Yes | Page number, range: [1,1000000] |
| size | int32 | Yes | Number of trips on each page, range: [1,100] |
| uranus_product_id | int32 | No | Product line (default value: 2), Refer to Appendix “Product Lines” for enumeration values |
Returned Driver Info Parameters Description:
| Parameter | Type | Description |
|---|---|---|
| driver_id | int64 | Driver ID |
| driver_name | string | Driver’s name |
| family_name | string | Driver’s last name |
| given_name | string | Driver’s first name |
| father_name | string | Driver’s patronymic |
| driver_phone | string | Driver’s mobile number |
| driver_status | int32 | Driver status. Enumeration values: Refer to Appendix “Driver Status” |
| driver_status_desc | string | Driver status description |
| work_status | int32 | Work status. Enumeration values: Refer to Appendix “Work Status” |
| work_status_desc | int32 | Work status description |
| registration_city | string | Registered city |
Returned Vehicle Info Parameters Description:
| Parameter | Type | Description |
|---|---|---|
| car_id | int64 | Vehicle id |
| plate_no | string | Plate No. |
| brand_name | string | Vehicle Brand |
| car_status | string | Vehicle review status. Enumeration values: Refer to Appendix “Vehicle Review Status” |
Return example:
Normal condition
{
"errno": 0,
"msg": "success",
"data": {
"response": {
"list": [{
"car": [{
"car_id": 50000000000000,
"plate_no": "688AZZ15",
"brand_name": "",
"car_status": 1
}],
"car_count": 1,
"driver":{
"driver_id": 50000000000000,
"driver_name": "Test571********786",
"family_name": "zhang",
"given_name": "san",
"father_name": "",
"driver_phone": "**********",
"driver_status": 3,
"driver_status_desc": "Approved",
"work_status": 1,
"work_status_desc": "Trip in progress",
"registration_city": "Beijing"
}
}],
"count": 1
},
"trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
Abnormal condition
{
"errno": 20002,
"msg": "the driver does not exist."
}
2
3
4
Note: “response” in the return example is json data obtained through decryption and deserialization
# Driver Statistics
Feature: Fleet partner views driver’s trip statistics
Method: POST
URL: /fleet/open-api/drivers/getOrderSummary
Requested Parameters:
| Parameter | Type | Required or Not | Description |
|---|---|---|---|
| fleet_id | int64 | Yes | Fleet ID |
| driver_id_list | object | Yes | Driver ID list |
| start_date | string | Yes | Start date; can be up to three months ago, the time format is ISO8601 |
| end_date | string | Yes | End date; can be up to one month after start date, the time format is ISO8601 |
| location_country | string | Yes | Country |
| lang | string | Yes | Language |
Returned Parameters:
| Parameter | Type | Description |
|---|---|---|
| driver_id | int64 | Driver ID |
| driver_name | string | Driver’s name |
| fleet_id | int64 | Fleet ID |
| driver_phone | string | Driver’s mobile number |
| online_time | float64 | Total hours online, rounded to 2 decimal places (Unit: Hours) |
| dispatch_orders | int64 | Trips received |
| acceptance_num | int64 | Trips accepted |
| acceptance_rate | string | Acceptance Rate (AR) |
| completion_num | int64 | Trips completed |
| completion_rate | string | Completion Rate (CR) |
| passenger_cancel_orders | int64 | Trips cancelled by riders |
| driver_cancel_orders | int64 | Trips cancelled by driver |
| others_cancel_orders | int64 | Trips cancelled due to other reasons |
| orders_paid_num | int64 | Trips completed and paid |
| paid_transactions | string | Total paid amount of trips completed |
| currency_code | string | Currency code |
Request example:
{
"fleet_id": 10000000000000,
"drive_id_list": [60000000000000,60000000000001],
"location_country": "RU",
"lang": "ru-RU",
"start_date": "2021-01-01T00:00:00+03:00",
"end_date": "2021-01-30T00:00:00+03:00"
}
2
3
4
5
6
7
8
Return example:
Normal condition
{
"errno": 0,
"msg": "success",
"data": {
"response": {
"detail": [
{
"driver_id": 50000000000000,
"driver_name": "Test50000000000000",
"fleet_id": 10000000000000,
"driver_phone": "*********",
"online_time": 68.40,
"dispatch_orders": 50,
"acceptance_num": 30,
"acceptance_rate": "60%",
"completion_num": 30,
"completion_rate": "60%",
"passenger_cancel_orders": 10,
"driver_cancel_orders": 5,
"others_cancel_orders": 5,
"orders_paid_num": 30,
"paid_transactions": "150.50",
"trip_distance": "100.01",
"currency_code": "RUB"
}
],
"count": 1
},
"trace_id": "0a6072d45f3cdd6be61db3f9ffdfc9b0"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
Abnormal condition
{
"errno": 20002,
"msg": "the driver does not exist."
}
2
3
4
Note: “response” in the return example is json data obtained through decryption and deserialization