1. 对接说明

域名 : sh-api.nengmao.net/tmg
请求协议: 支持 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. 库存更新接口

接口说明

调用此接口可进行库存全量更新（每天凌晨2点或者在约定好的时间定时更新）
调用此接口也可进行库存增量更新（包括仓库采购出入库存，以及线下门店的共享库存更新）
产品采用SKU和（或）条形码进行标识

请求地址

https://sh-api.nengmao.net/tmg/api/stocks/update【生产环境】
https://sh-sandbox.nengmao.net/tmg/api/stocks/update【沙箱环境】

请求方式 : POST

公共参数

参数	是否必填	类型	描述
appKey	是	string	调用接口所需的KEY值
appSecret	是	string	调用接口所需的密钥
timestamp	是	int	时间戳，2分钟内有效，时区为：东八区
sign	是	string	签名
format	否	string	返回数据格式，默认为JSON

Request Parameters

参数	是否必填	是否必填建议	类型	描述
updateType	是	是	number	库存更新方式，0：全量更新；1：增量更新
skuList	是	是	array	产品的SKU信息
sku	否	是	string	产品SKU
upcCode	否	否	string	条形码
internalId	否	否	string	品牌内部的产品编号
stocks	是	是	number	库存量
goodsSn	否	是	string	产品编号

请求示例

{
    "updateType":0,
    "skuList":[{
        "sku": "869aa622133",
        "internalId":"abc11111",
        "stocks": 12
    }]
}

响应示例

{
    "errorCode": 200,
    "msg": "operate successful(操作成功)",
    "data": [{
        "goodsSn": "11211222331",
        "color": "red",
        "size": "X",
        "sku": "869aa622133",
        "upcCode": "69112121232",
        "internalId": "",
        "marketPrice": 900,
        "salePrice": 629,
        "inventory": 12,
        "lockInventory": 0,
        "importFee": 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	条形码
internalId	string	品牌内部的产品编码
marketPrice	number	标签价格
salePrice	number	销售价格
inventory	number	库存总量
lockInventory	number	被锁定的库存量
importFee	number	进口费用
status	number	产品状态（0：有存货；1：出售中）
images	string	产品图片
colorImage	string	颜色图片

6. 销售订单接口

6.1. 订单查询接口

接口说明

调用此接口可查询订单信息和产品信息

请求地址

https://sh-api.nengmao.net/tmg/api/order/list【生产环境】
https://sh-sandbox.nengmao.net/tmg/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
orderType	否	string	订单类型，Y：新订单；N：已经撤回的旧订单，默认值为Y

请求示例

{
    "startModifyTime": "2017-04-10",
    "endModifyTime": "2018-08-15",
    "orderStatus": 1,
    "orderType":"y",
    "pageNo": 1,
    "pageSize": 1
}

响应示例

{
    "errorCode": 200,
    "msg": "operate successful(操作成功)",
    "data": [{
        "orderSn": "101080953050411111",
        "orderAccount": "刘婷19921023",
        "orderAmount": 554.37,
        "shippingFee": 100,
	"discountAmountSum": 0,
        "consignee": "刘大爷",
        "country": "中国",
        "province": "广东省",
        "city": "广州市",
        "district": "越秀区",
        "address": "黄花岗街道天河北水荫路柏高酒店419房间",
        "zipcode": "510180",
        "telephone": "15827554247",
        "mobile": "",
        "platform": "TM",
        "paymentSn": "2017122421001001630262632854",
        "paymentType": "alipay",
        "createTime": "2018-07-04 17:14:20",
        "payTime": "2017-12-24 15:10:07",
        "shippingStatus": "not shipped(未发货)",
        "orderGoods": [{
            "upcCode": "",
            "sku": "3532602072165",
            "internalId": "",
            "saleAmount": 554.37,
            "tagPrice": 395.42,
            "qty": 1
        }]
    }],
    "total": 57
}

Return Parameter Example

参数	类型	描述
errorCode	number	请求结果，200：成功；400+：客户端异常；500+：服务器异常
msg	string	请求的返回信息
data	array	订单信息
orderSn	string	能猫订单管理系统的订单编号
orderAccount	string	天猫账号
orderAmount	number	订单总数
shippingFee	number	订单运费
discountSum	number	订单的折扣合计数
consignee	string	收货人姓名
country	string	收货人姓名
province	string	收货人所在省
city	string	收货人所在城市
district	string	收货人所在区域
address	string	收货人具体地址
zipcode	string	收货人邮政编码
telephone	string	收货人电话
mobile	string	收货人手机号码
platform	string	销售平台
paymentSn	string	订单支付编号
paymentType	string	订单支付类型
createTime	string	创建时间
payTime	string	支付时间
shippingStatus	string	发货状态
orderGoods	array	订单的产品信息
sku	string	产品SKU
upcCode	string	条形码
saleAmount	number	产品销售总价
tagPrice	number	产品标签价格
qty	number	卖出产品质量
total	number	合计数量

6.2. 品牌取消订单接口

接口说明

品牌可调用此接口进行订单的取消
支持对多个订单的操作

请求地址

https://sh-api.nengmao.net/tmg/api/order/cancelbybrand【生产环境】
https://sh-sandbox.nengmao.net/tmg/api/order/cancelbybrand【沙箱环境】

请求方式 : POST

公共参数

参数	是否必填	类型	描述
appKey	是	string	调用接口所需的KEY值
appSecret	是	string	调用接口所需的密钥
timestamp	是	int	时间戳，两分钟内有效，时区：东八区
sign	是	string	签名
format	否	string	返回数据格式，默认为JSON

请求参数

参数	是否必填	类型	描述
cancelList	是	array	取消订单信息
orderSn	是	string	订单编号
status	是	number	订单取消状态，10：取消成功；20：取消失败
message	否	string	说明信息
goodsList	是	array	产品信息
sku	是	string	产品SKU
internalId	否	string	品牌内部的产品编码
qty	是	number	产品质量

请求示例

{
    "cancelList": [{
        "orderSn": "162724553352511111",
        "status": 10,
        "message": "品牌方缺货取消",
        "goodsList": [{
            "sku": "3840438387414",
            "internalId":"11122211221",
            "qty": 1
         }]
    }]
}

响应示例

{
    "errorCode": 200,
    "msg": "operate successful(操作成功)",
    "data": {
        "successList": [
            "162724553352511111"
        ],
        "failureList": []
    }
}

响应参数

参数	类型	描述
errorCode	number	请求结果，200：成功；400+：客户端异常；500+：服务器异常
msg	string	请求的返回信息
data	array	操作结果信息
successList	array	成功信息
failureList	array	失败信息

6.3. 订单收货确认接口

接口说明

调用此接口可进行订单的收货确认
支持对多个订单的操作

请求地址

https://sh-api.nengmao.net/tmg/api/status/confirmation【生产环境】
https://sh-sandbox.nengmao.net/tmg/api/status/confirmation【沙箱环境】

请求方式 : POST

公共参数

参数	是否必填	类型	描述
appKey	是	string	调用接口所需的KEY值
appSecret	是	string	调用接口所需的密钥
timestamp	是	int	时间戳，两分钟内有效，时区：东八区
sign	是	string	签名
format	否	string	返回数据格式，默认为JSON

请求参数

参数	是否必填	类型	描述
orderSnList	否	array	新订单信息
returnSnList	否	array	取消订单信息

请求示例

{
    "orderSnList": ["104587766749540598"],
    "returnSnList":["9109033548491234"]
}

响应示例

{
    "errorCode": 200,
    "msg": "operate successful(操作成功)",
    "data": {
        "orderResult": {
            "successList": [
                "104587766749540598"
            ],
            "failureList": []
        },
        "returnResult": {
            "successList": [
                "9109033548491234"
            ],
            "failureList": []
        }
    }
}

响应参数

参数	类型	描述
errorCode	number	请求结果，200：成功；400+：客户端异常；500+：服务器异常
msg	string	请求的返回信息
data	array	操作结果信息
orderResult	object	订单操作结果
successList	array	成功信息
failureList	array	失败信息
returnResult	object	取消操作结果

6.4. 创建订单接口

接口说明

调用此接口可进行订单的创建操作
支持对多个订单的操作

请求地址

https://sh-sandbox.nengmao.net/tmg/api/order/create【沙箱环境】

请求方式 : POST

公共参数

参数	是否必填	类型	描述
appKey	是	string	调用接口所需的KEY值
appSecret	是	string	调用接口所需的密钥
timestamp	是	int	时间戳，两分钟内有效，时区：东八区
sign	是	string	签名
format	否	string	返回数据格式，默认为JSON

请求参数

参数	是否必填	类型	描述
orderSn	是	string	天猫平台订单编号
orderAccount	是	string	天猫账号
orderAmount	是	number	订单总数
shippingFee	是	number	订单运费
discountAmountSum	是	number	订单的折扣合计数
consignee	是	string	收货人姓名
country	是	string	收货人姓名
province	是	string	收货人所在省
city	是	string	收货人所在城市
district	是	string	收货人所在区域
address	是	string	收货人具体地址
zipcode	是	string	收货人邮政编码
telephone	是	string	收货人电话
mobile	是	string	收货人手机号码
platform	是	string	销售平台
paymentSn	是	string	订单支付编号
paymentType	是	string	订单支付类型
createTime	是	string	创建时间
payTime	是	string	支付时间
orderGoods	是	array	订单的产品信息
sku	是	string	产品SKU
upcCode	是	string	条形码
saleAmount	是	number	产品销售总价
tagPrice	是	number	产品标签价格
internalId	否	string	品牌内部的产品编码
qty	是	number	卖出产品质量

请求示例

[{
	"orderSn": "120023153050487191",
	"orderAccount": "刘婷19921023",
	"orderAmount": 554.37,
	"shippingFee": 100,
	"discountAmountSum":0,
	"consignee": "刘大爷",
	"country": "中国",
	"province": "广东省",
	"city": "广州市",
	"district": "越秀区",
	"address": "黄花岗街道天河北水荫路柏高酒店419房间(送到房间来",
	"zipcode": "510180",
	"telephone": "15827554247",
	"mobile": "",
	"platform": "TM",
	"paymentSn": "2017122421001001630262632854",
	"paymentType": "alipay",
	"createTime": "2018-07-04 17:14:20",
	"payTime": "2017-12-24 15:10:07",
	"orderGoods": [{
		"upcCode": "",
		"sku": "39116-8.0",
		"internalId": "",
		"saleAmount": 554.37,
		"tagPrice": 554.37,
		"qty": 1
	}]
}]

响应示例

{
    "errorCode": 200,
    "msg": "operate successful(操作成功)",
    "data": [{
        "orderSn": "120023153050487191",
        "orderAccount": "刘婷19921023",
        "orderAmount": 554.37,
        "shippingFee": 100,
        "discountAmountSum": 0,
        "consignee": "刘大爷",
        "country": "中国",
        "province": "广东省",
        "city": "广州市",
        "district": "越秀区",
        "address": "黄花岗街道天河北水荫路柏高酒店419房间(送到房间来",
        "zipcode": "510180",
        "telephone": "15827554247",
        "mobile": "",
        "platform": "TM",
        "paymentSn": "2017122421001001630262632854",
        "paymentType": "alipay",
        "createTime": "2018-07-04 17:14:20",
        "payTime": "2017-12-24 15:10:07",
        "shippingStatus": "not shipped(未发货)",
        "orderGoods": [{
            "upcCode": "",
            "sku": "39116-8.0",
            "internalId": "39116",
            "saleAmount": 554.37,
            "tagPrice": 554.37,
            "qty": 1
        }]
    }]
}

响应参数

参数	类型	描述
errorCode	number	请求结果，200：成功；400+：客户端异常；500+：服务器异常
msg	string	请求的返回信息
data	array	操作结果信息
orderSn	string	天猫平台订单编号
orderAccount	string	天猫账号
orderAmount	number	订单总数
shippingFee	number	订单运费
discountAmountSum	number	订单的折扣合计数
consignee	string	收货人姓名
country	string	收货人姓名
province	string	收货人所在省
city	string	收货人所在城市
district	string	收货人所在区域
address	string	收货人具体地址
telephone	string	收货人电话
zipcode	string	收货人邮政编码
mobile	string	收货人手机号码
platform	string	销售平台
paymentSn	string	订单支付编号
paymentType	string	订单支付类型
createTime	string	创建时间
payTime	string	支付时间
shippingStatus	string	发货状态
remark	string	订单备注
orderGoods	array	订单的产品信息
sku	string	产品SKU
upcCode	string	条形码
saleAmount	number	产品销售总价
tagPrice	number	产品标签价格
internalId	string	品牌内部的产品编码
qty	number	卖出产品质量

6.5. 天猫取消订单接口

接口说明

天猫平台可调用此接口进行订单的取消
支持对多个订单的操作

请求地址

https://sh-api.nengmao.net/tmg/api/order/cancelbybrand【生产环境】
https://sh-sandbox.nengmao.net/tmg/api/order/cancelbybrand【沙箱环境】

请求方式 : POST

公共参数

参数	是否必填	类型	描述
appKey	是	string	调用接口所需的KEY值
appSecret	是	string	调用接口所需的密钥
timestamp	是	int	时间戳，两分钟内有效，时区：东八区
sign	是	string	签名
format	否	string	返回数据格式，默认为JSON

请求参数

参数	是否必填	类型	描述
cancelList	是	array	取消订单信息
orderSn	是	string	订单编号
status	是	number	订单取消状态，10：取消成功；20：取消失败
message	否	string	说明信息
goodsList	是	array	产品信息
sku	是	string	产品SKU
internalId	否	string	品牌内部的产品编码
qty	是	number	产品质量

请求示例

{
    "cancelList": [{
        "orderSn": "162724553352511111",
        "status": 10,
        "message": "品牌方缺货取消",
        "goodsList": [{
            "sku": "3840438387414",
            "internalId":"11122211221",
            "qty": 1
         }]
    }]
}

响应示例

{
    "errorCode": 200,
    "msg": "operate successful(操作成功)",
    "data": {
        "successList": [
            "162724553352511111"
        ],
        "failureList": []
    }
}

响应参数

参数	类型	描述
errorCode	number	请求结果，200：成功；400+：客户端异常；500+：服务器异常
msg	string	请求的返回信息
data	array	操作结果信息
successList	array	成功信息
failureList	array	失败信息

7. 退货接口

7.1. 退货查询接口

接口说明

调用此接口可查询订单的退货信息 (支持多页查询)

请求地址

https://sh-api.nengmao.net/tmg/api/return/list【生产环境】
https://sh-sandbox.nengmao.net/tmg/api/return/list【沙箱环境】

请求方式 : POST

公共参数

参数	是否必填	类型	描述
appKey	是	string	调用接口所需的KEY值
appSecret	是	string	调用接口所需的密钥
timestamp	是	int	时间戳，2分钟内有效，时区：东八区
sign	是	string	签名
format	否	string	返回数据格式，默认为JSON

请求参数

参数	是否必填	类型	描述
startModifyTime	否	string	退货的修改起始时间
endModifyTime	否	string	退货的修改结束时间
returnStatus	否	number	退货状态 0：已创建；1：待发货； 2：已发货；3：已取消
pageNo	否	number	页数，默认值为1
pageSize	否	number	每页条数，默认值为10，最大值为100
returnType	否	string	订单类型，Y：新订单；N：已经撤回的旧订单，默认值为Y

请求示例

{
    "startModifyTime": "2017-04-10",
    "endModifyTime": "2018-08-15",
    "returnStatus": 1,
    "returnType":"y",
    "pageNo": 1,
    "pageSize": 1
}

响应示例

{
    "errorCode": 200,
    "msg": "operate successful(操作成功)",
    "data": [{
        "returnSn": "9109033548491234",
        "returnAccount": "will3will",
        "returnAmount": 570.48,
        "returnShippingFee": 0,
        "returnee": "郭起林",
        "province": "湖南省",
        "city": "长沙市",
        "district": "开福区",
        "zipcode": "410005",
        "address": "伍家岭街道 芙蓉中路一段88号天健芙蓉9栋304",
        "expressCompany": "天天快递",
        "expressSn": "668846337098",
        "telephone": "18768656789",
        "mobile": "",
        "orderSn": "151120756299491234",
        "goodsList": [{
            "sku": "3543638636016",
            "upcCode": "",
            "internalId": "",
            "goodsAmount": 570.48,
            "qty": 1
        }]
    }],
    "total": 58
}

Return Parameter Example

参数	类型	描述
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	退货人手机号码
orderSn	string	天猫平台订单编号
goodsList	array	退货产品信息
sku	string	退货产品SKU
upcCode	string	条形码
internalId	string	品牌内部的产品编码
goodsAmount	number	退款总金额
qty	number	退货产品的数量
total	number	合计数量

7.2. 退货创建接口

接口说明

调用此接口可进行退货的创建
支持对多个退货的操作

请求地址

https://sh-sandbox.nengmao.net/tmg/api/return/create【沙箱环境】

请求方式 : POST

公共参数

参数	是否必填	类型	描述
appKey	是	string	调用接口所需的KEY值
appSecret	是	string	调用接口所需的密钥
timestamp	是	int	时间戳，两分钟内有效，时区：东八区
sign	是	string	签名
format	否	string	返回数据格式，默认为JSON

请求参数

参数	是否必填	类型	描述
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	退货人手机号码
orderSn	是	string	天猫平台订单编号
goodsList	是	array	退货产品信息
sku	是	string	产品SKU
upcCode	否	string	条形码
internalId	是	string	品牌内部的产品编码
goodsAmount	是	number	退款总金额
qty	是	string	退货产品的质量

请求示例

[{
    "returnSn": "9109033548491234",
    "returnAccount": "will3will",
    "returnAmount": 570.48,
    "returnShippingFee": 0,
    "returnee": "郭起林",
    "province": "湖南省",
    "city": "长沙市",
    "district": "开福区",
    "zipcode": "410005",
    "address": "伍家岭街道 芙蓉中路一段88号天健芙蓉9栋304",
    "expressCompany": "天天快递",
    "expressSn": "668846337098",
    "telephone": "18768656789",
    "mobile": "",
    "orderSn": "151120756299491234",
    "goodsList": [{
        "sku": "74675-10.5",
        "upcCode": "",
        "internalId": "",
        "goodsAmount": 570.48,
        "qty": 1
    }]
}]

响应示例

{
    "errorCode": 200,
    "msg": "operate successful(操作成功)",
    "data": [{
        "returnSn": "9109033548491234",
        "returnAccount": "will3will",
        "returnAmount": 570.48,
        "returnShippingFee": 0,
        "returnee": "郭起林",
        "province": "湖南省",
        "city": "长沙市",
        "district": "开福区",
        "zipcode": "410005",
        "address": "伍家岭街道 芙蓉中路一段88号天健芙蓉9栋304",
        "expressCompany": "天天快递",
        "expressSn": "668846337098",
        "telephone": "18768656789",
        "mobile": "",
        "orderSn": "151120756299491234",
        "goodsList": [{
            "sku": "74675-10.5",
            "upcCode": "",
            "internalId": "74675",
            "goodsAmount": 570.48,
            "qty": 1
        }]
    }]
}

响应参数

参数	类型	描述
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	退货人手机号码
orderSn	string	天猫平台订单编号
goodsList	array	退货产品信息
sku	string	产品SKU
upcCode	string	条形码
internalId	string	品牌内部的产品编码
goodsAmount	number	退款总金额
qty	number	退货产品的质量

8. Product

8.1. Product List

请求地址

https://sh-api.nengmao.net/tmg/api/goods【生产环境】
https://sh-sandbox.nengmao.net/tmg/api/goods【沙箱环境】

请求方式 : 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	产品描述图片地址
target	否	否	string	物流方式
hscode	是	是	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...）
以下为产品SKU相关字段信息
skuList	是	是	array	品牌的SKU信息
color	否	是	string	颜色
colorCode	否	否	string	颜色编码
size	否	是	string	尺码
sizeCode	否	否	string	尺码编码
sku	是	是	string	产品SKU
upcCode	否	否	string	条形码
internalId	否	否	string	品牌内部的产品编码
marketPrice	否	否	number	标签价格
salePrice	是	是	number	销售价格
importFee	否	否	number	Import Tax
colorImage	否	否	string	颜色表
images	是	是	number	产品图片，至少要提供一张，分隔符为“\|”
stocks	否	否	number	产品库存量
以上为产品SKU相关字段信息

请求示例

{
    "goodsList":[{
        "brand":"nike",
        "brandImage":"https://img.alicdn.com/bJjy1XcXXcpdXXa.jpg",
        "goodsSn":"Brand1194122331",
        "goodsTitle":"NIKE AIR MAX男子气垫训练鞋869633",
        "goodsCategory":"运动鞋",
        "goodsSeason":"秋季",
        "goodsSeries":"",
        "goodsYears":"2017年",
        "weight":"11",
        "description":"211221222",
        "descriptionImage":"https://img.alicdn.com/i!890482188.jpg",
        "material":"",
        "volume":"",
        "measure":"11",
        "characteristics":"112",
        "sizeChart":"1ag",
        "hscode":"11212",
        "target":"12231",
        "skuList":[{
            "color":"red",
            "size":"X",
            "sku":"Branda31869633",
            "upcCode":"6919721232",
            "marketPrice":900,
            "salePrice":629,
            "stocks":110,
            "internalId":"121212",
            "importFee":12,
            "images":"https://img.alicdn.com/im_430x430q90.jpg",
            "colorImage":"https://img.alicdn.com/img/111.jpg"
        }]
    }]
}

响应示例

{
    "errorCode": 200,
    "msg": "operate successful(操作成功)",
    "data": [{
        "goodsSn": "Brand1194122331",
        "goodsTitle": "NIKE AIR MAX男子气垫训练鞋869633",
        "goodsBrand": "nike",
        "brandImage": "https://img.alicdn.com/bJjy1XcXXcpdXXa.jpg",
        "goodsCategory": "运动鞋",
        "goodsSeason": "秋季",
        "goodsSeries": "",
        "weight": "11",
        "description": "211221222",
        "descriptionImage": "https://img.alicdn.com/i!890482188.jpg",
        "material": "",
        "volume": "",
        "characteristics": "112",
        "measure": "11",
        "sizeChart": "1ag",
        "hscode": "11212",
        "target": "12231",
        "createTime": "2018-07-17 13:39:03",
        "modifyTime": "2018-07-17 13:39:03",
        "goodsList": [{
            "goodsSn": "Brand1194122331",
            "color": "red",
            "size": "X",
            "sku": "Branda31869633",
            "upcCode": "6919721232",
            "internalId": "121212",
            "marketPrice": 900,
            "salePrice": 629,
            "inventory": 110,
            "lockInventory": 0,
            "importFee": 12,
            "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	产品编号
goodsTitle	string	产品名称
goodsBrand	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	尺码表
hscode	string	通用商品编码
target	string	物流方式
currency	string	货币
originCountry	string	原产地国家
careInfo	string	注意事项
shippingRestriction	string	运输限制
newArrivals	string	是否为新款
description	string	描述
targetActiveDate	string	目标激活日期
priority	string	优先上新标识
merchClass	string	商品等级
status	number	产品的状态
createTime	string	创建时间
modifyTime	string	修改时间
goodsList	array	产品信息
goodsSn	string	产品编号
color	string	颜色
size	string	尺码
upcCode	string	条形码
internalId	string	品牌内部的产品编码
marketPrice	number	标签价格
salePrice	number	销售价格
inventory	number	库存总量
lockInventory	number	被锁定的库存量
importFee	number	进口费用
status	number	产品状态（0：有存货；1：出售中）
images	string	产品图片
colorImage	string	颜色图片

8.2. Product Query List

请求地址

https://sh-api.nengmao.net/tmg/api/goods/list【生产环境】
https://sh-sandbox.nengmao.net/tmg/api/goods/list【沙箱环境】

请求方式 : POST

公共参数

参数	是否必填	类型	描述
appKey	是	string	调用接口所需的KEY值
appSecret	是	string	调用接口所需的密钥
timestamp	是	int	时间戳，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": "",
            "hscode": "",
            "target": "",
            "createTime": "2018-09-04 16:23:47",
            "modifyTime": "2018-09-04 16:23:47",
            "goodsList": [
                {
                    "goodsSn": "1VB90065 127",
                    "color": "white",
                    "size": "12.0",
                    "sku": "29376-12.0",
                    "upcCode": "",
                    "internalId": "",
                    "marketPrice": 0,
                    "salePrice": 150,
                    "inventory": 1,
                    "lockInventory": 0,
                    "importFee": 0,
                    "status": 0,
                    "images": "",
                    "colorImage": ""
                }
            ]
        }
    ],
    "total": 13
}

响应参数

参数	类型	描述
errorCode	number	请求结果，200：成功；400+：客户端异常；500+：服务器异常
msg	string	请求的返回信息
data	array	产品信息数据
goodsSn	string	产品编号
goodsTitle	string	产品名称
goodsBrand	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	尺码表
hscode	string	通用商品编码
target	string	物流方式
currency	string	货币
originCountry	string	原产地国家
careInfo	string	注意事项
shippingRestriction	string	运输限制
newArrivals	string	是否为新款
description	string	描述
targetActiveDate	string	目标激活日期
priority	string	优先上新标识
merchClass	string	商品等级
status	number	产品的状态
createTime	string	创建时间
modifyTime	string	修改时间
goodsList	array	产品信息
goodsSn	string	产品编号
color	string	颜色
size	string	尺码
upcCode	string	条形码
internalId	string	品牌内部的产品编码
marketPrice	number	标签价格
salePrice	number	销售价格
inventory	number	库存总量
lockInventory	number	被锁定的库存量
importFee	number	进口费用
status	number	产品状态（0：有存货；1：出售中）
images	string	产品图片
colorImage	string	颜色图片
total	number	合计数量

9. 价格接口

9.1. 价格更新接口

接口说明

调用此接口可进行商品出售价格增量更新
调用此接口一次最多支持100件产品的价格更新
产品采用SKU和（或）条形码进行标识

请求地址

https://sh-api.nengmao.net/tmg/api/price/update【生产环境】
https://sh-sandbox.nengmao.net/tmg/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	产品国际通用条形码
internalId	否	否	string	品牌内部的产品编号
salePrice	是	是	number	产品出售价格
goodsSn	否	是	string	产品编号

请求示例

{
    "skuList":[{
        "sku":"Branda31869633",
        "internalId":"121212",
        "salePrice":1900
    }]
}

响应示例

{
    "errorCode": 200,
    "msg": "operate successful(操作成功)",
    "data": [{
        "goodsSn": "Brand1194122331",
        "color": "red",
        "size": "X",
        "sku": "Branda31869633",
        "upcCode": "6919721232",
        "internalId": "121212",
        "marketPrice": 900,
        "salePrice": 1900,
        "inventory": 110,
        "lockInventory": 0,
        "importFee": 12,
        "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	条形码
internalId	string	品牌内部的产品编码
marketPrice	number	标签价格
salePrice	number	销售价格
inventory	number	库存总量
lockInventory	number	被锁定的库存量
importFee	number	进口费用
status	number	产品状态（0：有存货；1：出售中）
images	string	产品图片
colorImage	string	颜色图片

外部系统对接天猫国际商铺API接口文档 更新日期: 2019-02-18

1. 对接说明

2. 快递公司编码

3. 请求参数签名

4. 返回错误值说明

5. 库存接口

5.1. 库存更新接口

接口说明

请求地址

请求方式 : POST

公共参数

Request Parameters

请求示例

响应示例

响应参数

6. 销售订单接口

6.1. 订单查询接口

接口说明

请求地址

请求方式 : POST

公共参数

请求参数

请求示例

响应示例

Return Parameter Example

6.2. 品牌取消订单接口

接口说明

请求地址

请求方式 : POST

公共参数

请求参数

请求示例

响应示例

响应参数

6.3. 订单收货确认接口

接口说明

请求地址

请求方式 : POST

公共参数

请求参数

请求示例

响应示例

响应参数

6.4. 创建订单接口

接口说明

请求地址

请求方式 : POST

公共参数

请求参数

请求示例

响应示例

响应参数

6.5. 天猫取消订单接口

接口说明

请求地址

请求方式 : POST

公共参数

请求参数

请求示例

响应示例

响应参数

7. 退货接口

7.1. 退货查询接口

接口说明

请求地址

请求方式 : POST

公共参数

请求参数

请求示例

响应示例

Return Parameter Example

7.2. 退货创建接口

接口说明

请求地址

请求方式 : POST

公共参数

请求参数

请求示例

响应示例

响应参数

外部系统对接天猫国际商铺API接口文档更新日期: 2019-02-18