Query Order Details
Update Date: 2022-10-17 Taxi must be connected airport transfers is not necessary.
Summary
1、This interface is used to query supplier order data.
2、When there is an abnormality in the online service, Ctrip's order data may be incomplete, and the interface will be called to query the supplier's order details to correct the online data.
3、Performance requirement: The supplier needs to respond to the results within 2000ms.
API address
API address Format:
{Domain}/{Channel}/orderdetail/2.0/{timeStamp}/{sign}
Request Payload
OrderDetailRequest
Parameter |
Type |
Required |
Description |
Example |
Note |
ctripPurchaseOrderId |
Long |
Y |
Ctrip Purchase Order ID |
881823967638342968 |
18 digital |
vendorOrderId |
String |
Y |
Vendor Order ID |
|
Provide by Vendor |
Response Payload
OrderDetailResponse
Parameter |
Type |
Required |
Description |
Example |
Note |
msgCode |
String |
Y |
Response Code |
OK |
Response Code |
message |
String |
N |
Response Detail |
Success |
Response Code |
ctripPurchaseOrderId |
Long |
Y |
Ctrip Purchase Order ID |
881823967638342968 |
18 digital |
vendorOrderId |
String |
Y |
Vendor Order ID |
|
Provide by Vendor |
categoryCode |
String |
Y |
Service Type |
taxi-ondemand |
Service Type Code |
priceMode |
Integer |
N |
price mode |
|
0-Regular billing 1-buy-it-now price |
useTime |
String |
N |
Estimate Use Time |
2020-08-28 14:46 |
yyyy-MM-dd HH:mm |
orderStatus |
String |
Y |
Order Status |
CANCELLED |
Taxi Order Status Code |
passenger |
PassengerInfoDTO |
Y |
Passenger Info |
|
|
agent |
AgentInfoDTO |
N |
Agent Info |
|
|
driverInfo |
DriverInfoDTO |
N |
Driver Info |
|
Note 1:After the driver receives the order, there must be a value |
feeItems |
List<FeeItemDTO> |
N |
fee details |
|
Note 1:In the taxi scenario, there must be value after the trip ends |
duseLocation |
GeoDTO |
Y |
Address of Departure |
|
|
auseLocation |
GeoDTO |
Y |
Address of Arrival |
|
|
totalFee |
BigDecimal |
N |
Total order fee (after discount) |
|
Note 1:In the taxi scenario, there must be value after the trip ends |
originTotalFee |
BigDecimal |
N |
Total fee before discount |
|
|
actualDistance |
Integer |
N |
Actual driving distance(In meter) |
20000 |
|
actualTime |
Integer |
N |
Actual driving time(In seconds) |
1800 |
|
orderTime |
String |
N |
Order time |
|
yyyy-MM-dd HH:mm:ss |
takenTime |
String |
N |
Driver's order acceptance time |
|
yyyy-MM-dd HH:mm:ss |
readyTime |
String |
N |
Driver's seating time |
|
yyyy-MM-dd HH:mm:ss |
serviceStartTime |
String |
N |
Service start time |
|
yyyy-MM-dd HH:mm:ss |
serviceEndTime |
String |
N |
Service end time |
|
yyyy-MM-dd HH:mm:ss |
paymentTime |
String |
N |
Time of payment |
|
yyyy-MM-dd HH:mm:ss |
carYards |
String |
N |
Ride code |
|
ABCD |
PassengerInfoDTO
Parameter |
Type |
Required |
Description |
Example |
Note |
name |
String |
N |
Passenger Name |
Zhang San |
Must pass in domestic car use scenarios |
firstName |
String |
N |
Passenger First Name |
San |
Must pass in Trip station and overseas car usage scenarios |
lastName |
String |
N |
Passenger Last Name |
Zhang |
Must pass in Trip station and overseas car usage scenarios |
localPhoneAreaCode |
String |
N |
Passenger local phone country calling code |
+86 |
Must pass in domestic car use scenarios |
localPhone |
String |
N |
Passenger local phone number |
13161453199 |
|
maskRealPhone |
String |
N |
Passenger real local phone number with mask |
134**6871 |
|
email |
String |
N |
Passenger Email |
car@ctrip.com |
|
intlPhoneAreaCode |
String |
N |
Passenger destined country calling code |
+44 |
It is necessary to transmit either the Passenger destined country calling code or thePassenger destined phone number |
intlPhone |
String |
N |
Passenger destined phone number |
|
It is necessary to transmit either the Passenger destined country calling code or thePassenger destined phone number |
hotelPhone |
String |
N |
Hotel phone number |
|
|
hotelPhoneAreaCode |
String |
N |
Hotel country calling code |
|
|
emergencyPhone |
String |
N |
Emergency Contact Person country calling code |
|
|
emergencyPhoneAreaCode |
String |
N |
Emergency Contact Person phone number |
|
|
imType |
String |
N |
Instant Messaging App |
WeChat |
WhatsApp/Skype/LINE/WeChat |
imNo |
String |
N |
Instant Messaging Number |
|
|
AgentInfoDTO
Parameter |
Type |
Required |
Description |
Example |
Note |
name |
String |
N |
Agent Name |
Isaac Newton |
|
firstName |
String |
N |
Agent First Name |
Isaac |
|
lastName |
String |
N |
Agent Last Name |
Newton |
|
intlPhoneAreaCode |
String |
Y |
Agent country calling code |
+86 |
|
intlPhone |
String |
Y |
Agent phone number |
13161453199 |
|
DriverInfoDTO
Parameter |
Type |
Required |
Description |
Example |
Note |
driverId |
String |
N |
司机id |
|
|
driverName |
String |
Y |
Driver Name |
Jason Wang |
|
driverPhone |
String |
Y |
Driver Phone Number |
13161453199 |
Only used in emergency situations such as virtual number failure |
driverPhoneCode |
String |
Y |
Driver phone country calling code |
+86 |
|
vehicleNumber |
String |
Y |
Vehicle Plate Number |
沪A501Z9 |
|
vehicleBrand |
String |
Y |
Vehicle Brand Name |
Buick |
|
vehicleBrandDetail |
String |
N |
Vehicle Brand Series |
GL8 |
|
vehicleColor |
String |
Y |
Vehicle Color |
Black |
|
vehicleType |
Integer |
N |
Vehicle model code |
|
|
dispatcher |
Boolean |
N |
Is Real Driver or Customer Service Specialist |
True |
True: Customer Service Specialist; False: Driver |
FeeItemDTO
Parameter |
Type |
Required |
Description |
Example |
Note |
code |
String |
Y |
fee code |
|
Taxi Fee Code |
name |
String |
Y |
fee name |
|
|
amount |
BigDecimal |
Y |
fee amount |
|
Note 1:The cost amount of the discount item should be negative, such as a discount amount of 8 yuan, which should be returned as -8 here |
discount |
Boolean |
Y |
Is it a discount/promotion |
|
Note 1:Return true only in scenarios where the cost amount is negative |
GeoDTO
Parameter |
Type |
Required |
Description |
Example |
Note |
address |
String |
Y |
Address |
Ctrip headquarters building |
POI name |
detailAddress |
String |
Y |
Address Detail |
Skysoho 16, No. 968 Jin Zhong Road,Changning District, Shanghai |
POI address |
longitude |
BigDecimal |
Y |
Longitude |
121.351145 |
Keep 6 decimal places |
latitude |
BigDecimal |
Y |
Latitude |
31.221373 |
Keep 6 decimal places |
geoType |
String |
Y |
Geographic Coordinate System |
GCJ02 |
GCJ02 is used in China, and WGS84 is used outside China (including China Hong Kong, Macao and Taiwan). |
cityId |
String |
Y |
City Id |
258 |
City ID List |
cityName |
String |
Y |
City Name |
Fuzhou |
City ID List |
We will prioritize providing address information based on the site language selected by the user. For example, if a customer places an order on the Korean site, we will prioritize providing Korean address information, but in some cases, we can only provide Chinese or English address information. If you only need English address information, please contact Ctrip PM
FixedLocationDTO
Parameter |
Type |
Required |
Description |
Example |
Note |
fixedCode |
String |
Y |
Airport/Station code |
PVG |
Airport use IATA code. Station code is defined by Ctrip, please contact Ctrip BD if needed. |
fixedLocationName |
String |
Y |
Airport/Station Name |
Shanghai Pudong International Airport |
|
cityId |
String |
Y |
City Id |
258 |
City ID List |
cityName |
String |
Y |
City Name |
Fuzhou |
City ID List |
Ctrip will specify the terminal as much as possible when querying products. If we are unable to obtain the specific terminal, we will transmit the airport latitude and longitude, which you should handle on your own. If you do not allow this situation, please contact Ctrip R&D, and we will block requests in this scenario.
Request Example
{
"ctripPurchaseOrderId": 4297402542489160,
"vendorOrderId": "123456789asdfghjkl"
}
Response Example
{
"msgCode": "OK",
"message": "SUCCESS",
"ctripPurchaseOrderId": 4297402542493543,
"vendorOrderId": "123456789asdfghjkl",
"categoryCode": "taxi-ondemand",
"totalFee": 100,
"actualDistance": 2131231,
"actualTime": 2313,
"priceMode": 0,
"vehicleType": 117,
"useTime": "2022-07-21 20:55",
"duseLocation": {
"address": "天河国际机场T3航站楼",
"detailAddress": "天河国际机场 T3",
"longitude": 114.218929,
"latitude": 30.771418,
"geoType": "GCJ02",
"cityId": 477,
"cityName": "武汉"
},
"auseLocation": {
"address": "武汉纵横奥莱酒店",
"detailAddress": "百联奥特莱斯二期B10栋,黄陂区,武汉,湖北,中国",
"longitude": 114.257835,
"latitude": 30.733063,
"geoType": "GCJ02",
"cityId": 477,
"cityName": "武汉"
},
"passenger": {
"name": "携程客户",
"localPhoneAreaCode": "+86",
"localPhone": "13006351164",
"maskRealPhone": "181yiQA5523",
"email": "",
"intlPhoneAreaCode": "+86",
"intlPhone": ""
},
"agent": {
"name": "携程客户",
"intlPhoneAreaCode": "+86",
"intlPhone": "13006351164"
},
"orderStatus": 501,
"feeItems": [{
"code": "START_FEE",
"name": "起步费",
"amount": 10,
"discount": false
},
{
"code": "NORMAL_KM_FEE",
"name": "里程费",
"amount": 10,
"discount": false
},
{
"code": "LONG_KM_FEE",
"name": "长途费",
"amount": 10,
"discount": false
},
{
"code": "NORMAL_TIME_FEE",
"name": "时长费",
"amount": 10,
"discount": false
},
{
"code": "OTHER_FEE",
"name": "其他费用",
"amount": 10,
"discount": false
}
],
"orderTime": "2022-07-21 10:08:19",
"takenTime": "2022-07-21 10:10:19",
"readyTime": "2022-07-21 10:10:19",
"serviceStartTime": "2022-07-21 10:10:19",
"serviceEndTime": "2022-07-21 10:10:19",
"driverInfo": {
"driverId": "111",
"driverName": "大大师傅",
"driverPhone": "13699286011",
"driverAvaterURL": "http://",
"driverVirtualPhone": "177708316667",
"driverAgentVirtualPhone": "15879011126",
"vehicleType": 117,
"vehicleBrand": "大众帕萨特",
"vehicleColor": "黑色",
"vehicleNumber": "京Q19BA9",
"level": 4.9,
"driverPhoneLangauge": "DR-ZH"
}
}
Error Example
{
"msgCode": "ERROR_NO_ORDERID",
"message": "找不到订单"
}