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

电子面单取消接口

POST
/v1/accountOrder/cancelBmOrder

接口描述#


签名详见 官网API鉴权说明;请求参数和签名方法
下单后如果订单取消,请用此接口
取消订单后,无任何物流记录的一个月后可释放回原账号库存内,继续使用。错误信息类型有:
1. 超过下单时间40天,不允许取消
2. 已经有物流信息,不允许取消
取消订单后订单要重新生效,则使用下单接口下单即可
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi.yundaex.com/openapi-api/v1/accountOrder/cancelBmOrder' \
--header 'app-key;' \
--header 'sign;' \
--header 'req-time;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "appid": "999999",
  "partner_id": "YUNDA",
  "secret": "a123456",
  "orders": [
    {
      "order_serial_no": "2012121715001",
      "mailno": "5100709876543"
    }
  ]
}'
响应示例响应示例
200 - 成功 - 成功示例
{
    "code": "0000",
    "message": "请求成功",
    "result": true,
    "data": [
        {
            "order_serial_no": "2012121715001",
            "mail_no": "5100709876543",
            "status": "1",
            "msg": "订单取消成功"
        }
    ]
}

请求参数

Header 参数
app-key
string 
开放平台发放
必需
默认值:
{{app-key}}
sign
string 
必需
签名说明参看附录《鉴权说明》
默认值:
{{sign}}
req-time
string 
当前时间戳(毫秒)
必需
默认值:
{{$timestamp}}
Body 参数application/json
appid
string 
必需
合作商appid(等同app-key)
partner_id
string 
必需
韵达大客户账号(韵达业务方提供)
secret
string 
必需
韵达大客户秘钥(韵达业务方提供)
orders
array [object {2}] 
订单详情
必需
order_serial_no
string 
必需
客户订单号 由字母、数字、下划线组成,必须保证唯一,请对特殊符号进行过滤
mailno
string 
运单号
必需
示例

返回响应

🟢200成功
application/json
Body
code
string 
响应编码
必需
message
string 
响应内容
必需
result
boolean 
请求是否成功
必需
data
array [object {4}] 
返回对象信息
必需
order_serial_no
string 
返回对象信息
可选
mail_no
string 
可选
筛单成功,则不为空;筛单失败,则为空
status
string 
可选
返回状态,1表示成功,0表示失败
msg
string 
可选
成功或者错误的提示信息
🟢200失败

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

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

扫码加入交流群
修改于 2021-12-30 05:51:42
上一页
API 鉴权说明
下一页
电子面单下单
Built with