国际在线产品新版国际在线发运系统API规范.docx
- 文档编号:6240495
- 上传时间:2023-01-04
- 格式:DOCX
- 页数:33
- 大小:27.68KB
国际在线产品新版国际在线发运系统API规范.docx
《国际在线产品新版国际在线发运系统API规范.docx》由会员分享,可在线阅读,更多相关《国际在线产品新版国际在线发运系统API规范.docx(33页珍藏版)》请在冰豆网上搜索。
国际在线产品新版国际在线发运系统API规范
国际在线产品-新版国际在线发运系统API规范
1E邮宝、e包裹、e特快、e速宝API综述1
1.1业务简介1
1.2适用范围1
1.3API功能域分类1
1.4API开发说明1
2E邮宝、e包裹、e特快、e速宝API规范2
2.1SHIP(发运服务)2
2.1.1运单信息接收服务2
2.1.2运单信息验证服务9
2.1.3运单信息取消服务10
2.1.4运单信息查询服务10
2.2TRACK(跟踪信息服务)11
2.2.1实时跟踪信息查询11
2.3RATE(费率服务)11
2.3.1国际E邮宝费率计算11
2.4Address(地址服务)12
2.4.1国内地址行政区划查询12
2.5LABEL(标签服务)13
2.5.1标签静态文件下载服务13
2.5.2批量获取标签服务14
2.5.3批量获取标签服务(增强版)15
3附录16
3.1附录一:
集成及用户权限验证方法16
3.2附录二:
国家和地区名称以及邮编规则16
3.3附录三:
澳大利亚-州列表18
3.4附录四:
版本信息更新记录18
E邮宝、e包裹、e特快、e速宝API综述
1.1业务简介
E邮宝、E包裹、E特快、E速宝API提供在线的运单生成、标签打印、全程跟踪等信息服务,覆盖运单的完整生命周期。
1.2适用范围
具备一定软件开发能力并拥有自建订单系统的大中小型B2C、C2C商家,可根据自身情况,进行个性化的开发,以达到API系统对接的目的。
API基于HTTP协议实现,需要双方系统能够通过internet互联,并使用http方式进行通讯。
本文档描述不涉及具体的开发语言,集成过程可使用合适的编程技术,实现基于http的数据交换方式。
1.3API功能域分类
API数量较多,在后续建设过程中可能不断增加,但总体可划分几个域进行完善和扩充:
SHIP(发运服务)、TRACK(跟踪信息服务)、RATE(费率服务)、ADDRESS(地址服务)、LABEL(标签服务)。
1.4API开发说明
接口入网参数version(版本号)和authenticate(授权码)在一些接口是必填项,具体请参照附录一:
集成及用户权限验证方法
如果您在开发中出现:
商品名称填写中文,但返回错误还是提示“商品中文名称不能为空,且必须包含至少2个汉字”时,请检查在调用api接口时所用的编码方式必须为UTF-8。
E邮宝、e包裹、e特快、e速宝API规范
1.5SHIP(发运服务)
发运服务域包含与运单信息相关的服务,主要包括运单信息接收服务、运单信息验证服务、运单信息取消服务、运单信息查询服务。
运单信息接收服务
资源地址:
HTTP方法:
POST
E邮宝、E包裹、E特快、E速宝(永兴专线)传送内容:
XML格式的订单信息,示例:
xmlversion="1.0"encoding="UTF-8"?
>
xsi="http: //www.w3.org/2001/XMLSchema-instance"> --客户订单号--> --业务类型(默认0)--> --产品种类(默认0)--> --客户代码--> --大客户代码--> --揽收类型上门或者自送--> --电子签收--> --退回--> --体积重量--> 22: 22 --起始预约时间--> 22: 11 --寄件人地址,英文--> --揽收地址,中文--> 返回值: XML格式文档,示例: xmlversion="1.0"encoding="UTF-8"? > E速宝(赛诚专线)传送内容: XML格式的订单信息,示例: xmlversion="1.0"encoding="UTF-8"? > xsi="http: //www.w3.org/2001/XMLSchema-instance"> --客户订单号--> --客户代码--> --大客户代码--> --揽收类型上门或者自送--> --电子签收--> --退回--> --体积重量--> 22: 22 --起始预约时间--> 22: 11 --起始预约时间--> --寄件人地址,英文--> --揽收地址,中文--> --退货地址--> --退回国家--> 注: 1、e速宝赛诚专线的退货地址,国家必填,如果省、市、县、详细地址都不填写则取默认地址。 默认全地址为: StarTrackInternational,38AnnandaleRoadTullamarineVIC3043AUS 退回地址: StarTrackInternational,38AnnandaleRoad 退回地址城市: Tullamarine 退回地址省份: VIC 退回地址邮编: 3043 退回地址国家: AUS 2、澳大利亚-州为固定值,详见附录三。 返回值: XML格式文档,示例: xmlversion="1.0"encoding="UTF-8"? > 入参规范说明: 订单主体信息 orderid string 4-32 订单标识,此标识由使用者提供,应为订单在使用者系统中的唯一标识。 如使用者订单需拆分多个邮包(包裹),时,此标识可重复。 operationtype integer 0|1|2|3 业务类型(默认0,如果不填或者没有该节点就取默认值) 0: e邮宝 1: e包裹 2: e特快 3: e速宝 producttype integer 1|2|3|4 产品种类(默认0) 2: 国际包裹签收 3: 赛程专线 4: 永兴专线 如果选择e包裹业务: 必填2 如果选择e速宝业务: 必填3或4 customercode string 4-64 使用者系统中的客户编码。 即实际提交此订单的用户在使用者系统中的身份标识。 中邮物流平台会依据此信息项对客户进行区分,此项不能为空,但使用者可提供加密或者编码后的客户身份标识。 vipcode string 14 使用者如果拥有EMS大客户代码,应填入此字段 clcttype integer 0|1 揽收类型,1上门揽收或0用户自送 pod boolean false|true 电子签收(目前默认为false) untread string Abandoned|ANDIASSURETOPAYFORTHECHARGEOFRETURN|Returned 退回类型,默认为Returned Abandoned: 丢弃 AND I ASSURE TO PAY FOR THE CHARGE OF RETURN: 保证支付退回的邮件 Returned: 退回 volweight Integer 体积重量=长(单位: 厘米)×宽(单位: 厘米)×高(单位: 厘米)/6000,客户需填写长、宽、高及体积重量 startdate date 2011-03-01T22: 22: 22 起始预约时间 enddate date 2011-03-01T22: 22: 22 终止预约时间 remark string 0-128 备注 sku1 string 0-1024 客户自定义信息1 sku2 string 0-256 客户自定义信息2 barcode String 0-64 订单条码,如果需要打印出标志该订单的条码,就填写该值 printcode Char (00|01|03) 该订单要求的的打印格式,00表示A4,01表示 4×4标签,03表示4×6标签,默认值是01 国内名址信息(寄件人地址sender、揽收地址collect) name string 2-16 姓名 postcode string 6 邮编 phone string 6-36 电话 mobile string 13 手机 country string 固定为CN 国家 province string 6 省份代码 city string 6 城市代码 county string 6 区县代码 company string 0-128 公司 street string 8-256 街道 email string 0-128 电子邮箱 国外名址信息(收件人信息receiver) name string 1-256 姓名(英文) postcode string 0-16 邮编 请查看附录二: 国家和地区名称以及邮编规则 注: 必须按照附录中规则要求验证 phone string 0-50 电话 mobile string 0-50 手机 country string 1-24 国家或地区名称 请查看附录二: 国家和地区名称以及邮编规则 注: 必须填写附录的简称或全称(不区分大小写) province string 1-128 省份(澳大利亚e速宝赛诚专线必须采用附录三的州) city string 1-128 城市 company string 0-128 公司(英文) street string 1-256 街道(英文) street_extra_1 string 1-256 如果地址出现多行时使用这两个字段来存储 street_extra_2 string 1-256 email string 0-128 电子邮箱 货品信息 cnname string 1-64 中文名称(必填,至少包含2个汉字) enname string 1-128 英文名称 count integer 1-99999 数量 unit string 0-16 单位 weight float 0.001-9999.000 重量,千克(三位小数),该重量是单个商品重量*数量 delcarevalue money 0.01-99999.00 报关价格(两位小数),该价格是单个商品的报关价格*数量 origin string 默认为CN 原寄地,固定填写CN description string 0-64 描述(英文) taxationid string 2-10 1、普通税则号: 选填项,填写2-8位的数字 2、e速宝赛诚专线: 选填项,2-10位数字 3、e速宝永兴专线: 必填项,6-10位数字 sellurl string 0-200 销售链接 PS: 各个业务下开通的国家或者地区路向: 1.e邮宝: 美国、澳大利亚、加拿大、法国、英国、俄罗斯、以色列、乌克兰、沙特、巴西德国、挪威 2.e包裹: 美国 3.e特快: 澳大利亚、加拿大、台湾、香港、日本、法国、韩国、巴西、西班牙、乌克兰、新加波、荷兰、俄罗斯、白俄罗斯、英国、德国 4.e速宝(赛诚专线): 澳大利亚 5.e速宝(永兴专线): 德国、美国、法国、英国、荷兰、西班牙、意大利、比利时、卢森堡、爱尔兰、丹麦、希腊、葡萄牙、瑞典、芬兰、奥地利、塞浦路斯、捷克共和国、爱沙尼亚、匈牙利、拉脱维亚、立陶宛、马耳他、波兰、斯洛伐克、斯洛文尼亚、罗马尼亚、保加利亚、克罗地亚 运单信息验证服务 资源地址: HTTP方法: POST 传送内容: 与运单接收服务相同 返回内容: XML文档 成功示例: xmlversion="1.0"encoding="UTF-8"? > 失败示例: xmlversion=”1.0”encoding=”UTF-8”? > 该服务旨在为集成过程中出现的格式、字段类型、字段长度等问题提供帮助,对于运单信息的合规性进行判断和说明。 服务返回结果仅供开发人员参考,因此在正式运行后,不需要每个运单都调用此服务,只在出现问题后,使用此服务排查原因。 运单信息取消服务 资源地址:V00
V01
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 国际 在线 产品 新版 发运 系统 API 规范