韵达 API
  1. 散件下单
韵达 API
  • 接口简介
  • API 鉴权说明
    • API 鉴权说明
  • 电子面单
    • 电子面单取消接口
      POST
    • 电子面单下单
      POST
    • 电子面单余量查询接口
      POST
    • 电子面单更新接口
      POST
  • 散件下单
    • 运单推送接口
      POST
    • 散单取消接口
      POST
    • 预估运费接口
      POST
    • 散件下单接口
      POST
  • 物流轨迹
    • 物流轨迹推送
      POST
    • 物流轨迹查询
      POST
    • 物流轨迹订阅
      POST
  • 国际件
    • 国际进口下单接口
      POST
  • 页面嵌入
    • 微信小程序嵌入
    • 微信公众号接入
    • h5页面嵌入
  1. 散件下单

散单取消接口

POST
/v1/order/cancelOrder

接口描述#


仅限于未揽件订单取消
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi.yundaex.com/openapi-api/v1/order/cancelOrder' \
--header 'app-key;' \
--header 'sign;' \
--header 'req-time;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appid": "000001",
    "backparam": "",
    "orderid": "yd987654321"
}'
响应示例响应示例
{
    "result": true,
    "code": "0000",
    "message": "请求成功",
    "data": {
        "backparam": "",
        "orderid": "yd987654321"
    }
}

请求参数

Header 参数
app-key
string 
开放平台发放
必需
默认值:
{{app-key}}
sign
string 
必需
签名说明参看附录《鉴权说明》
默认值:
{{sign}}
req-time
string 
当前时间戳(毫秒)
必需
默认值:
{{$timestamp}}
Body 参数application/json
appid
string 
必需
合作商appid(等同app-key)
backparam
string 
可选
韵达大客户账号(韵达业务方提供)
orderid
string 
必需
韵达大客户秘钥(韵达业务方提供)
示例

返回响应

🟢200成功
application/json
Body
code
string 
响应编码
必需
message
string 
响应内容
必需
result
boolean 
请求是否成功
必需
data
array [object {2}] 
返回对象信息
必需
backparam
string 
原样返回字段
可选
orderid
string 
订单号
必需

【韵达】API开发者 微信交流群

用微信扫右侧二维码,加入【韵达】API开发者 交流群,互助沟通

扫码加入交流群
修改于 2021-11-10 04:26:26
上一页
运单推送接口
下一页
预估运费接口
Built with