韵达开放平台 API
接口简介
API鉴权说明
快递投放
校验运单号手机号
POST
禁投第三方校验
POST
电子面单
包裹信息接入
POST
电子面单取消
POST
电子面单下单
POST
电子面单余量查询
POST
电子面单更新
POST
电子面单打印
POST
停发查询
POST
散件下单
运单推送接口
POST
取消散件订单（新）
POST
预估运费
POST
散件下单(新)
POST
物流轨迹
物流轨迹推送
POST
物流轨迹查询
POST
物流轨迹订阅
POST
售后服务
物流工单下发
POST
国际件
国际进口下单
POST
外部发券
外部直发券
POST
发券结果查询
POST
国际进口下单开发中
POST/openapi/outer/api/v1/order/push
创建时间: 2025-06-03 00:39
请求参数
Header 参数
| 参数名 | 示例值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| app-key | {{app-key}} | 是 | string | 开放平台发放 |
| sign | {{sign}} | 是 | string | 签名说明参看附录《鉴权说明》 |
| req-time | {{$timestamp}} | 是 | string | 当前时间戳（毫秒） |
Body 参数application/json
数据结构
未定义
示例数据
{
"account": "接口账号",
"orders": [
{
"codValue": 货到付款金额,
"currencyCode": "货币代码，详情见货币代码附录",
"customerReference1": "客户参考号1",
"customerReference2": "客户参考号2",
"duties": 关税,
"freight": 运费,
"insurance": 保费,
"isCOD": "是否货到付款，默认N否，Y是",
"isInsured": "是否保价，默认N否，Y是",
"orderStatus": "订单类别，A新增、M修改、X取消",
"parcelType": "包裹类别，DOC文件，SPX包裹",
"receiver": {
"addressLine1": "收件人地址1",
"addressLine2": "收件人地址2",
"addressLine3": "收件人地址3",
"city": "收件人城市",
"company": "收件人公司",
"countryCode": "收件人国家二字码",
"district": "收件人区",
"emailAddress": "收件人邮箱",
"houseName": "收件人房屋名",
"houseNo": "收件人门牌号",
"mobile": "收件人手机号",
"name": "收件人姓名",
"phoneNumber": "收件人联络电话",
"postalCode": "收件人邮编",
"state": "收件人州/省",
"streetName": "收件人街道名"
},
"items": [
{
"declaredDescription": "商品描述（按目的国语言填写）",
"goodsDescription": "商品描述（按始发国语言填写）",
"goodsLink": "商品链接",
"hsCode": "海关编码",
"originCountry": "商品内容产地国二字码",
"quantity": 商品数量,
"skuCode": "商品sku",
"unitPrice": 商品单价,
"volume": 商品体积,
"weight": 商品重量
}
],
”recipientIDType”:”证件类型，zj01身份证，zj02护照”,
"recipientID": "证件号码",
"remarks": "订单备注",
"returnInfo": {
"addressLine1": "退回地址1",
"addressLine2": "退回地址2",
"addressLine3": "退回地址3",
"city": "退回城市",
"company": "退回公司名称",
"countryCode": "退回国家二字码",
"district": "退回区",
"emailAddress": "退回邮件地址",
"houseName": "退回房屋",
"houseNo": "退回门牌号",
"mobile": "退回手机",
"name": "退回人姓名",
"phoneNumber": "退回移动电话",
"postalCode": "退回邮编",
"state": "退回州/省",
"streetName": "退回街道名"
},
"salesChannel": "销售渠道（订单来源）",
"sender": {
"addressLine1": "发件人地址1",
"addressLine2": "发件人地址2",
"addressLine3": "发件人地址3",
"city": "发件人城市",
"company": "发件人公司",
"countryCode": "发件人国家二字码",
"district": "发件人区",
"emailAddress": "发件人邮件地址",
"houseName": "发件人房屋",
"houseNo": "发件人门牌号",
"mobile": "发件人手机",
"name": "发件人姓名",
"phoneNumber": "发件人移动电话",
"postalCode": "发件人邮编",
"state": "发件人州/省",
"streetName": "发件人街道名"
},
"shipmentHeight": 包裹高,
"shipmentLength": 包裹长,
"shipmentOrderNO": "客户订单号",
"shipmentVolume": 包裹体积,
"shipmentWeight": 包裹重量,
"shipmentWidth": 包裹宽度,
"taxes": 税,
"totalDeclaredValue": 包裹总申报价值,
"trackingNumber": "韵达运单号",
"warehouseCode": "客户发货仓库代码"
}
],
"reqType": "业务类别，CHINA_IMPORT进口业务",
"secret": "秘钥（md5(接口账号+接口密码)）"
}响应示例
成功
HTTP状态码：200
内容格式：JSON
数据结构
未定义
响应示例
{
"code": "0000",
"message": "请求成功",
"result": true,
"data": [
{
"shipmentOrderNO": "TEST001",
"trackingNumber": "7790000005848",
"code": 200,
"msg": "创建订单成功",
"pdfInfo": [
[
{
"lattice_mouth_no": "",
"shift": "",
"sender_name": "test001",
"sender_mobile": "11111111111",
"collection_value": "",
"shift_mailno": "",
"originating_center": "",
"options": "",
"sender_area_ids": "420112",
"three_code": "",
"order_type": "gss",
"status_remark": "",
"sender_branch": "000002",
"create_time": "2021-09-01 17:06:59",
"receiptOne": "",
"weight": "",
"trade_code": "",
"mailno_barcode": "7790004023650",
"order_serial_no": "3363017168afc11c056f177af324ccb2",
"receiver_area_names": "null,四川省成都市,null",
"mailno": "7790004023650",
"cus_area2": "",
"cus_area1": "订单号:TEST202105255555\n",
"size": "0.0,0.0,0.0",
"receiptNo": "",
"position": "812",
"cus_area3": "",
"status": "rs10",
"package_wdjc": "成都东地区包",
"receiver_company": "",
"zffs": "0",
"sender_phone": "11111111111",
"receiver_flag": 1,
"partner_orderid": "TEST202105255555",
"qrcode": "7790004023650/812",
"freight": "",
"shi1": "420100",
"sender_area_names": "null,湖北省武汉市,null",
"remark": "",
"shi2": "",
"sheng1": "420000",
"receiptFour": "",
"sheng2": "",
"receiptThree": "",
"partner_id": "1998854995",
"premium": "",
"sender_company": "",
"tp_status": "",
"other_charges": "",
"position_zz": "",
"receiver_name": "张三",
"package_wd": "J999417",
"position_no": "",
"dispatch_code": "",
"value": "3218.00",
"baima_tname": "TMPL_COMM",
"receiver_country_id": "CN",
"receiptTwo": "",
"two_code": "",
"sender_country_id": "CN",
"mail_type": "gss",
"receiver_area_ids": "510100",
"ems_flag": "",
"tname": "mailtmp_s116",
"sender_postcode": "",
"receiver_mobile": "11111111111",
"receiver_branch": "",
"sender_address": "湖北省武汉市,武汉东西路23号",
"one_code": "812",
"innerProvinceName": "",
"receiptPackage": "",
"four_code": "",
"receiver_postcode": "",
"bigpen_code": "",
"receiver_address": "四川省成都市,测试",
"receiver_phone": "",
"customer_id": "1998854995",
"wave_no": "",
"node_id": "351"
},
[ "1111", "1" ]
]
]
},
{
"shipmentOrderNO": "TEST002",
"code": 400,
"msg": "【国家请填写国家二字码】;",
"errorFileds": [
{
"msg": "国家请填写国家二字码",
"field": "sender.countryCode"
}
]
},
{
"shipmentOrderNO": "TEST003",
"code": 429,
"msg": "订单已存在,请调用更新接口",
"trackingNumber": "7790000000001",
"pdfInfo": "[[{\"order_serial_no\":\"911e6c53bc2cf724333dde51959d9c3d\",\"partner_id\":\"1998854995\",\"partner_orderid\":\"202106110051\",\"order_type\":\"gss\",\"sender_name\":\"test001\",\"sender_phone\":\"11111111111\",\"sender_mobile\":\"11111111111\",\"sender_area_names\":\"null,\\u6e56\\u5317\\u7701\\u6b66\\u6c49\\u5e02,null\",\"sender_address\":\"\\u6e56\\u5317\\u7701\\u6b66\\u6c49\\u5e02,\\u6b66\\u6c49\\u4e1c\\u897f\\u8def23\\u53f7\",\"sender_postcode\":\"\",\"sender_company\":\"\",\"receiver_name\":\"\\u5f20\\u4e09\",\"receiver_phone\":\"\",\"receiver_mobile\":\"11111111111\",\"receiver_area_names\":\"null,\\u56db\\u5ddd\\u7701\\u6210\\u90fd\\u5e02,null\",\"receiver_address\":\"\\u56db\\u5ddd\\u7701\\u6210\\u90fd\\u5e02,\\u6d4b\\u8bd5\",\"receiver_postcode\":\"\",\"receiver_company\":\"\",\"node_id\":\"351\",\"cus_area1\":\"\\u8ba2\\u5355\\u53f7:202106110051\\n\",\"cus_area2\":\"\",\"cus_area3\":\"\",\"wave_no\":\"\",\"collection_value\":\"\",\"zffs\":\"0\",\"weight\":\"\",\"value\":\"3218.00\",\"size\":\"0.0,0.0,0.0\",\"freight\":\"\",\"premium\":\"\",\"other_charges\":\"\",\"remark\":\"\",\"customer_id\":\"1998854995\",\"sender_country_id\":\"CN\",\"receiver_country_id\":\"CN\",\"shift\":\"\",\"shift_mailno\":\"\",\"sender_branch\":\"1001\",\"create_time\":\"2021-06-11 13:47:00\",\"status\":\"rs10\",\"sender_area_ids\":\"420112\",\"status_remark\":\"\",\"one_code\":\"812\",\"two_code\":\"\",\"three_code\":\"\",\"four_code\":\"\",\"receiver_branch\":\"\",\"package_wd\":\"J999417\",\"package_wdjc\":\"\\u6210\\u90fd\\u4e1c\\u5730\\u533a\\u5305\",\"options\":\"\",\"trade_code\":\"\",\"ems_flag\":\"\",\"receiver_area_ids\":\"510100\",\"receiver_flag\":1,\"mailno\":\"7790000000001\",\"shi1\":\"420100\",\"sheng1\":\"420000\",\"shi2\":\"\",\"sheng2\":\"\",\"innerProvinceName\":\"\",\"mail_type\":\"gss\",\"mailno_barcode\":\"7790000000001\",\"tname\":\"gss\",\"baima_tname\":\"TMPL_COD\",\"position\":\"812\",\"bigpen_code\":\"\",\"lattice_mouth_no\":\"\",\"dispatch_code\":\"\",\"position_no\":\"\",\"qrcode\":\"7790000000001\\/812\",\"position_zz\":\"\",\"tp_status\":\"\",\"originating_center\":\"\",\"receiptNo\":\"\"},[\"1111\",\"1\"]]]"
}
]
}失败
HTTP状态码：200
内容格式：JSON
数据结构
未定义
响应示例
{
"result": false,
"code": "7777",
"message": "内部接口服务失败",
"sub_code" "s10",
"sub_msg": "参数校验不合法"
}最后更新: -