易速国际物流包裹接口操作说明

本接口用于创建、修改及删除包裹数据,最后更新于2014.05.20
请将参数以POST方式传到这个地址:
http://api.espeedpost.com/shipping/

参数说明(未注明"可选"字段均为必选)

验证信息:
devid由我司提供给第三方软件或网站(须正确提供DevID,如无DevID请填写EspeedPost)
appid由我司提供给物流客户(须正确提供AppID)
appkey由我司提供给物流客户(须正确提供AppKey,如无可留空)
未开通API的用户,请在易速系统中进入我的易速->我的帐户页面,在“API帐号”下申请。
基本参数:
todo指定动作,默认为create - 创建包裹数据。
create - 创建包裹数据(缺省值)
edit - 编辑包裹数据(订单数据中须传入sn值)
delete - 删除包裹数据(订单数据中须传入sn值)
sendname指定使用的回邮姓名序号,0=第一个,1=第二个,类推;XX=随机。 注:默认使用第一个回邮姓名。
notify是否发送通知邮件给收件人(可选)
Y - 发送(仅当传入收件人邮件地址email且客户在我司物流系统中开通了邮件通知功能时才有效)
N - 不发送(默认不发送通知邮件)
combine是否合并包裹数据(可选)
Y - 合并(将当次传入订单数据中同一收件人的订单数据合并为一个包裹数据)
N - 不合并(默认不合并包裹数据)
errorignore是否忽略错误(可选)
Y - 忽略(当次传入订单数据中,检测到部分数据不符合要求的,不影响其它订单数据生成包裹数据)
N - 不忽略(默认,当次传入订单数据中,检测到部分数据不符合要求的,返回错误信息,不生成包裹数据)
订单数据:
status数据初始状态(可选)
2 - 已经确认(默认,订单数据传入时数据状态设为“已经确认”并分配跟踪条码(如有))
1 - 未经确认(订单数据传入时数据状态设为“未经确认”)
format订单数据格式,默认为JSON格式。
json - JSON格式数据,默认
xml - XML格式数据
orders订单数据集合。如果一次只传入一个订单数据,也可以忽略该值,直接传入订单参数(同之前版本一样)。
JSON格式:{"order":[{订单1},{订单2},{订单3},...,{订单n}]}。每个{订单}数据的具体格式为{"参数1":"值","参数2":"值","参数3":"值",...,"参数n":"值"}。如果参数值包含有多项数据的,则{订单}格式为{"参数1":["数据1","数据2","数据3",...,"数据n"],"参数2":"值","参数3":["数据1","数据2","数据3",...,"数据n"],...,"参数n":"值"}
XML格式:<orders><order>订单1</order><order>订单2</order><order>订单3</order>...</orders>。每个<order>订单</order>数据的具体格式为<order><参数1>值</参数1><参数2>值</参数2><参数3>值</参数3>...</order>。如果参数值包含有多项数据的,则<order>订单</order>数据的具体格式为<order><参数1><参数1_1>值</参数1_1><参数1_2>值</参数1_2><参数1_3>值</参数1_3>...</参数1><参数2><参数2_1>值</参数2_1><参数2_2>值</参数2_2><参数2_3>值</参数2_3>...</参数2>...</order>
每个订单数据的详细参数如下:
订单参数:
no客户自定义包裹号(可选) 注:同一帐户下,该值不允许重复
sn包裹编号(可选) 注:创建包裹时该值被忽略;编辑、删除包裹数据时必须传入该值
ordernumber订单号(可选)
method运输方式(如HKA、HKR、CNA、CNR等,如未定义,则默认为HKA,请参看《易速国际物流货运代码总表》)
service服务类别(默认为BGA,请参看《易速国际物流货运代码总表》)
我司系统货运代码请查阅:
http://api.espeedpost.com/methodservice
sellerid卖家ID(可选)
buyerid买家ID(可选)
ebayid卖家的eBay用户名(可选)
ebaysalesrecordnumber卖家的eBay销售记录号(可选)
ebayorderid卖家的eBay订单号(可选)
ebaytransactionid卖家的eBay交易号(可选)
传入上述4个值后客户可使用我司系统自动标记发货功能
paypaltransactionidPayPal交易号(可选)
itemid销售平台产品编号(可选)
如果有多个itemid,JSON格式为{"itemid":["数据1",...,"数据n"]}或{"itemid":{"itemid_1":"数据1","itemid_2":"数据2"..."itemid_n":"数据n"}},XML格式为<itemid><itemid_1>数据1</itemid_1><itemid_2>数据2</itemid_2>...<itemid_n>数据n</itemid_n></itemid>,最多允许10个值。
itemtitle销售平台产品标题(可选)
如果有多个itemtitle,格式参考itemid的格式。
itemcount销售平台产品数量(可选)
如果有多个itemcount,格式参考itemid的格式。
label自定义产品代码(可选,类似eBay中的Custom Label值,该字段名称也可以是“itemlabel”、“sku” 或 “itemsku”)
如果有多个label,格式参考itemid的格式。
产品代码可显示在打印出来的地址标签上,便于打包时拣选物品
category申报类别(可选,默认为G-礼物)
G - 礼物
D - 文件
S - 商用样本
O - 其它
categorycontent申报类别名称(可选)
当category值为O-其它时,应传入该值,默认为"Other"
description英文申报名称(挂号,快递件必选,长度限制30个字符内)
如果有多个申报名称,格式参考itemid的格式,最多允许4个值。
description_cn中文申报名称(可选)
如果有多个申报名称,格式参考itemid的格式,最多允许4个值。
quantity申报数量(挂号,快递件必选,默认为1)
如果有多个与申报名称对应的申报数量,格式参考itemid的格式,最多允许4个值。
weight1申报重量(挂号,快递件必选,默认为0.1KG)
如果有多个与申报名称对应的申报重量,格式参考itemid的格式,最多允许4个值。
value1申报价值(总价值,不是单价!挂号,快递件必选,默认为10美元)
如果有多个与申报名称对应的申报价值,格式参考itemid的格式,最多允许4个值。
money申报价值货币单位三位代码(默认为USD)
美元 - USD
英镑 - GBP
欧元 - EUR
加元 - CAD
澳元 - AUD
recipient收件人姓名(注:JSON格式数据也可传入name;XML格式必须传入recipient或fullname,不能使用name作为节点名称)
address1收件人地址行1
address2收件人地址行2(可选)
city收件人城市
state收件人省份/州
zip收件人邮编(如有)
tel收件人电话(国际快递件DHL、UPS、Fedex必选)
mobile收件人手机号(可选)
destination目的国家两位代码
如未提供综合地址(address),必须提供分解地址(address1,address2,city,state,zip,tel等)
如提供了完整的分解地址,可省略综合地址,由系统自动生成
发往US,CA,AU,JP,IN等国家的香港邮政国际小包(HKA,HKR)必须单独传入邮编(zip)用于分区
国际快递件(DHL,UPS,Fedex)必须单独传入收件人电话(tel)
香港邮政挂号包裹(HKR)地址单行长度不能超过60个字符,行数不能超过5行
email收件人电子邮件地址(可选)
stock是否库存发货(可选)
若库存发货,传入"Y",默认为"N"。
insured是否购买保险(可选)
若购买保险,传入"Y",默认为"N"。目前仅针对香港挂号提供保险服务。
ifreturn是否需要退件(可选)
默认为"Y"-需要退件。若放弃退件,传入"N"。
trackingnumber跟踪条码(可选,如需要由系统自动分配,该值请留空)
跟踪条码指承运商跟踪条码,如邮政挂号条码,国际快递运单号等,一般由我司系统自动生成或操作人员收寄包裹时录入
note备注信息(可选)

注意事项

1.如果使用XML格式,字符“<”和“&”是禁止使用的,否则解析器无法识别,应分别转换为“&lt;”和“&amp;”再传入数据。
2.如果使用XML格式,收件人姓名不能使用<name>Buyer Fullname</name>作为节点名称,须改为<recipient>Buyer Fullname</recipient>。

示例

http://api.espeedpost.com/shipping/?todo=create&devid=EspeedPost&appid=800100xx-1234567890xxxxxx&method=HKA&service=BGA&destination=US&zip=10100&recipient=Mao%20Faren&address=shipping%20address&email=maofaren@espeedpost.com&tel=123333&itemid_1=34434&itemcount_1=2&itemtitle_1=title&label_1=label1&description_1=ABC&quantity_1=3&value1_1=32&weight1_1=1.0

返回值

提交数据后,系统将返回一组JSON或XML格式数据
result数据添加结果:成功返回'success',失败返回'failure',部分成功返回'warning',错误返回'error'
message返回提示信息
sn返回包裹编号(创建包裹时返回新建包裹编号、编辑或删除包裹时返回对应包裹编号)
trackingnumber返回包裹跟踪条码
zone目的国家所属分区(如有)
summary返回综合操作结果
detail返回详细操作结果

########################################################################
########################################################################
########################################################################

易速国际物流地址标签接口操作说明

该接口用于打印指定包裹的地址标签
将参数以POST方式传到这个地址:
http://api.espeedpost.com/label/ 或 http://112.124.100.243:805

参数说明

devid由我司提供给第三方软件或网站(须正确提供DevID,如无DevID请填写EspeedPost)
appid由我司提供给物流客户(须正确提供AppID)
appkey由我司提供给物流客户(须正确提供AppKey,如无可留空)
未开通API的用户,请在易速系统中进入我的易速->我的帐户页面,在“API帐号”下申请。
sn要打印地址的包裹号或跟踪条码,多个值以半角逗号分隔
layout打印排版,默认为热敏10*10CM;如果以A4纸打印,传入“A4”
customs是否同时打印报关单,默认打印;如果不打印报关单,传入“N”
ordersize是否打印订单号,默认不打印;如果要打印订单号,传入“1或2或3”,1表示小字体,2表示中字体,3表示大字体

返回值

错误返回 Error
成功返回 二进制PDF文件流

示例

http://api.espeedpost.com/label/?devid=EE95-74xxx&appid=800xxxxx-1234567890&appkey=&sn=200000000&layout=A4&customs=N
########################################################################
########################################################################
########################################################################

易速国际物流包裹查询接口操作说明

该接口用于查询包裹数据:订单信息、物流信息、跟踪信息等
将参数以POST方式传到这个地址:
http://api.espeedpost.com/tracking/
返回值为 xml 数据

查询参数说明

devid由我司提供给第三方软件或网站(须正确提供DevID,如无DevID请填写EspeedPost)
appid由我司提供给物流客户(须正确提供AppID)
appkey由我司提供给物流客户(须正确提供AppKey,如无可留空)
未开通API的用户,请在易速系统中进入我的易速->我的帐户页面,在“API帐号”下申请。
sn我司包裹编号,为10位纯数字,如2005265844
no客户自定义包裹编号
status包裹状态
0 - 暂不处理
1 - 未经确认
2 - 已经确认
3 - 已经交寄
4 - 已经收寄
5 - 正在处理
6 - 投寄完成
date处理日期
格式:YYYY-MM-DD
trackingnumber包裹跟踪条码
note包裹备注信息
perpage每页显示最大包裹数量(当次返回最大包裹数量),最大不超过20
page页码,当包裹总数量超过perpage值时,分别传入页码1、2、3...依次分批获取数据

返回结果说明

status包裹最新状态代码
10 - 取消或无效
11 - 数据未确认
12 - 数据已确认
13 - 数据已提交
14 - 我司已收寄
15 - 我司处理中
16 - 交寄给承运商
21 - 上网
22 - 离港
23 - 到达目的国
24 - 收件人签收(妥投)
31 - 退回易速
32 - 退回客户
trackingnumber跟踪号
trackingnumber1转单号

查询示例

http://api.espeedpost.com/tracking/?devid=EspeedPost&appid=80010000-xxxx&appkey=xxxxxxxxx&sn=2009123123




########################################################################
########################################################################
########################################################################

易速国际物流eBay API数据查询接口操作说明

该接口用于查询eBay API原始数据
将参数以POST方式传到这个地址:
http://api.espeedpost.com/ebay/
返回值为 xml 数据

参数说明(未注明"可选"字段均为必选)

devid由我司提供给第三方软件或网站(须正确提供DevID,如无DevID请填写EspeedPost)
appid由我司提供给物流客户(须正确提供AppID)
appkey由我司提供给物流客户(须正确提供AppKey,如无可留空)
未开通API的用户,请在易速系统中进入我的易速->我的帐户页面,在“API帐号”下申请。
ebayid卖家eBay帐号,可选
ebaysalesrecordnumbereBay销售编号,可选
buyerid买家eBay帐号,可选
itemid物品编号,可选
date处理日期,可选
格式:YYYY-MM-DD
perpage每页显示最大包裹数量(当次返回最大包裹数量),最大不超过20,可选
page页码,当包裹总数量超过perpage值时,分别传入页码1、2、3...依次分批获取数据,可选

查询结果说明

示例

http://api.espeedpost.com/ebay/?devid=EE95-74xxx&appid=80010000-xxxx&appkey=

########################################################################
########################################################################
########################################################################

易速国际物流运费接口操作说明

该接口用于计算运费
将参数以POST方式传到这个地址:
http://api.espeedpost.com/fee/

参数说明

devid由我司提供给第三方软件或网站(须正确提供DevID,如无DevID请填写EspeedPost)
appid由我司提供给物流客户(须正确提供AppID)
appkey由我司提供给物流客户(须正确提供AppKey,如无可留空)
未开通API的用户,请在易速系统中进入我的易速->我的帐户页面,在“API帐号”下申请。
format返回数据格式,默认为JSON数据,如需返回XML数据,请传入XML
sn包裹序号或跟踪条码(可选,包裹序号为我司系统返回的10位数字,也可以传入跟踪条码)
如有提供该值,将忽略下面的参数、并返回所指定包裹的实际运费
method运输方式(如HKA、HKR、CNA、CNR等,默认为HKA,请参看《易速国际物流货运代码总表》)
service服务类别(默认为BGA,请参看《易速国际物流货运代码总表》)
我司系统货运代码请在此下载:
http://www.espeedpost.com/download.php?fdoc=download/docs/易速国际物流货运代码总表.xls&tdoc=易速国际物流货运代码总表.xls
如果没有传入method及service值,则返回所有可用运输服务的价格,按金额由低到高排列。
destination两位国家代码,如US,GB,DE
zip邮编(可省略,用于检测偏远)
weight重量,公斤
sizeL体积长度,厘米,可省略
sizeW体积宽度,厘米,可省略
sizeH体积高度,厘米,可省略

示例

http://api.espeedpost.com/fee/?devid=EE95-74xxx&appid=800xxxxx-1234567890&method=HKA&service=BGA&destination=US&zip=10100&weight=1.0&sizeL=44&sizeW=44&sizeH=56
########################################################################
########################################################################
########################################################################

易速国际物流国家代码接口操作说明

该接口用于获取我司系统国家代码及国家名称列表
http://api.espeedpost.com/country/
返回值为 xml 数据
########################################################################
########################################################################
########################################################################

易速国际物流运输服务代码接口操作说明

该接口用于获取我司系统运输服务代码及名称列表
http://api.espeedpost.com/methodservice/
返回值为 xml 数据