文档介绍

一、平台简介

文档目的

本文档编写为全面的说明XRU.COM API主要功能。

目的在于:

为API调用人员提供依据;

为修改、维护提供条件;

本文档的预期读者包括:

软件开发人员;

软件维护人员;

文档说明

本API是XRU.COM推出的提供订单创单、查询及产品列表功能的接口。当前最新版本为1.2.2。

 

1.订单查询

提供属于自己的订单查询,支持所有运输方式。

调用参数及返回值示例

Url:

http://api.xru.com/query/orderQuery.ashx

Param:

account=xxxxxx&secure=xxxxxxxxxxxx&numbers=RC189239239CN%3BC660060527SM%3B&rettype=json

Method:

http   post

Return:

{"ret":0,"message":"","data":[{"dispatchNumber":null,"shopNumber":null,"success":false,"message":"From.country is error."}]}

 

 

传入参数设置

参数名 数据类型 是否必填 说明
account String Y XRU账号ID.获取API时提供。
secure String Y API对接安全码.获取API时提供。
rettype String Y 返回数据格式(xml/json)
numbers String Y 订单号,多个单号用;分开(支持 客户自定义单号、XRU处理单号 单号长度必须六位或以上)

返回参数说明

参数名 数据类型 说明
ret Int 0为成功调用,其他值为失败
message String 调用失败附加信息
data Array 调用成功时返回数据,失败返回空数组
success Boolean 查询结果(true/false)。
errorMessage String 失败原因(成功时为空)。
shopNumber String 客户单号
dispatchNumber String 系统单号
sum Double 订单金额(单位RMB)。
weightSum Double 重量(计价重的重量为准。单位KG)以核
volumeSum Double 体积(立方米)
To    
name String 收件人名称。
tel String 收件人电话。
country String 国家
postcode String 收件人邮编。
region String 收件人省、市、区
street String 收件人街道
unit String 单元,门牌号
From    
name String 发件人名称。
tel String 发件人电话。
country String 发件人国家
postcode String 发件人邮编
region String 发件人省、市、区
street String 发件人街道
unit String 发件人单元,门牌号
transport    
name String 运输产品名
cost Double 运输费用
addService    
name String 附加服务名
cost Double 附加服务费用

 

2.创建订单

提供下单功能。支持所有运输方式。

调用参数及返回值示例

Url:

http://api.xru.com/order/newOrder.ashx

Param: 

account=zhaihongxia&secure=2e888bb0a5ad4fa486c1222f1c0de0cf&rettype=json&shopNumber=RC999999991CN&transType=XRUExpress&remarks=%e5%bf%ab%e9%80%92%e5%a4%a7%e5%93%a5+%e8%bf%99%e6%98%af%e6%88%91%e7%9a%84%e9%87%8d%e8%a6%81%e5%ae%a2%e6%88%b7+%e5%8a%b3%e7%83%a6%e5%8f%8a%e6%97%b6%e9%80%81%e5%88%b0&addServices=1%3b2&package_weight=1.12&package_dimension=0.51&package_content_name=dvr_100&package_content_unit=%e4%b8%aa&package_content_count=2&package_content_cost=100.123&package_content_currencyType=CNY&package_content_customsNo=&package_content_goodsName=dvr_100&package_content_remarks=%e6%b5%8b%e8%af%95%e8%ae%a2%e5%8d%95&from_name=jiang&from_tel=1234567890&from_country=CN&from_region=%e5%b9%bf%e5%b7%9e%ef%bc%8c%e7%99%bd%e4%ba%91%e5%8c%ba&from_street=HUANGSHILU&from_unit=HUANGSHILU&from_postcode=510000&to_name=%d0%9e%d0%bb%d1%8c%d0%b3%d0%b0+%d0%90%d0%bb%d0%b8%d0%ba%d1%83%d0%bb%d0%be%d0%b2%d0%b0&to_tel=79222578875&to_country=RU&to_region=%d0%a2%d1%8e%d0%bc%d0%b5%d0%bd%d1%81%d0%ba%d0%b0%d1%8f+%d0%be%d0%b1%d0%bb%2c%d0%a2%d1%8e%d0%bc%d0%b5%d0%bd%d1%81%d0%ba%d0%b0%d1%8f+%d0%be%d0%b1%d0%bb%d0%9e%d0%bb%d1%8c%d0%b3%d0%b0+%d0%90%d0%bb%d0%b8%d0%ba%d1%83%d0%bb%d0%be%d0%b2%d0%b0&to_street=%d0%a8%d0%ba%d0%be%d0%bb%d1%8c%d0%bd%d0%b0%d1%8f+%d0%b4.12+%d0%ba%d0%b236%2c%d0%bf.%d0%a1%d0%be%d1%81%d0%bd%d0%be%d0%b2%d0%ba%d0%b0%2c%d0%91%d0%b5%d0%bb%d0%be%d1%8f%d1%80%d1%81%d0%ba%d0%b8%d0%b9+%d1%80-%d0%be%d0%bd&to_unit=&to_postcode=628177

Method: 

http   post

Return: 

{"ret":0,"message":"","data":[{"dispatchNumber":null,"shopNumber":"RC999999991CN","success":false,"message":"WriteConcern detected an error \u0027E11000 duplicate key error index: rulcc.order.$_id_  dup key: { : \"RC999999991CN\" }\u0027. (Response was { \"err\" : \"E11000 duplicate key error index: rulcc.order.$_id_  dup key: { : \\\"RC999999991CN\\\" }\", \"code\" : 11000, \"n\" : 0, \"connectionId\" : 2086, \"ok\" : 1.0 })."}]}

 

传入参数说明

参数名 数据类型 是否必填 说明
account String Y XRU账号ID.获取API时提供。
secure String Y API对接安全码.获取API时提供。
rettype String Y 返回数据格式(xml/json)
shopNumber String N 客户自定义单号。
transType String Y 运输方式
addServices String N 附加服务(多个”;”分开);可空
remarks String N 备注;
package_weight double N 包裹重量(KG)
package_dimension double N 包裹体积(m³)
package_content_name String Y 申报英文品名(最多20个字符,多个”;”分开)
package_content_unit String N 单位
package_content_count Int Y 数量(多个”;”分开)
package_content_cost double Y 申报总价值(多个”;”分开)
package_content_currencyType String Y 申报货币类型(USD/CNY)(多个”;”分开)
package_content_customsNo String N 海关编号
package_content_goodsName String Y 申报中文品名(最多6个汉字,多个”;”分开)
package_content_url String N 申报货物的链接地址(多个”;”分开)
package_content_remarks String N 包裹内件备注
from_name String Y 发件人姓名(不能为空且长度最多为30)
from_tel String Y 发件人电话号码
from_country String Y 发件人国家(CN)
from_region String Y 发件人省、市、区域
from_street String Y 发件人街道
from_unit String N 发件人单元、门牌
from_postcode String Y 发件人邮编
to_name String Y 收件人姓名
to_tel String Y 收件人电话号码(收件人姓名 (收件人电话号码长度只能为10~40位))
to_country String Y 收件人国家(RU、KZ)
to_region String Y 收件人省、洲、区域
to_street String Y 收件人城市、街道
to_unit String Y 收件人单元、门牌号
to_postcode String Y 收件人邮编
to_email String N 收件人邮箱
注:参数 transType,addServices. 有效值 请参考产品列表API。    下载国家代码表

返回参数说明

参数名 数据类型 说明
ret Int 0为成功调用,其他值为失败
message String 调用失败附加信息
data Array 调用成功时返回数据,失败返回空数组
dispatchNumber String 处理单号。
shopNumber String 客户订单号。
success bool 是否下单成功(1:成功;0:失败)。
message String 失败原因(成功时为空)。

 

3.产品列表

提供主产品(所有运输方式)附加产品(保险等)等产品清单。

调用参数及返回值示例

Url:

http://api.xru.com/product/queryProduct.ashx

Param: 

account=zhaihongxia&secure=2e888bb0a5ad4fa486c1222f1c0de0cf&rettype=json&id=&type=1

Method: 

http   post

Return: 

{"ret":0,"message":"","data":[{"code":"ZX","weightMin":0.01,"weightMax":2,"timeLimit":0,"required":["LineParcelOperation"],"optoin":["VATInvoice","Insurance"],"id":"XRUParcel","IsPublic":false,"name":"专线小包","type":1},{"code":"DB","weightMin":2,"weightMax":20,"timeLimit":0,"required":["ChinaTransfer"],"optoin":["VATInvoice","Insurance"],"id":"XRUBale","IsPublic":false,"name":"XRU大包","type":1},{"code":"SD","weightMin":0,"weightMax":0,"timeLimit":15,"required":["Delivery"],"optoin":["VATInvoice","Insurance"],"id":"XRUExpress","IsPublic":false,"name":"XRU速递","type":1},{"code":"XRU","weightMin":0,"weightMax":0,"timeLimit":18,"required":[],"optoin":["CustomsClearance","Packing2th","VATInvoice","Insurance"],"id":"Other","IsPublic":false,"name":"其他","type":1},{"code":"","weightMin":10,"weightMax":0,"timeLimit":25,"required":["RuDelivery"],"optoin":["VATInvoice","OnshoreEletric","MoscowHome","Insurance2"],"id":"Onshore","IsPublic":false,"name":"陆运零担","type":1},{"code":"","weightMin":30,"weightMax":0,"timeLimit":1,"required":["RuDelivery"],"optoin":["VATInvoice","MoscowHome","Insurance2"],"id":"AirLine","IsPublic":false,"name":"专线空运","type":1},{"code":"PY","weightMin":0.1,"weightMax":2,"timeLimit":0,"required":["Pingyouxiaobao"],"optoin":[],"id":"XRUOrdinaryPost","IsPublic":false,"name":"XRU平邮小包 ","type":1},{"code":"XJ","weightMin":0.1,"weightMax":2,"timeLimit":20,"required":["ParcelOperation"],"optoin":["VATInvoice"],"id":"XinJiangParcel","IsPublic":false,"name":"新疆小包 ","type":1},{"code":"HEB","weightMin":0.01,"weightMax":2,"timeLimit":20,"required":["HarbinParcelOperation"],"optoin":["VATInvoice"],"id":"HarbinParcel","IsPublic":false,"name":"哈尔滨小包 ","type":1},{"code":"","weightMin":30,"weightMax":0,"timeLimit":3,"required":["RuDelivery"],"optoin":["VATInvoice","MoscowHome","Insurance2"],"id":"Express72H","IsPublic":false,"name":"72H速递服务","type":1}]}

 

传入参数说明

参数名 数据类型 是否必填 说明
account String Y XRU账号ID.获取API时提供。
secure String Y API对接安全码.获取API时提供。
rettype String Y 返回数据格式(xml/json)
id String N 可空(产品ID)
type String N 可空1:主产品(默认值)2:附加产品

 

返回参数说明

参数名 数据类型 说明
ret Int 0为成功调用,其他值为失败
message String 调用失败附加信息
data Array 调用成功时返回数据,失败返回空数组

 

code String 产品简码
weightMin Double 最小重量
WeightMax Double 最大重量
timeLimit Int 时效
required Array (字符串数组)产品必选服务
optoin Array 产品可选服务
id String 产品ID
name String 产品名
type Int 产品类型

 

 

4.打印面单

提供面单预览,返回HTML页面。打印前需要安装打印控件,只适用IE浏览器

调用参数及返回值示例

Url:

http://print.xru.com/PrintClient.aspx

Param:

action=show&size=printLableX10_1&id=XRUSP1747944231YQ

Method:

http   get

Return:

HTML页面。

传入参数说明

参数名 数据类型 是否必填 说明
action String Y 默认为 show
size String Y 默认为 printLableX10_1
id String Y 订单号,多个用英文逗号分开(,)

 

Copyright XRU.com 2014.All rights reserved.