Cancel Order
Update Date: 2020-09-28 Mandatory Online test(Sandbox)
Summary
- This interface is used to cancel orders.
- If the interface fails to respond successfully, Trip will try again 3 times with an interval of 5 seconds. Therefore, the supplier needs to support idempotent operations based on the ctripPurchaseOrderId.
- Performance requirements: The response must be within 2000ms.
API address
API address Format: {Domain}/JNT/ordercancel/2.0/{timeStamp}/{sign}
Request Payload
CancelOrderRequest
Parameter | Type | Required | Description | Example | Note |
---|---|---|---|---|---|
ctripPurchaseOrderId | Long | Y | Ctrip Purchase Order ID | 881823967638342968 | 18 digital |
vendorOrderId | String | Y | Vendor's Order ID | Provide by Vendor | |
cancelReason | String | Y | Cancel Reason |
Response Payload
CancelOrderResponse
Parameter | Type | Required | Description | Example | Note |
---|---|---|---|---|---|
msgCode | String | Y | Response Code | OK | Response Code |
message | String | N | Response Detail | Success | Response Code |
Request Example
{
"ctripPurchaseOrderId": 881888888888888888,
"vendorOrderId": "2022022022",
"cancelReason": "customer cancel"
}
Response Example
{
"msgCode": "OK",
"message": "success",
}
Error Example
{
"msgCode": "ERROR_NO_ORDERID",
"message": "can note find order"
}