您的位置:首页 > 其它

快递在线下单API接口

2016-07-14 00:00 561 查看
摘要: 应用场景:普通用户在线向快递公司在线下单,快递公司收到申请快递员上门取件

获取快递公司列表

接口地址:http://v.juhe.cn/expressonline/test/getCarriers.php

支持格式:json/xml

请求方式:http get/post

请求示例:http://v.juhe.cn/expressonline/test/getCarriers.php?key=APPKEY

接口备注:获取支持的快递公司列表

请求参数说明:

名称
类型
必填
说明
dtype
string

结果数据返回类型(json/xml)
key
string

您申请的appkey
ex_category
string

all: 全部快递公司; recommend:推荐快递公司; agreement 协议快递公司;(默认是all)
返回参数说明:

名称
类型
说明
error_code
int
返回码
reason
string
返回说明
result
string
返回结果集
JSON返回示例:

{
"reason": "查询成功",
"result": [
{
"carrier_code": "ems",/*快递公司代码*/
"carrier_phone": "11183",/*快递公司电话*/
"carrier_name": "EMS"/*快递公司名称*/
},
{
"carrier_code": "zhongtong",
"carrier_phone": "021-39777777",
"carrier_name": "中通快递"
},
{
"carrier_code": "yuantong",
"carrier_phone": "021-69777888",
"carrier_name": "圆通速递"
},
{
"carrier_code": "zjs",
"carrier_phone": "400-6789-000",
"carrier_name": "宅急送"
},
{
"carrier_code": "debang",
"carrier_phone": "400-830-5555",
"carrier_name": "德邦物流"
},
{
"carrier_code": "huitong",
"carrier_phone": "021-62963636",
"carrier_name": "百世汇通"
},
{
"carrier_code": "shunfeng",/*快递公司编码*/
"carrier_phone": "400-811-1111",/*快递公司电话*/
"carrier_name": "顺丰速运"/*快递公司名称*/
},....
],
"error_code": 0
}

XML返回示例:

<?xml version="1.0" encoding="utf-8"?>
<root>
<reason>查询成功</reason>
<result>
<item>
<carrier_code>ems</carrier_code>
<carrier_phone>11183</carrier_phone>
<carrier_name>EMS</carrier_name>
</item>
<item>
<carrier_code>zhongtong</carrier_code>
<carrier_phone>021-39777777</carrier_phone>
<carrier_name>中通快递</carrier_name>
</item>
<item>
<carrier_code>yousu</carrier_code>
<carrier_phone>400-1111-119</carrier_phone>
<carrier_name>优速快递</carrier_name>
</item>
<item>
<carrier_code>quanfeng</carrier_code>
<carrier_phone>400-100-0001</carrier_phone>
<carrier_name>全峰快递</carrier_name>
</item>
<item>
<carrier_code>yuantong</carrier_code>
<carrier_phone>021-69777888</carrier_phone>
<carrier_name>圆通速递</carrier_name>
</item>
<item>
<carrier_code>zjs</carrier_code>
<carrier_phone>400-6789-000</carrier_phone>
<carrier_name>宅急送</carrier_name>
</item>
<item>
<carrier_code>debang</carrier_code>
<carrier_phone>400-830-5555</carrier_phone>
<carrier_name>德邦物流</carrier_name>
</item>
<item>
<carrier_code>huitong</carrier_code>
<carrier_phone>021-62963636</carrier_phone>
<carrier_name>百世汇通</carrier_name>
</item>
<item>
<carrier_code>shunfeng</carrier_code>
<carrier_phone>400-811-1111</carrier_phone>
<carrier_name>顺丰速运</carrier_name>
</item>
</result>
<error_code>0</error_code>
</root>


在线下单发快递

接口地址:http://v.juhe.cn/expressonline/test/expressSend.php

支持格式:json/xml

请求方式:http post

请求示例:http://v.juhe.cn/expressonline/test/expressSend.php?key=APPKEY&send_method=addOrderInfoMes&order_no=......所有参数(请转换成post形式提交)

接口备注:提供两种模式,(1)普通发快递:在线向快递公司在线下单;(2)异步发快递: 用户将订单信息提交到平台

请求参数说明:

名称
类型
必填
说明
dtype
string

结果数据返回类型(json/xml)
key
string

您申请的appkey
send_method
string

接口方法名称
(addOrderInfoMes:普通发快递,
(1)普通用户在线向快递公司在线下单,
(2)快递公司收到申请快递员上门取件;
addOrderInfoAsy:异步发快递,
(1)用户将订单信息提交到开放平台,
(2)开放平台通过订单状态推送用户发件结果,
(3)快递公司收到申请快递员上门取件)
order_no
string

订单编号10-32位唯一的数字字符串(例:20160129121200956523)
isWaybill
string

是否为电子运单( 1 普通订单(默认为1),暂仅支持普通)
carrier_code
string

快递公司编码
sender_name
string

发件人姓名
sender_telphone
string

发件人手机号码
sender_phone
string

发件人固定电话
sender_province_name
string

发件地址省名称
sender_city_name
string

发件地址市名称
sender_district_name
string

发件地址区名称
sender_address
string

发件地址详细信息
sender_post_code
string

发件地址邮政编码
receiver_name
string

收件人姓名
receiver_telphone
string

收件人手机号码
receiver_phone
string

收件人固定电话
receiver_province_name
string

收件地址省名称
receiver_city_name
string

收件地址市名称
receiver_district_name
string

收件地址区名称
receiver_address
string

收件地址详细信息
receiver_org_name
string

收件机构
receiver_post_code
string

收件地址邮政编码
remark
string

备注
item_weight
double

重量(double,单位kg)
item_name
string

货物名称
item_spec
string

规格
send_start_time
string

预约开始时间(时间格式为:yyyy-MM-dd HH:mm:ss)
send_end_time
string

预约结束时间(时间格式为:yyyy-MM-dd HH:mm:ss)
返回参数说明:

名称
类型
说明
error_code
int
返回码
reason
string
返回说明
result
string
返回结果集
JSON返回示例:

{
"reason": "下单成功",
"result": {
"order_no":"20160129121200956523",/*订单编号*/
"carrier_code":"zjs"/*快递公司编号*/
},
"error_code": 0
}


撤销订单

接口地址:http://v.juhe.cn/expressonline/test/cancleSend.php

支持格式:json/xml

请求方式:http post

请求示例:http://v.juhe.cn/expressonline/test/cancleSend.php?key=APPKEY&

接口备注:用户下单后,不想发快递了,可以及时取消;由于快递公司IT系统原因,暂支持 宅急送、优速、百世汇通、圆通、中通、德邦快递公司撤销发件

请求参数说明:

名称
类型
必填
说明
dtype
string

结果数据返回类型(json/xml)
key
string

您申请的appkey
order_no
string

订单编号 10-32位唯一的数字字符串
carrier_code
string

快递公司编码
返回参数说明:

名称
类型
说明
error_code
int
返回码
reason
string
返回说明
result
string
返回结果集
JSON返回示例:

{
"reason": "取消成功",
"result": {
"order_no": "20160129121200956523",/*订单号*/
"carrier_code": "zjs"/*快递公司编码 (宅急送)*/
},
"error_code": 0
}


推送接口设置

接口地址:http://v.juhe.cn/expressonline/test/setPush.php

支持格式:json/xml

请求方式:http post

请求示例:http://v.juhe.cn/expressonline/test/setPush.php?key=APPKEY&

接口备注:用户设置订单状态更新信息推送接口

请求参数说明:

名称
类型
必填
说明
dtype
string

结果数据返回类型(json/xml)
key
string

您申请的appkey
name
string

公司名
state_method
string

订单状态更新推送地址
content_method
string

物流信息更新推送地址
返回参数说明:

名称
类型
说明
error_code
int
返回码
reason
string
返回说明
result
string
返回结果集
JSON返回示例:

{
"reason": "成功的返回",
"result": {
"name": "",/*公司名称或其他说明文字*/
"state_method": "您接收订单状态更新信息推送的接口(例:http://test.com/test.php)",/*订单状态更新推送地址*/
"content_method": "您接收订物流信息更新推送的接口(例:http://test.com/test.php)",/*物流信息更新推送地址*/
"key": APPKEY
},
"error_code": 0
}

/*订单状态推送,数据格式以及参数说明.(注:操作完成后输出:success字符串)*/
{
"orders": [
{
"order_no": "20160201090120458263",/*订单号*/
"carrier_code": "zjs",/*快递公司编码*/
"status": "4",/*订单状态:0:下单成功,1:下单失败,2:撤单成功,3:撤单失败,4:接单成功,5:接单失败,
6:揽收成功,7:揽收失败,8:在途,9:派件扫描,10:签收成功,11:签收失败*/
"time": "2015-01-15 09:33:32",/*操作时间*/
"content": "工业园区网点接单,电话1234568"/*内容*/
}
]
}

/*物流信息推送,数据格式以及参数说明.(注:操作完成后输出:success字符串)*/
{
"orders": [
{
"order": {
"bill_code": "350301727598", /*快递公司运单号*/
"order_no": "20160201090120458263", /*订单号*/
"carrier_code": "zjs", /*快递公司编码*/
"status": "4"
},
"data": [/*物流信息list*/
{
"time": "2014-11-14 15:51:59",/*操作时间*/
"content": "到太原市【太原分拨中心】"/*操作内容*/
},
{
"time": "2014-11-14 01:57:02",
"content": "北京市【北京分拨中心】,正发往【太原分拨中心】"
},
{
"time": "2014-11-14 01:55:27",
"content": "到北京市【北京分拨中心】"
}
]
}
]
}
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息