注册快递运单
# 接口地址
POST https://api.track123.com/gateway/open-api/tk/v2/track/import
# 接口描述
一次最多导入40个单号,接口请求限制频率为3 requests/sec。返回的结果包含accepted和rejected两个列表,accepted列表是导入成功的运单,rejected列表是导入失败的运单。单号和物流商都已经存在的重复运单,不会重复导入。但系统里已经存在这些运单,视为导入成功。
# 请求参数
参数名称 | 参数说明 | 必须 | 数据类型 |
---|---|---|---|
trackNo | 物流单号 | true | string |
courierCode | 物流商对应的唯一简码,如果简码为空,系统会根据规则自动匹配 | false | string |
orderNo | 订单号,由商家/平台所产生的订单编号 | false | string |
country | 目的国国家二字简码:CN,US,GB | false | string |
shipTime | 发货时间 | false | string(date-time) |
customerEmail | 客户邮箱,订单关联的客户邮箱 | false | string |
postalCode | 邮编号(最多15位字母或数字组成,可以包含+,-,和空格) | false | string |
extendFieldMap | 扩展字段(用于补充附加信息,如手机尾号) | false | object |
phoneSuffix | 手机尾号 | false | string |
remark | 备注 | false | string |
customField1 | 自定义字段1 | false | string |
customField2 | 自定义字段2 | false | string |
# 请求示例
[
{
"trackNo": "LV209031969CN",
"courierCode": "denmark-post",
"orderNo": "x1234567890",
"country": "CN",
"shipTime": "2021-09-03 17:43:00",
"customerEmail": "customer@track123.com",
"postalCode": "000000",
"remark": "备注",
"extendFieldMap": {"phoneSuffix": "2390"}
},
{
"trackNo": "LV209031934CN",
"courierCode": "denmark-post",
"orderNo": "x1234567892",
"country": "CN",
"shipTime": "2021-09-03 17:43:00",
"customerEmail": "customer@track123.com",
"postalCode": "000000",
"remark": "备注",
"extendFieldMap": {"phoneSuffix": "2390"}
}
]
# 响应参数
参数名称 | 参数说明 | 类型 |
---|---|---|
code | 业务状态码 | string |
data | 实际返回对象 | object |
accepted | 注册成功的单号 | array |
trackNo | 物流单号 | string |
courierCode | 物流商对应的唯一简码,如果简码为空,系统会根据规则自动匹配 | string |
orderNo | 订单号,由商家/平台所产生的订单编号 | string |
country | 目的国 | string |
shipTime | 发货时间 | string |
customerEmail | 客户邮箱,由商家/平台填写的,订单关联的客户邮箱 | string |
remark | 备注 | string |
rejected | 注册失败的单号 | array |
courierCode | 快递商简码 | string |
error | 错误 | object |
code | 错误码 | string |
msg | 错误信息 | string |
trackNo | 快递单号 | string |
msg | 业务状态码对应的描述信息或者其他辅助的描述信息 | string |
# 响应示例
{
"code": "00000",
"data": {
"accepted": [
{
"trackNo": "LV209031969CN",
"courierCode": "denmark-post",
"orderNo": "x1234567890",
"country": "cn",
"shipTime": "2021-09-03 17:43:00",
"customerEmail": "customer@track123.com",
"remark": "备注"
}
],
"rejected": [{
"trackNo": "LV209031934CN",
"courierCode": "",
"error": {
"code": "A0400",
"msg": "跟踪号(trackNo)已经注册过了"
},
}]
},
"msg": "成功"
}