取消订单

简介

本接口用于取消订单，行程状态在开始服务前(105)可以取消订单。

服务提供方

享道

接口URL

/openapi/order/cancel

请求方式

GET

请求频次

单次

请求参数

参数名称	类型	必选	说明
timestamp	long	是	请求时间，Unix Timestamp单位毫秒
order_id	string	是	享道订单ID
oid	string	是	合作方订单ID
force	string	否	是否强制取消，默认true; false：获取当前取消费，不会真正取消订单 true：强制取消订单，订单真正被取消
cancel_reason	int	否	订单取消原因，参见附录4
cancel_flag	int	否	1:平台取消；2:无应答超时取消；3:用户取消；4:抢单失败；5:司机被合作方封禁。不传默认为3:用户取消
cancel_fee_rate	string	否	取消费比例，小数如：0.8，无责时传递0

响应参数

参数名称	类型	必有	说明
errCode	int	是	服务响应状态，参见附录5
errMsg	string	是	服务响应状态说明，参见附录5
content	object	是
content.order_id	string	是	享道订单ID
content.oid	string	是	合作方订单ID
content.is_canceled	int	是	是否取消成功，0：失败，1：成功
content.need_pay	boolean	否	是否需要支付取消费
content.cost	int	否	需要支付的取消费金额，单位分
content.cancel_minute	int	否	派单多久后乘客取消收取消费，单位分钟

请求示例

请求

curl --location --request POST 'https://open-sit.saicmobility.com/merchant/v1/openapi/order/cancel' \
--header 'X-Sign: aab078dd08a60c2a2e72bbbdfca3c9f94ab40e13' \
--header 'X-SignAlgorithm: 1' \
--header 'X-Timestamp: 20201021113700' \
--header 'X-MerchantId: open_app_OqPcV19dBV1KoBHs' \
--header 'Content-Type: application/json' \
--data-raw '{"timestamp":1603196471352,"oid":"Tesso50ax2v045b050om6engn6258s2z166r","cancel_reason":"cancel","force":true,"order_id":"U4b3w6n9w1aebf19eed8be4475aba807826cef8154","cancel_flag":3}'

响应

{
  "errCode": 10000,
  "errMsg": "successful",
  "content": {
    "oid": "Tess9rsa6ruev1yb0e6sbqsk71izsgpefg9r",
    "order_id": "U4b3w6n9w1aebf19eed8be4475aba807826cef8154",
    "is_canceled": 1,
    "need_pay": false,
    "cost": 0,
    "status": 0,
    "cancel_minute": 0
  }
}