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

电子面单下单

POST
/v1/accountOrder/createBmOrder

接口描述#


大客户电子面单下单,支持韵达大客户系统和白马系统
客户需要打印的自定义信息请放到自定义字段,目前支持2个自定义字段:
1.自定义区域1:打印拣货信息或者商品信息,例如订单号,商品名称,规格,数量
2.自定义区域2:买家或卖家留言信息

商品类型 special 字段#

类型说明
0文件类
1电子产品类(包括家用电器)
2办公用品类, 服装鞋帽,箱包类
3化妆品,美容产品类
4珠宝,手表,眼镜,贵重饰品类
5食品,保健药品类
6工艺品类(包括瓷器,茶具,烹饪用品)
7玩具乐器类
8其他类
order_type 定义字典表
参数名说明
common普通
注:order_type可以为空,当order_type为空时,默认值为common
增值服务类型Value解释
INSUREDvalue:金额保价
DFvalue:金额到付
RETURNvalue:1,2(1:签名,2:盖章,3:登记身份证)签单返回(需要哪个,选择哪个,接口返回回执单号receiptNo)
CODvalue:金额代收货款订单类型会变成cod,609号段 注意cod库存
PRI无value隐私面单
VIR无value隐私小号
MULvalue:总单量多票同配
CONTACT无value派前电联

pdf_info重点字段说明#

1.pdf_info为加密报文时,可以联系开通大客户账号网点配置为不加密 2.部分用户解析pdf_info取三段码困难,可在帮助中心搜索电子面单接口如何取出三段码,参考给出java示例#

参数参数说明
position一段码
position_no二段码和三段码
tp_status四段码
package_wdjc集包地
电子面单模板
一联单标准模板(130*76)
img
二联单标准模板(180*100)
img
韵达标准模板(203*101)
img
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi.yundaex.com/openapi-api/v1/accountOrder/createBmOrder' \
--header 'app-key;' \
--header 'sign;' \
--header 'req-time;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appid": "999999",
    "partner_id": "201700101001",
    "secret": "123456789",
    "orders": [
        {
            "collect_branch": "",
            "collection_value": 126.5,
            "cus_area1": "",
            "cus_area2": "",
            "isProtectPrivacy": "",
            "items": [
                {
                    "name": "衣服",
                    "number": 1,
                    "remark": "袜子"
                }
            ],
            "khddh": 2012121715001,
            "node_id": "350",
            "order_serial_no": 2012121715001,
            "order_type": "common",
            "platform_source": "",
            "receiver": {
                "address": "上海市,青浦区,盈港东路 6679 号",
                "city": "上海市",
                "company": "",
                "county": "青浦区",
                "mobile": "17601206977",
                "name": "李四",
                "province": "上海市"
            },
            "remark": "",
            "sender": {
                "address": "上海市,青浦区,盈港东路 7766 号",
                "city": "上海市",
                "company": "",
                "county": "青浦区",
                "mobile": "17601206977",
                "name": "张三",
                "province": "上海市"
            },
            "size": "0.12,0.23,0.11",
            "special": 0,
            "value": 126.5,
            "weight": 0,
            "multi_pack": {
                "mulpck": "",
                "total": 0,
                "endmark": 0
            },
            "markingInfos": [
                {
                    "type": "INSURED",
                    "markingValue": {
                        "value": 2100
                    }
                },
                {
                    "type": "DF",
                    "markingValue": {
                        "value": 15
                    }
                },
                {
                    "type": "COD",
                    "markingValue": {
                        "value": 15
                    }
                },
                {
                    "type": "RETURN",
                    "markingValue": {
                        "value": "1,2"
                    }
                },
                {
                    "type": "PRI"
                },
                {
                    "type": "VIR"
                },
                {
                    "type": "MUL",
                    "markingValue": {
                        "value": 10
                    }
                },
                {
                    "type": "CONTACT"
                }
            ]
        }
    ]
}'
响应示例响应示例
200 - 成功 - 成功示例1
{
    "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==",
            "mail_no": "5300010219368",
            "status": "1",
            "remark": null,
            "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 {22}] 
订单详情
必需
collect_branch
string 
揽件网点编码
可选
collection_value
number 
可选
代收货款金额 目前仅用于cod订单,cod订单必填
cus_area1
string 
可选
可以自定义显示信息1,打印在客户自定义区域1,换行请用\n
cus_area2
string 
可选
可以自定义显示信息2,打印在客户自定义区域2,换行请用\n
isProtectPrivacy
string 
可选
判断订单是否是隐私订单,如果是隐私订单把收件人姓名和电话进行脱敏处理(1表示是,0表示否)隐私面单业务对接需与韵达方确认业务需求
items
array [object {3}] 
商品信息集合
可选
khddh
integer 
必需
大客户系统订单的订单号可与订单唯一序列号相同
node_id
string 
350(默认)
必需
order_serial_no
integer 
必需
订单唯一序列号 由字母、数字、下划线组成,必须保证唯一,请对特殊符号进行过滤
order_type
string 
必需
运单类型参数值对照order_type字典表可固定为common
platform_source
string 
平台来源
可选
receiver
object 
收件人
必需
remark
string 
备注
可选
sender
object 
寄件人信息
必需
size
string 
物品大小(单位米)
可选
special
integer 
可选
商品类型保留字段,暂时不用(见商品类型字段)
value
number 
货物金额
可选
weight
number 
物品重量
可选
wave_no
string 
可选
客户波次号,按照此号进行批量打印校验,批量下单时,此波次号需要相同
other_charges
number 
其他费用
可选
multi_pack
object 
一票多件
可选
markingInfos
array [object {2}] 
可选
增值服务标签增值服务必填,json字符串
示例

返回响应

🟢200成功
application/json
Body
code
string 
响应编码
必需
message
string 
响应内容
必需
result
boolean 
是否成功
必需
data
array [object {7}] 
返回对象信息
必需
order_serial_no
string 
客户订单号
必需
pdf_info
string 
必需
pdf参数信息(根据客户的需求返回json格式数据或对json格式进行加密后的数据
mail_no
string 
运单号
必需
status
string 
必需
返回状态,1表示成功,0表示失败
remark
null 
必需
msg
string 
必需
成功或者错误的提示信息
orderId
string 
必需
🟢200失败

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

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

扫码加入交流群
修改于 2021-11-10 04:26:26
上一页
电子面单取消接口
下一页
电子面单余量查询接口
Built with