1. 对接说明
- 域名 : sh-api.nengmao.net/tm
- 请求协议: 支持 http/https 协议
- 数据传输格式: JSON
- 产品条码: SKU
2. 快递公司编码
快递公司编码 |
快递公司名称 |
sf |
顺丰速运 |
ems |
邮政速递 |
sto |
申通快递 |
yto |
圆通速递 |
zto |
中通快递 |
zjs |
宅急送 |
yunda |
韵达速递 |
cces |
希伊艾斯快递 |
ttkdex |
天天快递 |
dbl |
德邦快递 |
jd |
京东物流 |
3. 请求参数签名
import org.apache.commons.lang3.StringUtils;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
public class MD5Utils {
private static final char[] HEX_2_DIGITS= { '0', '1', '2', '3', '4', '5', '6', '7', '8','9','a', 'b', 'c', 'd', 'e', 'f' };
public static String MD5(String source) {
if (StringUtils.isEmpty(source)) return "";
try {
byte[] strTemp = source.getBytes();
MessageDigest mdTemp = MessageDigest.getInstance("MD5");
mdTemp.update(strTemp);
byte[] md = mdTemp.digest();
char str[] = new char[md.length * 2];
int i = 0;
for (byte b : md) {
str[i++] = HEX_2_DIGITS[b >>> 4 & 0xf];
str[i++] = HEX_2_DIGITS[b & 0xf];
}
return new String(str);
} catch (NoSuchAlgorithmException e) {
return "";
}
}
public static void main(String[] args) {
System.out.println(MD5("appkey+timestamp"));
}
}
4. 返回错误值说明
错误代码 |
类型 |
说明 |
200 |
正常 |
请求成功 |
400 |
客户端异常 |
参数错误 |
400+ |
客户端异常 |
参数错误 |
500 |
服务器异常 |
系统错误 |
500+ |
服务器异常 |
系统错误 |
5. 销售订单接口
5.1. 订单查询接口
接口说明
请求地址
https://sh-api.nengmao.net/tm/api/order/list【生产环境】
https://sh-sandbox.nengmao.net/tm/api/order/list【沙箱环境】
请求方式 :
POST
公共参数
参数 |
是否必填 |
类型 |
描述 |
appKey |
是 |
string |
调用接口所需的KEY值 |
appSecret |
是 |
string |
调用接口所需的密钥 |
timestamp |
是 |
int |
时间戳,2分钟内有效 |
sign |
是 |
string |
签名 |
format |
否 |
string |
返回数据格式,默认为JSON |
请求参数
参数 |
是否必填 |
类型 |
描述 |
startModifyTime |
否 |
string |
订单的修改起始时间 |
endModifyTime |
否 |
string |
订单的修改结束时间 |
orderStatus |
否 |
number |
订单状态 0:已创建;1:待发货; 2:已发货;3:已取消;默认值为1 |
pageNo |
否 |
number |
页数,默认值为1 |
pageSize |
否 |
number |
每页条数,默认值为10,最大值为100 |
请求示例
{
"startModifyTime": "2017-04-10",
"endModifyTime": "2018-11-15",
"orderStatus": 2,
"pageNo": 1,
"pageSize": 1
}
响应示例
{
"errorCode": 200,
"msg": "操作成功",
"data": [{
"orderSn": "810120002477",
"orderOriginSn": "232837420316838019",
"orderAccount": "54chocolate",
"orderAmount": 649,
"shippingFee": 0,
"consignee": "老虎",
"country": "中国",
"province": "山西省",
"city": "太原市",
"district": "杏花岭区",
"address": "山西省 太原市 杏花岭区 坝陵桥街道小",
"zipcode": "030013",
"telephone": "13911116926",
"mobile": "13911116926",
"platform": "Tmall",
"paymentSn": "2018101222001103080553148751",
"paymentType": "alipay",
"createTime": "2018-10-12 17:39:26",
"payTime": "2018-10-12 17:45:47",
"modifyTime": "2018-10-13 14:00:21",
"shippingStatus": "已发货",
"remark": "",
"orderGoods": [{
"upcCode": "4046794648666",
"sku": "4250622_580_40",
"saleAmount": 649,
"tagPrice": 1999,
"qty": 1,
"shippingStatus": 1
}]
}],
"total": 7
}
响应参数
参数 |
类型 |
描述 |
orderSn |
string |
能猫订单管理系统的订单编号 |
orderOriginSn |
string |
天猫平台订单编号 |
orderAccount |
string |
天猫账号 |
orderAmount |
number |
订单总数 |
shippingFee |
number |
订单运费 |
discountSum |
number |
订单的折扣合计数 |
consignee |
string |
收货人姓名 |
country |
string |
收货人所在国家 |
province |
string |
收货人所在省 |
city |
string |
收货人所在城市 |
district |
string |
收货人所在区域 |
address |
string |
收货人具体地址 |
telephone |
string |
收货人电话 |
mobile |
string |
收货人手机号码 |
platform |
string |
销售平台 |
paymentSn |
string |
订单支付编号 |
paymentType |
string |
订单支付类型 |
createTime |
string |
创建时间 |
payTime |
string |
支付时间 |
modifyTime |
string |
修改时间 |
shippingStatus |
string |
发货状态 |
remark |
string |
订单备注 |
orderGoods |
array |
订单的产品信息 |
sku |
string |
产品SKU |
upcCode |
string |
条形码 |
saleAmount |
number |
产品销售总价 |
tagPrice |
number |
产品标签价格 |
qty |
number |
卖出产品质量 |
total |
number |
合计数量 |
5.2. 订单物流回传接口
接口说明
- 调用此接口可回传订单的物流信息 (单个订单)
- 此接口支持回传多个订单
请求地址
https://sh-api.nengmao.net/tm/api/order/ship【生产环境】
https://sh-sandbox.nengmao.net/tm/api/order/ship【沙箱环境】
请求方式 :
POST
公共参数
参数 |
是否必填 |
类型 |
描述 |
appKey |
是 |
string |
调用接口所需的KEY值 |
appSecret |
是 |
string |
调用接口所需的密钥 |
timestamp |
是 |
int |
时间戳,2分钟内有效 |
sign |
是 |
string |
签名 |
format |
否 |
string |
返回数据格式,默认为JSON |
请求参数
参数 |
是否必填 |
类型 |
描述 |
shipOrderList |
是 |
array |
订单物流信息 |
orderSn |
是 |
string |
能猫订单管理系统的订单编号 |
shipTime |
是 |
string |
订单的发货时间 |
expressCompany |
是 |
string |
快递公司 |
expressNo |
是 |
string |
快递单号 |
goodsList |
是 |
array |
已发货产品信息 |
sku |
是 |
string |
产品SKU |
qty |
是 |
string |
已发货产品质量 |
serialNumber |
否 |
string |
唯一码 |
请求示例
{
"shipOrderList": [{
"orderSn": "811010000207",
"shipTime": "2018-11-01 12:53:58",
"expressCompany": "bskd",
"expressNo": "51241003103688",
"goodsList": [{
"sku": "5221414_580_50",
"serialNumber": "37890530_test",
"qty": 1
}]
}]
}
响应示例
{
"errorCode": 200,
"msg": "操作成功",
"data": {}
}
响应参数
参数 |
类型 |
描述 |
errorCode |
number |
请求结果,200:成功;400+:客户端异常;500+:服务器异常 |
msg |
string |
请求的返回信息 |
data |
string |
响应的结果数据 |
5.3. 订单取消接口
接口说明
- 调用此接口可进行订单的取消 (支持对多个订单的操作)
请求地址
https://sh-api.nengmao.net/tm/api/order/cancel【生产环境】
https://sh-sandbox.nengmao.net/tm/api/order/cancel【沙箱环境】
请求方式 :
POST
公共参数
参数 |
是否必填 |
类型 |
描述 |
appKey |
是 |
string |
调用接口所需的KEY值 |
appSecret |
是 |
string |
调用接口所需的密钥 |
timestamp |
是 |
int |
时间戳,2分钟内有效 |
sign |
是 |
string |
签名 |
format |
否 |
string |
返回数据格式,默认为JSON |
请求参数
参数 |
是否必填 |
类型 |
描述 |
cancelList |
是 |
array |
订单取消信息 |
orderSn |
是 |
string |
能猫系统的订单编号 |
status |
是 |
number |
取消状态. 10:取消成功, 20:取消失败 |
message |
是 |
string |
取消原因 |
请求示例
{
"cancelList": [{
"orderSn": "80404121212",
"status": 10,
"message": "取消成功"
},{
"orderSn": "80404121213",
"status": 20,
"message": "取消失败"
}]
}
响应示例
{
"errorCode": 200,
"msg": "操作成功",
"data": {}
}
响应参数
参数 |
类型 |
描述 |
errorCode |
number |
请求结果,200:成功;400+:客户端异常;500+:服务器异常 |
msg |
string |
请求的返回信息 |
data |
string |
响应的结果数据 |
6. 退货接口
6.1. 退货查询接口
接口说明
请求地址
https://sh-api.nengmao.net/tm/api/refund/list【生产环境】
https://sh-sandbox.nengmao.net/tm/api/refund/list【沙箱环境】
请求方式 :
POST
公共参数
参数 |
是否必填 |
类型 |
描述 |
appKey |
是 |
string |
调用接口所需的KEY值 |
appSecret |
是 |
string |
调用接口所需的密钥 |
timestamp |
是 |
int |
时间戳,2分钟内有效 |
sign |
是 |
string |
签名 |
format |
否 |
string |
返回数据格式,默认为JSON |
请求参数
参数 |
是否必填 |
类型 |
描述 |
startModifyTime |
否 |
string |
退货的修改起始时间 |
endModifyTime |
否 |
string |
退货的修改结束时间 |
returnStatus |
否 |
int |
退货状态 0:已创建;1:待发货; 2:已发货;3:已取消 |
pageNo |
否 |
int |
页数,默认值为1 |
pageSize |
否 |
int |
每页条数,默认值为10,最大值为100 |
请求示例
{
"startModifyTime": "2018-4-10",
"endModifyTime": "2018-11-15",
"returnStatus": 1,
"pageNo": 1,
"pageSize": 1
}
响应示例
{
"errorCode": 200,
"msg": "操作成功",
"data": [
{
"returnSn": "180827650593",
"returnAccount": "ydjpda",
"returnAmount": 499,
"returnShippingFee": 0,
"returnee": "张钢",
"province": "北京",
"city": "北京市",
"district": "海淀区",
"zipcode": "100091",
"address": "北京 北京市 海淀区 海淀街道苏州街大02",
"expressCompany": "bskd",
"expressSn": "51117223202459",
"telephone": "",
"mobile": "13611201145",
"orderOriginSn": "808270001099,175753481484345895",
"orderSn": "808180001981",
"createTime": "2018-08-27 15:53:26",
"modifyTime": "2018-09-26 17:45:05",
"remark": "",
"goodsList": [
{
"sku": "8236512_558_50",
"upcCode": "4046794804840",
"goodsAmount": 499,
"qty": 1,
"tagPrice": 999,
"receiveStatus": 0
}
]
}
],
"total": 4
}
响应参数
参数 |
类型 |
描述 |
errorCode |
number |
请求结果,200:成功;400+:客户端异常;500+:服务器异常 |
msg |
string |
请求的返回信息 |
data |
array |
退货信息 |
returnSn |
string |
能猫订单管理系统退货编号 |
returnAccount |
string |
退货账号 |
returnAmount |
number |
退货总额 |
returnShippingFee |
number |
退货运费 |
returnee |
string |
退货人姓名 |
province |
string |
退货人所在省 |
city |
string |
退货人所在城市 |
district |
string |
退货人所在区域 |
zipcode |
string |
退货人邮政编码 |
address |
string |
退货人具体地址 |
expressCompany |
string |
快递公司 |
expressSn |
string |
快递单号 |
telephone |
string |
退货人电话 |
mobile |
string |
退货人手机号码 |
orderOriginSn |
string |
原订单编号 |
orderSn |
string |
能猫订单管理系统的订单编号 |
createTime |
string |
退货创建时间 |
modifyTime |
string |
退货修改时间 |
goodsList |
array |
退货产品信息 |
sku |
string |
退货产品SKU |
upcCode |
string |
条形码 |
goodsAmount |
number |
退货产品金额 |
qty |
number |
退货产品数量 |
receiveStatus |
number |
退货产品的接收状态 |
total |
number |
合计数量 |
6.2. 退货接收接口
接口说明
- 调用此接口可进行退货的接收确认
- 支持对多个订单的操作
请求地址
https://sh-api.nengmao.net/tm/api/refund/receipt【生产环境】
https://sh-sandbox.nengmao.net/tm/api/refund/receipt【沙箱环境】
请求方式 :
POST
公共参数
参数 |
是否必填 |
类型 |
描述 |
appKey |
是 |
string |
调用接口所需的KEY值 |
appSecret |
是 |
string |
调用接口所需的密钥 |
timestamp |
是 |
int |
时间戳,2分钟内有效 |
sign |
是 |
string |
签名 |
format |
否 |
string |
返回数据格式,默认为JSON |
请求参数
参数 |
是否必填 |
类型 |
描述 |
receiptList |
是 |
array |
退货信息 |
returnSn |
是 |
string |
能猫系统的退货编号 |
receiptTime |
是 |
string |
退货的接收时间 |
goodsList |
是 |
array |
退货产品信息 |
sku |
是 |
string |
退货产品SKU |
upcCode |
是 |
string |
退货产品的条形码 |
goodsStatus |
是 |
string |
产品的状态 |
serialNumber |
否 |
string |
唯一码 |
qty |
是 |
string |
退货产品的质量 |
请求示例
{
"receiptList": [{
"returnSn": "1811111112",
"receiptTime": "2018-04-03 17:00:00",
"goodsList": [{
"sku": "1122221122",
"upcCode": "11111211",
"serialNumber": "37890530_test",
"goodsStatus": "良品",
"qty": 2
},{
"sku": "11221221122",
"upcCode": "11111212",
"serialNumber": "378905301_test",
"goodsStatus": "良品",
"qty": 1
}]
}]
}
响应示例
{
"errorCode": 200,
"msg": "操作成功",
"data": {}
}
响应参数
参数 |
类型 |
描述 |
errorCode |
number |
请求结果,200:成功;400+:客户端异常;500+:服务器异常 |
msg |
string |
请求的返回信息 |
data |
string |
响应的结果数据 |
6.3. 取消退货接口
接口说明
- 调用此接口可进行退货的取消操作(支持对多个订单的操作)
请求地址
https://sh-api.nengmao.net/tm/api/refund/cancel【生产环境】
https://sh-sandbox.nengmao.net/tm/api/refund/cancel【沙箱环境】
请求方式 :
POST
公共参数
参数 |
是否必填 |
类型 |
描述 |
appKey |
是 |
string |
调用接口所需的KEY值 |
appSecret |
是 |
string |
调用接口所需的密钥 |
timestamp |
是 |
int |
时间戳,2分钟内有效 |
sign |
是 |
string |
签名 |
format |
否 |
string |
返回数据格式,默认为JSON |
请求参数
参数 |
是否必填 |
类型 |
描述 |
cancelList |
是 |
array |
退货取消信息 |
returnSn |
是 |
string |
能猫订单管理系统退货编号 |
status |
是 |
number |
取消状态,10:取消成功;20:取消失败 |
message |
是 |
string |
取消原因 |
请求示例
{
"cancelList": [{
"returnSn": "180404121212",
"status": 10,
"message": "取消成功"
},{
"returnSn": "180404121213",
"status": 20,
"message": "取消失败"
}]
}
响应示例
{
"errorCode": 200,
"msg": "操作成功",
"data": {}
}
响应参数
参数 |
类型 |
描述 |
errorCode |
number |
请求结果,200:成功;400+:客户端异常;500+:服务器异常 |
msg |
string |
请求的返回信息 |
data |
string |
响应的结果数据 |
7. 产品接口
7.1. 产品上传接口
接口说明
请求地址
https://sh-api.nengmao.net/tm/api/goods/upload【生产环境】
https://sh-sandbox.nengmao.net/tm/api/goods/upload【沙箱环境】
请求方式 :
POST
公共参数
参数 |
是否必填 |
类型 |
描述 |
appKey |
是 |
string |
调用接口所需的KEY值 |
appSecret |
是 |
string |
调用接口所需的密钥 |
timestamp |
是 |
int |
时间戳,2分钟内有效 |
sign |
是 |
string |
签名 |
format |
否 |
string |
返回数据格式,默认为JSON |
请求参数
参数 |
是否必填 |
是否必填建议 |
类型 |
描述 |
goodsList |
是 |
是 |
array |
产品信息 |
brand |
是 |
是 |
string |
品牌名称 |
brandImage |
否 |
否 |
string |
品牌图片地址 |
goodsSn |
是 |
是 |
string |
产品编号 |
goodsTitle |
是 |
是 |
string |
产品名称 |
goodsCategory |
否 |
是 |
string |
产品分类 |
goodsSeason |
否 |
否 |
string |
产品季节 |
goodsSeries |
否 |
否 |
string |
产品系列 |
goodsYears |
是 |
是 |
string |
产品年份 |
weight |
是 |
根据实际情况决定 |
string |
产品重量 |
description |
否 |
是 |
string |
产品描述 |
descriptionImage |
否 |
否 |
string |
产品描述图片地址 |
sizeChart |
否 |
是 |
string |
尺码表 |
material |
是 |
是 |
string |
材质 |
volume |
否 |
否 |
string |
体积 |
characteristics |
否 |
否 |
string |
产品特征说明,分隔符为“|” |
originCountry |
否 |
是 |
array |
原产地国家 |
careInfo |
否 |
是 |
string |
注意事项 |
shippingRestriction |
否 |
是 |
string |
运输限制 |
newArrivals |
否 |
是 |
string |
是否为新款 |
update |
否 |
是 |
string |
现有商品的更新信息 |
priority |
否 |
是 |
string |
优先上新标识 |
currency |
否 |
是 |
string |
货币 |
targetActiveDate |
否 |
否 |
string |
目标激活日期,日期格式:yyyy-MM-dd |
merchClass |
否 |
否 |
string |
商品等级(例如:等级A,等级B...) |
additionalDescription |
否 |
否 |
string |
附加说明 |
vendorBrand |
否 |
否 |
string |
供应商品牌 |
careFacet |
否 |
否 |
string |
护理说明 |
goodsStyleNo |
否 |
否 |
string |
商品货号编码 |
fitMeasurement |
否 |
否 |
Array |
尺寸 |
tmallLocalNotes |
No |
No |
string |
天猫本地备注 |
以下为产品SKU相关字段信息 |
skuList |
是 |
是 |
array |
品牌的SKU信息 |
color |
否 |
是 |
string |
颜色 |
colorCode |
否 |
否 |
string |
颜色编码 |
size |
否 |
是 |
string |
尺码 |
sizeCode |
否 |
否 |
string |
尺码编码 |
sku |
是 |
是 |
string |
产品SKU |
upcCode |
否 |
否 |
string |
条形码 |
marketPrice |
否 |
否 |
number |
标签价格 |
salePrice |
是 |
是 |
number |
销售价格 |
colorImage |
否 |
否 |
string |
颜色表 |
images |
是 |
是 |
number |
产品图片,至少要提供一张,分隔符为“|” |
stocks |
否 |
否 |
number |
产品库存量 |
shippingRestriction |
否 |
否 |
string |
承运说明 |
tmallNotes |
否 |
否 |
string |
天猫备注 |
ipStatus |
否 |
否 |
string |
ip状态 |
tmallLocalNotes |
No |
No |
string |
天猫本地备注 |
colorId |
No |
No |
string |
colorId + sizeId as reference point |
sizeId |
No |
No |
string |
colorId + sizeId as reference point |
以上为产品SKU相关字段信息 |
请求示例
{
"goodsList": [{
"brand": "AG Jeans",
"brandImage": "http://img.urbn.com/1.jpg",
"goodsSn": "AN-40000000-001",
"goodsTitle": "Arboretum Mug1",
"goodsCategory": "AN-home-kitchen",
"goodsSeason": "aut",
"goodsSeries": "2019 aut",
"goodsYears": "2019",
"weight": "100g",
"description": "This skinny, leg-lengthening pair is fitted",
"descriptionImage": "http://img.urbn.com/2.jpg",
"material": "100% Cotton",
"volume": "10*20*30",
"characteristics": "This is a test Tmall Note TEST12",
"sizeChart": "http://img.urbn.com/3.jpg",
"currency": "dollar",
"originCountry": "us",
"careInfo": "test careinfo",
"shippingRestriction": "test shippingRestriction",
"newArrivals": "test newArrivals",
"remarks": "test remarks",
"targetActiveDate": "2019-01-11",
"priority": "test",
"merchClass": "test marechclass",
"additionalDescription": "test additionalDescription",
"vendorBrand": "test vendorBrand",
"careFacet": "test careFacet",
"goodsStyleNo": "test goodsStyleNo",
"tmallLocalNotes": "tmallLocalNotes test",
"fitMeasurement": [
{
"measurementTitle": "Bust",
"us": "32.0",
"metric": "81.28"
},
{
"measurementTitle": "Length",
"us": "13.0",
"metric": "33.02"
},
{
"measurementTitle": "Strap Length",
"us": "16.5",
"metric": "41.91"
}
],
"skuList": [{
"color": "red",
"colorCode": "0001",
"size": "X",
"sizeCode": "000X",
"sku": "AN-40000000-001-0001-000X",
"upcCode": "6839029394",
"marketPrice": 900,
"salePrice": 629,
"stocks": 100,
"images": "https://img.alicdn.com/im_430x430q90.jpg",
"colorImage": "https://img.alicdn.com/img/111.jpg",
"shippingRestriction": "test shippingRestriction",
"tmallNotes": "test tmallNotes",
"colorId": "colorId test",
"sizeId": "skuId test",
"tmallLocalNotes": "tmallLocalNotes test",
"ipStatus": "test ipStatus"
}]
}]
}
响应示例
{
"errorCode": 200,
"msg": "操作成功",
"data": [{
"brand": "AG Jeans",
"brandImage": "http://img.urbn.com/1.jpg",
"goodsSn": "AN-40000000-001",
"goodsTitle": "Arboretum Mug1",
"goodsCategory": "AN-home-kitchen",
"goodsSeason": "aut",
"goodsSeries": "2019 aut",
"goodsYears": "2019",
"weight": "100g",
"description": "This skinny, leg-lengthening pair is fitted",
"descriptionImage": "http://img.urbn.com/2.jpg",
"material": "100% Cotton",
"volume": "10*20*30",
"characteristics": "This is a test Tmall Note TEST12",
"sizeChart": "http://img.urbn.com/3.jpg",
"currency": "dollar",
"originCountry": "us",
"careInfo": "test careinfo",
"shippingRestriction": "test shippingRestriction",
"newArrivals": "test newArrivals",
"remarks": "test remarks",
"targetActiveDate": "2019-01-11 00:00:00",
"priority": "test",
"merchClass": "test marechclass",
"additionalDescription": "test additionalDescription",
"vendorBrand": "test vendorBrand",
"careFacet": "test careFacet",
"goodsStyleNo": "test goodsStyleNo",
"fitMeasurement": [
{
"measurementTitle": "Bust",
"us": "32.0",
"metric": "81.28"
},
{
"measurementTitle": "Length",
"us": "13.0",
"metric": "33.02"
},
{
"measurementTitle": "Strap Length",
"us": "16.5",
"metric": "41.91"
}
],
"createTime": "2019-01-16 13:59:17",
"modifyTime": "2019-01-16 13:59:17",
"status": "0",
"goodsList": [{
"color": "red",
"colorCode": "0001",
"size": "X",
"sizeCode": "000X",
"sku": "AN-40000000-001-0001-000X",
"upcCode": "6839029394",
"marketPrice": 900,
"salePrice": 629,
"inventory": 0,
"lockInventory": 0,
"status": 0,
"colorImage": "https://img.alicdn.com/img/111.jpg",
"images": "https://img.alicdn.com/im_430x430q90.jpg",
"shippingRestriction": "test shippingRestriction",
"tmallNotes": "test tmallNotes",
"ipStatus": "test ipStatus"
}]
}]
}
响应参数
参数 |
类型 |
描述 |
errorCode |
number |
请求结果,200:成功;400+:客户端异常;500+:服务器异常 |
msg |
string |
请求的返回信息 |
data |
array |
产品信息数据 |
goodsSn |
string |
产品编号 |
goodsTitle |
string |
产品名称 |
brand |
string |
品牌名称 |
brandImage |
string |
品牌图片 |
goodsCategory |
string |
产品分类 |
goodsSeason |
string |
产品季节 |
goodsSeries |
string |
产品系列 |
goodsYears |
string |
产品年份 |
weight |
string |
产品重量 |
description |
string |
描述 |
descriptionImage |
string |
描述图片 |
material |
string |
材质 |
volume |
string |
体积 |
characteristics |
string |
产品特征 |
measure |
array |
尺寸 |
sizeChart |
string |
尺码表 |
currency |
string |
货币 |
originCountry |
string |
原产地国家 |
careInfo |
string |
注意事项 |
shippingRestriction |
string |
运输限制 |
newArrivals |
string |
是否为新款 |
description |
string |
描述 |
targetActiveDate |
string |
目标激活日期 |
priority |
string |
优先上新标识 |
merchClass |
string |
商品等级 |
createTime |
string |
收货人所在省 |
modifyTime |
string |
修改时间 |
status |
number |
产品状态 |
goodsList |
array |
产品信息 |
goodsSn |
string |
产品编号 |
color |
string |
颜色 |
colorCode |
string |
颜色编码 |
size |
string |
尺码 |
sizeCode |
string |
尺码编码 |
upcCode |
string |
条形码 |
sku |
string |
产品SKU |
marketPrice |
number |
标签价格 |
salePrice |
number |
销售价格 |
inventory |
number |
库存总量 |
lockInventory |
number |
被锁定的库存量 |
status |
number |
产品状态(0:有存货;1:出售中) |
images |
string |
产品图片 |
colorImage |
string |
颜色图片 |
7.2. 库存更新接口
接口说明
- 调用此接口可进行库存全量更新(每天凌晨2点定时更新)
- 调用此接口也可进行库存增量更新(包括仓库采购出入库存,以及线下门店的共享库存更新)
- 产品采用SKU和(或)条形码进行标识
- 调用此接口一次最多支持1000个sku的库存更新
请求地址
https://sh-api.nengmao.net/tm/api/stocks/update【生产环境】
https://sh-sandbox.nengmao.net/tm/api/stocks/update【沙箱环境】
请求方式 :
POST
公共参数
参数 |
是否必填 |
类型 |
描述 |
appKey |
是 |
string |
调用接口所需的KEY值 |
appSecret |
是 |
string |
调用接口所需的密钥 |
timestamp |
是 |
int |
时间戳,2分钟内有效 |
sign |
是 |
string |
签名 |
format |
否 |
string |
返回数据格式,默认为JSON |
Request Parameters
参数 |
是否必填 |
必填建议 |
类型 |
描述 |
updateType |
是 |
是 |
int |
更新方式,0:全量更新;1:增量更新 |
sku |
否 |
是 |
string |
产品SKU |
upcCode |
否 |
否 |
string |
条形码 |
stocks |
是 |
否 |
int |
库存 |
goodsSn |
否 |
是 |
string |
产品编号 |
请求示例
{
"updateType":0,
"skuList":[{
"sku": "869aa622133",
"stocks": 12
}]
}
响应示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": [{
"goodsSn": "11211222331",
"color": "red",
"size": "X",
"sku": "869aa622133",
"upcCode": "69112121232",
"marketPrice": 900,
"salePrice": 629,
"inventory": 12,
"lockInventory": 0,
"status": 0,
"images": "https://img.alicdn.com/88218.jpg_430x430q90.jpg",
"colorImage": "https://img.alicdn.com/img/111.jpg"
}]
}
响应参数
参数 |
类型 |
描述 |
errorCode |
number |
请求结果,200:成功;400+:客户端异常;500+:服务器异常 |
msg |
string |
请求的返回信息 |
data |
array |
产品信息数据 |
goodsSn |
string |
产品编号 |
color |
string |
颜色 |
size |
string |
尺码 |
upcCode |
string |
条形码 |
marketPrice |
number |
标签价格 |
salePrice |
number |
销售价格 |
inventory |
number |
库存总量 |
lockInventory |
number |
被锁定的库存量 |
status |
number |
产品状态(0:有存货;1:出售中) |
images |
string |
产品图片 |
colorImage |
string |
颜色图片 |
7.3. 价格更新接口
接口说明
- 调用此接口可进行商品出售价格增量更新
- 调用此接口一次最多支持100件产品的价格更新
- 产品采用SKU和(或)条形码进行标识
请求地址
https://sh-api.nengmao.net/tm/api/price/update【生产环境】
https://sh-sandbox.nengmao.net/tm/api/price/update【沙箱环境】
请求方式 :
POST
公共参数
参数 |
是否必填 |
类型 |
描述 |
appKey |
是 |
string |
调用接口所需的KEY值 |
appSecret |
是 |
string |
调用接口所需的密钥 |
timestamp |
是 |
number |
时间戳,2分钟内有效,时区为:东八区 |
sign |
是 |
string |
签名 |
format |
否 |
string |
返回数据格式,默认为JSON |
请求参数
参数 |
是否必填 |
是否必填建议 |
类型 |
描述 |
skuList |
是 |
是 |
array |
产品的SKU信息 |
sku |
否 |
是 |
string |
产品SKU |
upcCode |
否 |
否 |
string |
产品国际通用条形码 |
salePrice |
是 |
是 |
number |
产品出售价格 |
goodsSn |
否 |
是 |
string |
产品编号 |
请求示例
{
"skuList":[{
"sku":"goata31869633",
"salePrice":1900
}]
}
响应示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": [{
"goodsSn": "goat1194122331",
"color": "red",
"size": "X",
"sku": "goata31869633",
"upcCode": "6919721232",
"marketPrice": 900,
"salePrice": 1900,
"inventory": 110,
"lockInventory": 0,
"status": 0,
"images": "https://img.alicdn.com/im_430x430q90.jpg",
"colorImage": "https://img.alicdn.com/img/111.jpg"
}]
}
响应参数
参数 |
类型 |
描述 |
errorCode |
number |
请求结果,200:成功;400+:客户端异常;500+:服务器异常 |
msg |
string |
请求的返回信息 |
data |
array |
产品信息数据 |
goodsSn |
string |
产品编号 |
color |
string |
颜色 |
size |
string |
尺码 |
upcCode |
string |
条形码 |
marketPrice |
number |
标签价格 |
salePrice |
number |
销售价格 |
inventory |
number |
库存总量 |
lockInventory |
number |
被锁定的库存量 |
status |
number |
产品状态(0:有存货;1:出售中) |
images |
string |
产品图片 |
colorImage |
string |
颜色图片 |
7.4. 产品信息查询接口
接口说明
- 调用此接口可查询产品状态等信息(例如:是否上新,价格,库存信息等)
- 调用此接口一次最多支持100件产品的查询
请求地址
https://sh-api.nengmao.net/tm/api/goods/query【生产环境】
https://sh-sandbox.nengmao.net/tm/api/goods/query【沙箱环境】
请求方式 :
POST
公共参数
参数 |
是否必填 |
类型 |
描述 |
appKey |
是 |
string |
调用接口所需的KEY值 |
appSecret |
是 |
string |
调用接口所需的密钥 |
timestamp |
是 |
number |
时间戳,2分钟内有效,时区为:东八区 |
sign |
是 |
string |
签名 |
format |
否 |
string |
返回数据格式,默认为JSON |
请求参数
参数 |
是否必填 |
类型 |
描述 |
startModifyTime |
否 |
string |
产品的修改起始时间 |
endModifyTime |
否 |
string |
产品的修改结束时间 |
goodsStatus |
否 |
number |
产品状态 0:库存中;1:已上新,默认值为null |
goodSnList |
否 |
array |
产品编号数组;数组长度不能大于100 |
skuList |
否 |
array |
产品的SKU编号数组;数组长度不能大于100 |
pageNo |
否 |
number |
页数,默认值为1 |
pageSize |
否 |
number |
每页的产品条数 默认值为10,最大值为100 |
请求示例
{
"startModifyTime":"2018-01-04 16:23:47",
"endModifyTime":"2018-10-24",
"goodsStatus":0,
"goodSnList":["121212","abc1111"],
"skuList":["12345678","2345678"],
"pageNo":1,
"pageSize":1
}
响应示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": [
{
"goodsSn": "1VB90065 127",
"goodsTitle": "Stack 2",
"goodsBrand": "Fila",
"brandImage": "",
"goodsCategory": "basketball",
"goodsSeason": "",
"goodsSeries": "",
"weight": "",
"description": "",
"descriptionImage": "",
"material": "",
"volume": "",
"characteristics": "",
"measure": "",
"sizeChart": "",
"target": "",
"createTime": "2018-09-04 16:23:47",
"modifyTime": "2018-09-04 16:23:47",
"additionalDescription": "test additionalDescription",
"vendorBrand": "test vendorBrand",
"careFacet": "test careFacet",
"goodsStyleNo": "test goodsStyleNo",
"tmallLocalNotes": "tmallLocalNotes test",
"fitMeasurement": [
{
"measurementTitle": "Bust",
"us": "32.0",
"metric": "81.28"
},
{
"measurementTitle": "Length",
"us": "13.0",
"metric": "33.02"
},
{
"measurementTitle": "Strap Length",
"us": "16.5",
"metric": "41.91"
}
],
"goodsList": [
{
"goodsSn": "1VB90065 127",
"color": "white",
"size": "12.0",
"sku": "29376-12.0",
"upcCode": "",
"marketPrice": 0,
"salePrice": 150,
"inventory": 1,
"lockInventory": 0,
"status": 0,
"images": "",
"colorImage": "",
"video": null,
"shippingRestriction": "test shippingRestriction",
"tmallNotes": "test tmallNotes",
"ipStatus": "test ipStatus",
"tmallLocalNotes": "tmallLocalNotes test",
"colorId": "colorId test",
"sizeId": "sizeId test"
}
]
}
],
"total": 13
}
响应参数
参数 |
类型 |
描述 |
errorCode |
number |
请求结果,200:成功;400+:客户端异常;500+:服务器异常 |
msg |
string |
请求的返回信息 |
data |
array |
产品信息数据 |
goodsSn |
string |
产品编号 |
goodsTitle |
string |
产品名称 |
brand |
string |
品牌名称 |
brandImage |
string |
品牌图片 |
goodsCategory |
string |
产品分类 |
goodsSeason |
string |
产品季节 |
goodsSeries |
string |
产品系列 |
goodsYears |
string |
产品年份 |
weight |
string |
产品重量 |
description |
string |
描述 |
descriptionImage |
string |
描述图片 |
material |
string |
材质 |
volume |
string |
体积 |
characteristics |
string |
产品特征 |
measure |
array |
尺寸 |
sizeChart |
string |
尺码表 |
currency |
string |
货币 |
originCountry |
string |
原产地国家 |
careInfo |
string |
注意事项 |
shippingRestriction |
string |
运输限制 |
newArrivals |
string |
是否为新款 |
description |
string |
描述 |
targetActiveDate |
string |
目标激活日期 |
priority |
string |
优先上新标识 |
merchClass |
string |
商品等级 |
additionalDescription |
string |
附加说明 |
vendorBrand |
string |
供应商品牌 |
careFacet |
string |
护理说明 |
goodsStyleNo |
string |
商品货号编码 |
createTime |
string |
创建时间 |
modifyTime |
string |
修改时间 |
status |
number |
产品状态 |
goodsList |
array |
产品信息 |
goodsSn |
string |
产品编号 |
color |
string |
颜色 |
colorCode |
string |
颜色编码 |
size |
string |
尺码 |
sizeCode |
string |
尺码编码 |
upcCode |
string |
条形码 |
sku |
string |
产品SKU |
marketPrice |
number |
标签价格 |
salePrice |
number |
销售价格 |
inventory |
number |
库存总量 |
lockInventory |
number |
被锁定的库存量 |
status |
number |
产品状态(0:有存货;1:出售中) |
images |
产品图片 |
colorImage |
string |
颜色图片 |
video |
string |
video |
tmallNotes |
string |
承运说明 |
shippingRestriction |
string |
天猫备注 |
tmallLocalNotes |
string |
天猫本地备注 |
colorId |
string |
colorId + sizeId as reference point |
sizeId |
string |
colorId + sizeId as reference point |
total |
number |
合计数量 |