订单预报
1、接口描述
- 上传订单数据,返回物流跟踪号码
2、请求地址
3、请求方式:POST
4、请求头:
Content-Type: application/json;charset=UTF-8
5、请求参数
{
"RequestName": "PreInputSet",
"icID": 71,
"TimeStamp": 1622816256769,
"MD5": "e2a2c4f41746d48d7968a2df87b790b3",
"RecList": [
{
"cEmsKind": "CNE全球特惠",
"nItemType": 1,
"cAddrFrom": "WISH",
"iItem": 1,
"cRNo": "REF00000001",
"cDes": "GB",
"cReceiver": "Lynne Bunyan",
"cRUnit": "",
"cRAddr": "23 Forence Road ",
"cRCity": "Sandhurst",
"cRPostcode": "GU47 0QB",
"cRProvince": "Berkshire",
"cRCountry": "United Kingdom",
"cRPhone": "07860551211",
"cRSms": "",
"cREMail": "",
"cRTaxCode": "",
"fWeight": 0.23,
"iLong": null,
"iWidth": null,
"iHeight": null,
"cMark": "",
"tradeTime": "2021-12-27 17:28:30",
"cMemo": "",
"cReserve": "dxmerp",
"vatCode":"",
"iossCode":"",
"cTaxRefund":"y",
"returnAddress": {
"name": "xxx",
"addr": "xxx",
"city": "广州市",
"postcode": "xxx",
"province": "广东省",
"country": "CN"
},
"labelContent": {
"fileType": "pdf",
"labelType":"label10x10",
"pickList":"0"
},
"GoodsList": [
{
"cxGoods": "连衣裙",
"cxGoodsA": "dress",
"ixQuantity": 1,
"fxPrice": 3.2,
"cxMoney": "USD"
}
]
}
]
}
参数说明
字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|
RequestName | 请求方法名称 | String | Y | 固定值:PreInputSet |
icID | 客户编码 | String | Y | |
TimeStamp | 当前时间戳 | Long | Y | 13位时间戳 |
MD5 | MD5签名 | String | Y | 32位小写 |
RecList | 订单信息列表 | List | Y | 数组,允许一次申请多个 |
- RecObject
字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|
cEmsKind | 渠道编码 | String | Y | EmsKindList接口获取 |
nItemType | 快件类型 | Integer(1) | Y | 默认为1 取值为:0(文件),1(包裹),2(防水袋) |
cAddrFrom | 订单所属平台 | String | Y | 固定值: WISH EBAY ALIEXPRESS AMAZON DHGATE JD CDISCOUNT LAZADA TOPHATTER JOOM SHOPEE MAGENTO SHOPIFY 1688 VOVA TIKTOK_3PL BUY_WITH_MICROSOFT 自营店铺填:MYSHOP 其他填:OTHER |
iItem | 件数 | Integer | Y | 默认值1 单个订单包裹数量,非SKU 数量 (大于1时,为一票多件业务,暂不支持) |
cRNo | 客户参考号 | String(32) | N | 客户系统订单号,只允许数字、字母、中划线 |
cDes | 收件人国家 | String(2) | Y | ISO国家二字码 |
cReceiver | 收件人姓名 | String(3,64) | Y | 收件人姓名 |
cRUnit | 收件人公司 | String(64) | N | |
cRAddr | 收件人地址 | String(5,256) | Y | 如有【详细地址2】【详细地址3】等信息,请拼接到cRAddr原有数据之后,以空格隔开 |
cRCity | 收件人城市 | String(3,64) | Y | |
cRProvince | 收件人省州 | String(64) | N | |
cRPostcode | 收件人邮编 | String(16) | Y | |
cRCountry | 收件人国家 | String(64) | Y | 国家英文名称 |
cRPhone | 收件人电话 | String(32) | N | |
cRSms | 收件人手机 | String(32) | N | |
cREMail | 收件人邮箱 | String(128) | N | |
cRTaxCode | 收件人税号 | String | N | 如:巴西税号 |
fWeight | 包裹申报重量 | Decimal(8,3) | Y | 单位:KG |
iLong | 长 | Decimal(10,2) | N | 单位:CM |
iWidth | 宽 | Decimal(10,2) | N | 单位:CM |
iHeight | 高 | Decimal(10,2) | N | 单位:CM |
cMark | 标记 | String(32) | N | 部分Label标签上会显示该字段 |
tradeTime | 交易时间 | String(19) | N | 时间必须为北京时间,格式为:yyyy-MM-dd HH:mm:ss 如:2021-12-27 17:25:32 |
cMemo | 发货备注 | String(254) | N | |
cReserve | 接口提供商 | String(30) | N | 如: 店小秘:dxmerp 芒果:mangoerp |
vatCode | vat税号 | String(32) | N | 如:英国vat |
iossCode | ioss号码 | String(12) | N | 欧盟ioss号码 |
cTaxRefund | 是否退税 | String(1) | N | n:否,y:是 |
cSender | 寄件人姓名 | String(64) | Y | 收件人姓名 |
cSUnit | 寄件人公司 | String(64) | N | |
cSAddr | 寄件人地址 | String(256) | N | |
cSCity | 寄件人城市 | String(64) | N | |
cSProvince | 寄件人省州 | String(64) | N | |
cSPostcode | 寄件人邮编 | String(32) | N | |
cSCountry | 寄件人国家 | String(32) | N | 国家英文名称 |
cSPhone | 寄件人电话 | String(32) | N | |
cSSms | 寄件人手机 | String(32) | N | |
cSEmail | 寄件人邮箱 | String(32) | N | |
returnAddress | 退件地址 | ReturnAdressObject | N | |
labelContent | Label打印参数 | LabelContentObject | N | 为空时,默认不返回打印链接,需要单独生成 |
GoodsList | 产品列表 | List | Y |
- ReturnAdressObject
字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|
name | 姓名 | String | Y | |
company | 公司 | String | N | |
addr | 地址 | String | Y | |
city | 城市 | String | Y | |
provice | 省州 | String | N | |
country | 国家 | String | Y | iso国家二字码 |
postcode | 邮编 | String | Y | |
phone | 电话 | String | N | |
邮箱 | String | N | ||
sms | 手机 | String | N |
- LabelContentObject
字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|
fileType | 面单类型 | String | Y | 默认:pdf |
labelType | 打印类型 | String | Y | 默认:label10x10 label10x10:10x10纸张 label10x15:10x15纸张 |
pickList | 拣货单配置 | Integer | Y | 默认:0 0:不包含拣货单 1:包含拣货单 |
- GoodsObject
字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|
cxGoods | 产品中文描述 | String | Y | |
cxGoodsA | 产品英文描述 | String | Y | |
ixQuantity | 产品数量 | Integer | Y | |
fxPrice | 产品单价 | Decimal(8,2) | Y | |
cxMoney | 申报币种 | String(3) | Y | 币种三字代码,如:USD、EUR |
cxGCodeA | 产品sku | String | N | |
hsCode | 海关编码 | String | N | |
cxGCodeB | 仓库编码 | String | N | |
cxGCodeC | 仓位编码 | String | N | |
cxgPic | 产品图片链接 | String | N | |
cxgURL | 产品链接 | String | N | |
cxOrigin | 产品原产地国家 | String | N | iso国家二字码 |
6、返回结果
{
"ReturnValue": 1,
"OK": 1,
"ErrList": [
{
"iIndex": 0,
"iID": 87046384,
"cNum": "3A5V581965316",
"cNo": "3A5V581965316",
"cRNo": "002262P0328058000",
"cCNo": "3A5V581965316",
"cMess": "",
"cPNo": "3A5V581965316",
"printUrl": ""
}
]
}
参数说明
字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|
ReturnValue | 状态 | Integer | Y | 大于0:成功 小于等于0:失败 |
cMess | 错误描述 | String | N | 请求失败时有值 |
OK | 成功数量 | Integer | Y | 下单时,成功下单的数量 |
ErrList | 返回数据内容 | List | Y |
- ErrObject
字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|
iIndex | 数组索引值 | Integer | Y | 从0开始,顺序为传入的RecList数组顺序 |
iID | 唯一记录ID | Long | Y | 大于0:成功 小于等于0:失败 (未来预录单记录的删除、修改则以此ID删除) |
cMess | 错误描述 | String | N | 错误描述 |
cNum | CNE内部单号 | String | Y | |
cNo | 运单号 | String | Y | 物流追踪号码 |
cRNo | 客户参考号 | String | N | 客户下单时传过来的单号 |
cPNo | 平台单号 | String | N | 用于提交平台的单号 |
printUrl | 标签打印链接 | String | N | 请求参数中labelContent不为空时,才有该值 注:如果apiToken更换,该链接会失效,可以更加标签打印接口重新生成 |
修改于 2024-03-13 10:47:07