ETEEN API 接口说明

中文 English
获取渠道 EmsKindList

查询客户可见快递类别列表

RequestNamestring固定值"EmsKindList"必须
icIDstring/int客户唯一识别必须
TimeStampstring13位UTC毫秒必须
MD5string数字签名必须
⬇ 响应字段
ReturnValueint快递类别条数(正数)/错误码
Listarray渠道列表
cEmsKindstring系统名称(1-15字符)
cEmsKindShowstring界面显示名称
{ "RequestName": "EmsKindList", "icID": 356, "TimeStamp": 1405534421123, "MD5": "6c08ea4dff56d5a7a959c09f121c3c4f" }
{ "ReturnValue": 3, "List": [ {"cEmsKind": "AUPost", "cEmsKindShow": "AUPost"}, {"cEmsKind": "EEMS国际", "cEmsKindShow": "国际快线"} ] }
提交并预报订单 PreInputSet

客户预录单数据写入（添加/修改），支持单条及多条物品。

RequestNamestringPreInputSet必须
icIDstring客户ID必须
TimeStampstring13位UTC毫秒必须
MD5string数字签名必须
cUniqueMsgIDstring消息唯一ID(防重)可选
RecListarray快件预录记录列表，1-N个必须
iIDint记录ID，>0修改，0新增必须
nItemTypeint0文件/1包裹/2防水袋(默认1)
nLanguageint0中国大陆/1华语/2其它
cEmsKindstring快递类别,1-15字符必须
cDesstring目的地,1-63字符必须
fWeightdouble重量kg,3位小数
cReceiverstring收件人
cRAddrstring收件地址
cNumstring内单号(电商订单号)7-30字符
GoodsListarray物品列表(0-100)可选
cxGoodsstring物品描述,0-63字符必须
ixQuantityint物品数量必须
fxPricedouble单价,2位小数
⬇ 响应字段
ReturnValueint处理记录数/负数失败
OKint成功数
ErrListarray处理信息列表(含cMess等)
{ "RequestName": "PreInputSet", "icID": 36, "TimeStamp": 1513106027000, "cUniqueMsgID": "fb922476-ee50-4ba3-bac6-0b4001972ddf", "MD5": "84783fcb4a316568cd9e52c501bc876f", "RecList": [ { "iID": 0, "nItemType": 1, "cEmsKind": "南京速递EUB", "cDes": "美国", "fWeight": 2.123, "cReceiver": "Micheal Zhang", "cRAddr": "678,Dsttr Street,Bridgeville", "cNum": "test12345601" } ] }
{ "ReturnValue": 3, "OK": 1, "ErrList": [ {"iIndex":0,"iID":0,"cNum":"CEN88676666","cMess":"运单号重复"}, {"iIndex":1,"iID":123,"cNum":"EM77882299CN","cNo":"EM123456789CN"} ] }
删除预报订单 PreInputDel

根据记录ID数组批量删除预录单。

RequestNamestringPreInputDel必须
icIDstring/int客户ID必须
TimeStampstring13位UTC毫秒必须
MD5string数字签名必须
iIDsarray预录记录ID数组,如[1,2,5]必须
⬇ 响应字段
ReturnValueint处理记录数/负数失败
OKint成功数
ErrListarray失败记录列表
{ "RequestName": "PreInputDel", "icID": 356, "TimeStamp": 1405534421123, "MD5": "6c08ea4dfi56d5a7a959c09f121c3c4f", "iIDs": [1, 2, 3] }
{ "ReturnValue": 2, "OK": 1, "ErrList": [ {"iIndex":1,"iID":2,"cMess":"记录不存在"} ] }
重新获取单号 DoGetNo

预先提取运单号

RequestNamestringDoGetNo必须
icIDstring/int客户ID必须
TimeStampstring13位UTC毫秒必须
MD5string数字签名必须
cEmsKindstring快递类别必须
iTypeint0转单号/1内单号，默认0
⬇ 响应字段
ReturnValueint1成功/0失败/负数错误
cNostring运单号
{ "RequestName": "DoGetNo", "icID": 356, "TimeStamp": 1405534421123, "MD5": "6c08ea4dff56d5a7a959c09f121c3c4f", "cEmsKind": "AUPost", "iType": 0 }
{ "ReturnValue": 1, "cNo": "1Z999AA10123456784" }
单票查询 PreInputData

根据iID或cNum返回完整预录单数据(包含物品列表)

RequestNamestringPreInputData必须
icIDstring/int客户ID必须
TimeStampstring13位UTC毫秒必须
MD5string数字签名必须
iIDint记录ID(与cNum二选一)
cNumstring内单号7-30字符
⬇ 响应字段 (完整预录单数据)
ReturnValueint1成功/负数失败
iIDint记录ID
cEmskindstring快递类别
cDesstring目的地
cReceiverstring收件人
cNumstring内单号
GoodsListarray物品列表
{ "RequestName": "PreInputData", "icID": 356, "TimeStamp": 1405534421123, "MD5": "6c08ea4df56d5a7a959c09f121c3c4f", "cNum": "RB00012352CN" }
{ "ReturnValue": 1, "iID": 1599, "cEmskind": "EMS国际", "cDes": "美国", "cReceiver": "DavidEsparza", "cNum": "RB00012352CN", "GoodsList": [ {"cxGoods": "硬粒小麦", "ixQuantity": 3} ] }
获取PDF标签 sGetLabel

根据运单号数组返回PDF文件流或JSON错误

RequestNamestringsGetLabel必须
icIDstring/int客户ID必须
TimeStampstring13位UTC毫秒必须
MD5string数字签名必须
iNoTypeint单号类型(通常1)
iTableint默认0
cModelNamestring"FILE_STORE_PDF"
aNoarray运单号数组必须
⬇ 响应
成功PDF返回PDF文件流
失败JSON{"ReturnValue":0,"cMess":"..."}
{ "RequestName": "sGetLabel", "icID": 91, "TimeStamp": 1499885944000, "MD5": "1a9f0c6a38a0fc3e7d4c1226cd94c944", "iNoType": 1, "iTable": 0, "cModelName": "FILE_STORE_PDF", "aNo": ["338MP500002601000930803"] }
成功: PDF文件流 (Content-Type: application/pdf) 失败: {"ReturnValue":0,"cMess":"没有符合条件的记录"}
轨迹追踪 DoTrackJs

支持1-50个运单号，返回完整轨迹事件

nosstring/array运单号(1-50个),逗号分割或JSON数组必须
lanint0中文/1英语,默认0可选
⬇ 响应 RecList[] 详细字段
ReturnValueint成功:查询运单个数；失败:负数
cMessstring失败时携带原因
RecListarray结果对象数组
nostring查询运单号
statusint状态码(-1至10)
cNumstring内单号
cNostring转单号
cDesstring目的地
cReceiverstring收件人
deliveryDatestring签收日期
signaturestring签收人
trackingEventListarray运转信息
datestring日期时间
placestring地点
detailsstring描述
GET: http://IP/cgi-bin/GInfo.dll?DoTrackJs&nos=6090933,558904&lan=1 POST: {"nos":["812802","9808591"],"lan":1}
{ "ReturnValue": 1, "RecList": [ { "no": "8120237802", "status": 3, "cNum": "8120237802", "cDes": "四川泸州", "cReceiver": "阳路平", "deliveryDate": "2018.06.23 18:01", "signature": "本人签收", "trackingEventList": [ {"date": "2018-06-11", "place": "澳洲", "details": "已揽件"}, {"date": "2018-06-23 18:01", "place": "", "details": "已签收"} ] } ] }
状态码速查
通用响应码 (ReturnValue)
1 成功/记录数 -2 记录不存在 -3 缺少参数 -7 安全校验失败 -710 icID错误 -731 MD5不匹配 -810 快递类别不支持 -999 超过并发
轨迹 status 含义
-1 不存在/失败 0 未发送 1 已发送 2 转运中 3 送达 4 超时 5 扣关 6 地址错误 7 丢失 8 退件 9 其他异常 10 销毁

ETEEN API

中 EN
渠道 提交 删除 单号 查询 PDF 轨迹 状态码

获取渠道

EmsKindList
请求参数
RequestName string 必须
固定值"EmsKindList"
icID string/int 必须
客户唯一识别
TimeStamp string 必须
13位UTC毫秒
MD5 string 必须
数字签名
响应字段
ReturnValue int
快递类别条数(正数)/错误码
List array
渠道列表
cEmsKind string
系统名称
cEmsKindShow string
显示名称
请求示例 
{
  "RequestName": "EmsKindList",
  "icID": 356,
  "TimeStamp": 1405534421123,
  "MD5": "6c08ea4dff56d5a7a959c09f121c3c4f"
}
响应示例 
{
  "ReturnValue": 3,
  "List": [
    {"cEmsKind": "AUPost", "cEmsKindShow": "AUPost"},
    {"cEmsKind": "EEMS国际", "cEmsKindShow": "国际快线"}
  ]
}

提交并预报

PreInputSet
请求参数
RecList array 必须
快件记录列表
iIDint 必须
记录ID，0新增
cEmsKindstring 必须
快递类别
cDesstring 必须
目的地
响应示例 
{"ReturnValue":3,"OK":1,"ErrList":[...]}

删除预报

PreInputDel
请求参数
iIDs array 必须
记录ID数组

获取单号

DoGetNo
请求参数
cEmsKindstring 必须
快递类别
iTypeint
0转单号/1内单号

单票查询

PreInputData
请求参数
iIDint
记录ID
cNumstring
内单号

PDF标签

sGetLabel
请求参数
aNoarray 必须
运单号数组

轨迹追踪

DoTrackJs
请求参数
nosstring/array 必须
运单号(1-50个)
lanint
0中文/1英语
响应示例 
{
  "ReturnValue": 1,
  "RecList": [{
    "no": "8120237802",
    "status": 3,
    "trackingEventList": [
      {"date":"2018-06-11","place":"澳洲","details":"已揽件"}
    ]
  }]
}

状态码速查

通用响应码
1 成功
-2 不存在
-3 缺少参数
-7 校验失败
轨迹状态码
-1: 失败
0: 未发送
1: 已发送
2: 转运中
3: 送达
接口 状态码 搜索