Order Details

Update Date: 2020-09-28 optional

Summary

  1. This interface is used to query the order detailed and status from the vendor. It is used to ensure that the order status and information of the vendor and Ctrip are consistent.
  2. If the Vendor does not receive the return message from Ctrip, the vendor should retry 3 times.

API address

API address Format:  {Domain}/JNT-{vendorID}/order/detail/2.0/{ctripPurchaseOrderID}/{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
masterOrderId Long Y Ctrip User Order ID 12744251457 11 digital
ctripPurchaseOrderId Long Y Ctrip Purchase Order ID 881823967638342968 18 digital
vendorOrderId String Y Vendor's Order ID   Provide by Vendor
orderStatus String Y Order Status CANCELLED Ctrip Order Status
passenger PassengerInfoDTO Y Passenger Info    
driverInfo OrderDetailDriverInfoDTO N Driver Info    
cancelDetail OrderDetailCancelDetailDTO N Cancel Reason    
orderDetailRuleDTO OrderDetailRuleDTO N Order Key Times   Include latest confirm order time, latest push driver info time, updated use time. Empty when order is finished or canceled.
orderDetailFlightInfo OrderDetailFlightInfoDTO N Flight Info   Need contact Ctrip IT for access
msgCode String Y Response Code OK Response Code
message String N Response Detail Success Response Code

PassengerInfoDTO

Parameter Type Required Description Example Note
name String N Passenger Name Zhang San Note 7
firstName String N Passenger First Name San Alphabet, Note 7
lastName String N Passenger Last Name Zhang Alphabet, Note 7
localPhoneAreaCode String N Passenger local phone country calling code +86 Note 8
localPhone String N Passenger local phone number 13161453199 Note 8
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 Note 8
intlPhone String N Passenger destined phone number   Note 8
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    

OrderDetailDriverInfoDTO

Parameter Type Required Description Example Note
vehicleStatus Integer Y Driver Status 1 Driver Status List
driverName String Y Driver Name Jason Wang  
driverPhone String Y Driver Phone Number 13161453199  
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  
driverEmail String N Driver Email    
driverAvaterURL String N Driver Pic URL    
driverImType String N Driver Instant Messaging App WeChat WhatsApp/Skype/LINE/WeChat
driverImNo String N Driver Instant Messaging Number    
dispatcher Boolean N Is Real Driver or Customer Service Specialist True True: Customer Service Specialist; False: Driver

OrderDetailCancelDetailDTO

Parameter Type Required Description Example Note
cancelReason String Y Vendor Order Cancel Reason CONFIRMED When dispatched=TRUE is dispatch type. CONFIRMING: Dispatch before confirmed. CONFIRMED: Dispatch after confirmed. NOSHOW: Dispatch due to Noshow.
cancelReasonDetail String N Vendor Order Cancel Reason Detail OTA When dispatched=TRUE is dispatch source. OPERATOR: Dispatch by Ctrip Customer service. OTA: Dispatch by vendor request. CUSTOMER: Dispatch by Customer. SYSTEM: Dispatch by System.
dispatched Boolean Y Whether dispatch to other vendor TRUE TRUE is dispatch to other vendor, FALSE means the order is canceled.
customerLostFee BigDecimal Y Customer Lost Fee 0 When dispatched=TRUE is 0.
vendorLostFee BigDecimal Y Vendor Lost Fee 20 When dispatched=TRUE is vendor cannot service fine.

OrderDetailRuleDTO

Parameter Type Required Description Example Note
lastConfirmTime String Y Latest Confirm Order Time 2020-08-28 14:46 The deadline for confirm order.
lastPushDriverTime String Y Latest Push Driver Info Time 2020-08-29 14:46 The deadline for push driver.
sysExpectBookTime BigDecimal N Updated Use Time 2020-08-30 09:46 Maybe empty

OrderDetailFlightInfoDTO

Parameter Type Required Description Example Note
flightNo String Y Flight Number CA1888  
arrAirportCode String Y Flight Take Off Airport Code PVG  
deptAirportCode String Y Flight Landing Airport Code XIY  
planDepTime String Y Plan Take Off Time 2020-08-28 14:46  
expectDepTime String N Expect Take Off Time 2020-08-28 13:46 Maybe empty
actualDepTime String N Actual Take Off Time 2020-08-28 13:40 Maybe empty
planArrTime String Y Plan Landing Time 2020-08-28 16:40  
expectArrTime String N Expect Landing Time 2020-08-28 16:50 Maybe empty
actualArrTime String N Actual Landing Time 2020-08-28 17:10 Maybe empty

Request Example

{
    "ctripPurchaseOrderID": 881824212456774814,
    "vendorOrderID": "1232423"
}

Response Example

{
    "msgCode": "OK",
    "ctripMasterOrderID": 12732069098,
    "ctripPurchaseOrderID": 881824212456774814,
    "vendorOrderID": "20A6GFTHZUZBRF",
    "orderStatus": "cancelled",
    "cancelDetail": {
        "cancelReason": "行程有变，暂不需要用车",
        "cancelReasonDetail": "147",
        "customerLostFee": 0,
        "vendorLostFee": 174.00
    }
}

Error Example

{
    "msgCode": "Error",
    "massage": ""
}

results matching ""

    No results matching ""