韵达开放平台 API

接口简介

API鉴权说明

快递投放

校验运单号手机号

POST

禁投第三方校验

POST

电子面单

包裹信息接入

POST

电子面单取消

POST

电子面单下单

POST

电子面单余量查询

POST

电子面单更新

POST

电子面单打印

POST

停发查询

POST

散件下单

运单推送接口

POST

取消散件订单（新）

POST

预估运费

POST

散件下单(新)

POST

物流轨迹

物流轨迹推送

POST

物流轨迹查询

POST

物流轨迹订阅

POST

售后服务

物流工单下发

POST

国际件

国际进口下单

POST

外部发券

外部直发券

POST

发券结果查询

POST

电子面单更新开发中

POST/v1/accountOrder/updateBmOrder

创建时间: 2025-06-03 00:39

请求参数

Header 参数

参数名	示例值	是否必填	参数类型	描述说明
app-key	{{app-key}}	是	string	开放平台发放
sign	{{sign}}	是	string	签名说明参看附录《鉴权说明》
req-time	{{$timestamp}}	是	string	当前时间戳（毫秒）

Body 参数application/json

数据结构

appidstring

必填

合作商appid（等同app-key）

partner_idstring

必填

韵达白马账号（合作网点提供）

secretstring

必填

韵达白马账号的联调密码（合作网点提供）

ordersarray<object>

必填

订单详情

collect_branchstring

可选

揽件网点编码

collection_valuenumber

可选

代收货款金额目前仅用于cod订单，cod订单必填

cus_area1string

可选

可以自定义显示信息1，打印在客户自定义区域1，换行请用\n

cus_area2string

可选

可以自定义显示信息2，打印在客户自定义区域2，换行请用\n

isProtectPrivacystring

可选

判断订单是否是隐私订单，如果是隐私订单把收件人姓名和电话进行脱敏处理（1表示是，0表示否）隐私面单业务对接需与韵达方确认业务需求

itemsarray<object>

可选

商品信息集合

khddhinteger

必填

大客户系统订单的订单号可与订单唯一序列号相同

node_idstring

必填

350（默认）

order_serial_nointeger

必填

订单唯一序列号由字母、数字、下划线组成，必须保证唯一，请对特殊符号进行过滤

order_typestring

必填

运单类型参数值对照order_type字典表可固定为common

platform_sourcestring

可选

平台来源

receiverobject

必填

收件人

remarkstring

可选

备注

senderobject

必填

寄件人信息

sizestring

可选

物品大小(单位米)

specialinteger

可选

商品类型保留字段，暂时不用(见商品类型字段)

valuenumber

可选

货物金额

weightnumber

可选

物品重量

wave_no string

可选

客户波次号，按照此号进行批量打印校验，批量下单时，此波次号需要相同

other_chargesnumber

可选

其他费用

multi_packobject

可选

一票多件

markingInfosarray<object>

可选

增值服务标签增值服务必填，json字符串

示例数据

{
  "appid": "999999",
  "partner_id": "YUNDA",
  "secret": "a123456",
  "orders": [
    {
      "collection_value": 126.5,
      "cus_area1": "",
      "cus_area2": "",
      "isProtectPrivacy": "",
      "items": [
        {
          "name": "衣服",
          "number": 1,
          "remark": "袜子"
        }
      ],
      "khddh": 2012121715001,
      "node_id": "string",
      "order_serial_no": 2012121715001,
      "order_type": "common",
      "platform_source": "",
      "receiver": {
        "address": "上海市青浦区盈港东路 6679 号",
        "city": "上海市",
        "company": "",
        "county": "青浦区",
        "mobile": "17601206977",
        "name": "李四",
        "province": "上海市"
      },
      "remark": "string",
      "sender": {
        "address": "上海市青浦区盈港东路 7766 号",
        "city": "上海市",
        "company": "",
        "county": "青浦区",
        "mobile": "17601206977",
        "name": "张三",
        "province": "上海市"
      },
      "size": "0.12,0.23,0.11",
      "special": 0,
      "value": 126.5,
      "wave_no": "string",
      "weight": 0
    }
  ]
}

响应示例

订单创建成功

HTTP状态码：200

内容格式：JSON

数据结构

codestring

必填

响应编码

messagestring

必填

响应内容

resultboolean

必填

是否成功

dataarray<object>

必填

返回对象信息

order_serial_nostring

必填

客户订单号

pdf_infostring

必填

pdf参数信息（根据客户的需求返回json格式数据或对json格式进行加密后的数据

mail_nostring

必填

运单号

statusstring

必填

返回状态，1表示成功，0表示失败

msgstring

必填

成功或者错误的提示信息

orderIdstring

必填

remarkstring

必填

响应示例

{
    "code": "0000",
    "message": "请求成功",
    "result": true,
    "data": [{
        "order_serial_no": "0000019876576897",
        "pdf_info": "tpr9Rwyil5dnQI3wgFQAcMPv9snngCm8NJUZEE6l83sHhRYqkljyqL2T9X/W09euZbaz/W/vglst55QljSRkRnxVoC/ClW7aJiMU5i0Scyk7X6x0nXw+uf3F3lDh0twY9GZfSnWrmJ8arBm/gJ0Dng2TsT+O7wfXMUSvXXs+fkUdkqTYRjcuZ4duZ6EcOxM03AyQJyHoJVy+sN2Jk0wVwbT+vd65YOykh6gmNn9j9vnKZPh2o/UCBgIpWbRg822WO62vZooDmzQZsy7QmWk+UuFPHC0c/6iA7DUoCHSIuOcOOGFmfwgE/+QXuRYD+1M6V2qbR5fvKIQJ4rkIdcdZRAv2hzNhzVLf0UCN3gS9hwocrEl1Vzw7n1fymk22TPDS7bTjDzKNEbd/bntl0N43bGCafD8PfDJ6PHm5jZfSdNGiMuNMfQH/BoqMs4ZicYkF7JQg3G1qTwCgz8YKoo5+zpQE3ZrEVhSg2j0hHeHmCGxmf8oHF5aU5Tl+8olSCh66GzWZgbrAN3riEJr+I6ZAp02/O6qSYiae1Yn5m2nt1n1btrpAYbZbTrdFyXUFTPMFA03fXwDZ0KpLDzsPDTueB53H37tXuxXHsdz04MsA0B15bq7+ujJ2s2Yrbc0yY1IbPvX1eIdjjDiY7HkvAIFWSG/HcoCcBuWUjPi2Xa8NlXzrjHxY5Hki3yAw6LybJxN2Mdajcp1XyObBUyXZiZS4kRXdUeFVJV9wH+0eL54OP1YMne0OMgJtCvKmfc1siA+RbfjMun6MgVGdtT6u73NxxABLzFiPU3KCj30N/h0hDmBGH3lXr1awndJErSnY4HHWsn1colMIaCPHGWjngkk3I4gzt8recKD5KqR5LDMBu1Xz0L+ZpnYKkg3fjfjKELOIT7619ohpDOE4Z2bQE0e5ZM1yF9YEyuFqYAcorXUPwrIXzudyrp1RVc4H/7QzdGc4w1i6+dWKv2ZDtVVf4aColPvFKsxgqSsSwTq3UWOrv1rdtuahnHxzFDNgDJZulOA60he9B+WPXdf6Z34Qx38X3alE2Xhb3uNZyJiZ/6KPvAcWkE7sAwTrF7yTvFNqh8IssnF5WGMy3Xyevr+07NVLJ5Cm8ptM4Xbg4ZOiBLbf2bE27xJV70i6GTIsshKjDYIInY3fnKSxJ4IyrK/n9i+7biy6cQyKeqB6sp33hQqpQD8EIYmeJDDtR9EO2ys7CA/cBNk7RCb+zIsXZyEIqBhvbVPf4o6lGgzLht4l6fe3c7pmUdFPMtdnM+91WnQrn3/DimW2US6r3x+HZcBW6WrWSkGp7/lV4LkGIi9+eIJ0ig4GFy/U4Fdu8v8ICEmC+1H+hpaSohMbuXwtyRdORAXt0KY4s4fV147hnEclNWaslpN7rJ29WpHXE8pLzAtOmdUMNdS2BRg+dA4nI7rSdLGyHou1jIgIZt+kkBwZ/dwJ32emdg62OezCNlqBIbUgjIvl/TQHg8JGEioOWHfW29FZrbzxwGrhbmbtwcvFKMTNiozKAADT96fHC/Guc4HnXZ2yhU2Z9aVkG1BjxXPe8WLJYJH8Tsh4jOY7zKbfJY/a9rkq/ODNn2WWLxL/cFrFC0L21Xy9yGM3Qh0R9nbgS+BbXj/GXPjH7pmJdAXSvx9VWyPkvdRBzsO1dqPYVh7UUYwTZr742+nM5DuTOWNoHfiwp2PcCn8eNeDq/8Tdd1yfWtfpwzuN2KMQ/AZi2icODA9bADZAsoXteM06SHhgKbTF+muabEtx2QSVHza1vtUwFUkrNxGhloQctSdoOMfxT6Ek9znbIZm8pfoCq+wVK1q384xcz8rhdVzt76CCgfJ0DZpaY2uOxW9A34dK8WUAiNmCoRQdUQoOm9LUqxR3lssSQ67YJQWcyx7KB7Yce3Bki1j+qkCD/1Zn9RIZ7KjdeV1BLuyY+wZAGLlRWm1l6VWsQxqGniLm3/A/u3J7ONwV02qTHZr13fA962sJKr8GzLuALFNDpRzbaqoNwVdjxNJHIFz0iw4FuHT0QslukK42EUK6n06QC55BqGKG7k7konErJJkSE2Qsrxc0UETK7WRAxCZHBC7dBVO8xqJJzEeH+zamRDMxIqKjMpLtj0Kl3IBJ3K65vHa/zZlsVqxuB8sXjtoAXCmiubEWFWcuaKHK85wuV7jrALgK+PGyOMDiUUG8vIIB7vm6cvr8nO2qSkTxfQ==",
        "mailno": "5300010219368",
        "status": "1",
        "remark": null,
        "msg": "订单创建成功",
    }]
}

订单修改成功

HTTP状态码：200

内容格式：JSON

数据结构

codestring

必填

响应编码

messagestring

必填

响应内容

resultboolean

必填

是否成功

dataarray<object>

必填

返回对象信息

order_serial_nostring

必填

客户订单号

pdf_infostring

必填

pdf参数信息（根据客户的需求返回json格式数据或对json格式进行加密后的数据

mail_nostring

必填

运单号

statusstring

必填

返回状态，1表示成功，0表示失败

msgstring

必填

成功或者错误的提示信息

orderIdstring

必填

remarkstring

必填

响应示例

{
    "code": "0000",
    "message": "请求成功",
    "result": true,
    "data": [{
        "order_serial_no": "0000019876576897",
        "pdf_info": "[[{"order_id":"5160533654","order_serial_no":"test_191021002","partner_id":"2017001068","partner_orderid":"test_191021002","order_type":"common","mailno":"4060005469862","customer_id":"","sender_name":"\u738b\u5c0f\u864e","sender_company":"\u51ef\u5229","sender_area_ids":"","sender_area_names":"\u6c5f\u82cf\u7701\uff0c\u5f90\u5dde\u5e02\uff0c\u65b0\u6c82\u5e02","sender_address":"\u6e56\u4e1c\u8def999\u53f7","sender_postcode":"221435","sender_phone":"021-85926525","sender_mobile":"13761960078","sender_branch":"201700","receiver_name":"\u9646\u5927\u6709","receiver_company":"\u5343\u5343","receiver_area_ids":"310118","receiver_area_names":"\u4e0a\u6d77\u5e02,\u4e0a\u6d77\u5e02,\u9752\u6d66\u533a","receiver_address":"\u4e0a\u6d77\u5e02\u9752\u6d66\u533a\u76c8\u6e2f\u4e1c\u8def6633\u53f7","receiver_postcode":"201700","receiver_phone":"020-57720341","receiver_mobile":"13761960075","receiver_branch":"200230","weight":"11.00","remark":"","status":"rs10","time":"2019-10-21 11:16:26","position_no":"G096-00 20","position_zz":"0","options":"","send_num":"0","nb_ckh":"2001123","cus_area1":"\u8ba2\u5355\u53f7:test_191021002\n\u8ba2\u5355\u53f7\uff1a123 \n\u6279\u6b21\u53f7\uff1a456212","cus_area2":"","position":"300","receiver_flag":"1","package_wd":"J200000","callback_id":"","wave_no":"","node_id":"","ems_flag":"","cus_area3":"","trade_code":"","shi1":null,"sheng1":null,"shi2":"310100","sheng2":"310000","collection_value":"100.00","value":"20.00","zffs":"0","innerProvinceName":"\u7701\u5185\u4ef6","package_wdjc":"\u96c6\u5305\u5730\uff1a\u4e0a\u6d77\u5206\u62e8\u5305  ","sender_branch_jc":"\u9752\u6d66\u533aYD","bigpen_code":"G096-00","lattice_mouth_no":"20","mailno_barcode":"406000546986204240","tname":"mailtmp_s12","dispatch_code":"20","qrcode":"4060005469862\/300 G096-00 20","privacy_receiver_name":"\u9646**","privacy_receiver_phone":"020-****0341","privacy_receiver_mobile":"137****0075"},["0424",0]]]",
        "mailno": "5300010219368",
        "status": "1",
        "remark": null,
        "msg": 订单修改成功
    }]
}

失败

HTTP状态码：200

内容格式：JSON

数据结构

codestring

必填

响应编码

messagestring

必填

响应内容

resultboolean

必填

是否成功

dataarray<object>

必填

返回对象信息

order_serial_nostring

必填

客户订单号

pdf_infostring

必填

pdf参数信息（根据客户的需求返回json格式数据或对json格式进行加密后的数据

mail_nostring

必填

运单号

statusstring

必填

返回状态，1表示成功，0表示失败

msgstring

必填

成功或者错误的提示信息

orderIdstring

必填

remarkstring

必填

响应示例

{
    "result": false,
    "code": "7777",
    "message": "内部接口服务失败",
    "sub_code" "s10",
    "sub_msg": "参数校验不合法"
}

最后更新: -

POST电子面单余量查询

POST电子面单打印