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

散件下单接口

POST
/v1/order/pushOrder

接口描述#

散件下单接口
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi.yundaex.com/openapi-api/v1/order/pushOrder' \
--header 'app-key;' \
--header 'sign;' \
--header 'req-time;' \
--header 'Content-Type: application/json' \
--data-raw '{
	  "appid": "000001",
	  "backparam": "散单测试",
	  "backurl": "",
	  "freight": 10,
	  "items": [
		{
		  "name": "衣服",
		  "number": 1,
		  "remark": "袜子"
		}
	  ],
	  "other_charges": 0,
	  "premium": 1,
	  "receiver": {
		"address": "青浦区盈港东路 6679 号",
		"city": "上海市",
		"company": "",
		"county": "青浦区",
		"mobile": "17601205970",
		"name": "李四",
		"phone": "",
		"postcode": "string",
		"province": "上海市"
	  },
	  "remark": "string",
	  "sendendtime": "2019-09-03 11:00:00",
	  "sender": {
		"address": "盈港东路 7766 号",
		"city": "上海市",
		"company": "string",
		"county": "青浦区",
		"mobile": "17601205970",
		"name": "张三",
		"phone": "",
		"postcode": "",
		"province": "上海市"
	  },
	  "sendstarttime": "2019-09-03 10:00:00",
	  "size": "0.12,0.23,0.11",
	  "special": 0,
	  "value": 126.5,
	  "weight": 0
}'
响应示例响应示例
200 - 成功 - 成功示例
{
    "result": true,
    "code": "0000",
    "message": "请求成功",
    "data": {
        "backparam": "散单测试",
        "orderid": "14437042180846542"
    }
}

请求参数

Header 参数
app-key
string 
开放平台发放
必需
默认值:
{{app-key}}
sign
string 
必需
签名说明参看附录《鉴权说明》
默认值:
{{sign}}
req-time
string 
当前时间戳(毫秒)
必需
默认值:
{{$timestamp}}
Body 参数application/json
appid
string 
必需
orderid
string 
必需
{ "appid": "000001", "backparam": "散单测试", "backurl": "", "freight": 10, "items": [ { "name": "衣服", "number": 1, "remark": "袜子" } ], "other_charges": 0, "premium": 1, "receiver": { "address": "青浦区盈港东路 6679 号", "city": "上海市", "company": "", "county": "青浦区", "mobile": "17601205970", "name": "李四", "phone": "", "postcode": "string", "province": "上海市" }, "remark": "string", "sendendtime": "2019-09-03 11:00:00", "sender": { "address": "盈港东路 7766 号", "city": "上海市", "company": "string", "county": "青浦区", "mobile": "17601205970", "name": "张三", "phone": "", "postcode": "", "province": "上海市" }, "sendstarttime": "2019-09-03 10:00:00", "size": "0.12,0.23,0.11", "special": 0, "value": 126.5, "weight": 0 }
backparam
string 
原样返回字段
必需
backurl
string 
运单回传地址url
必需
freight
integer 
运费
可选
items
array [object {3}] 
商品信息集合
可选
name
string 
商品名称
可选
number
integer 
数量
可选
remark
string 
说明
可选
other_charges
integer 
其他费用
可选
premium
integer 
保险费
可选
receiver
object 
收件人
必需
address
string 
可选
详细地址 必须添加省市区并以半角逗号隔开
city
string 
收件人市
必需
company
string 
收件人公司
可选
county
string 
收件人区/县
可选
mobile
string 
手机号
可选
name
string 
收件人姓名
必需
province
string 
收件人省份
可选
phone
string 
必需
固定电话固定电话或移动电话至少填一项
postcode
string 
邮编
可选
remark
string 
备注
必需
sendendtime
string 
取件结束时间
可选
sender
object 
寄件人信息
必需
address
string 
必需
详细地址 必须添加省市区并以半角逗号隔开
city
string 
寄件人市
可选
company
string 
寄件人公司
可选
county
string 
寄件人区/县
可选
mobile
string 
手机号
可选
name
string 
寄件人姓名
必需
province
string 
寄件人省份
可选
phone
string 
必需
固定电话 固定电话或移动电话至少填一项
postcode
string 
邮编
可选
sendstarttime
string 
必需
取件开始时间(yyyy-MM-dd HH:mm:ss )
size
string 
可选
货物大小(米),用半角的逗号来分隔长宽高
special
integer 
必需
商品类型(见商品类型字段)
value
number 
货物金额
可选
weight
integer 
物品重量
可选
示例

返回响应

🟢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