1. 对接说明
- 域名 : api.nengmao.net
- 请求协议: 支持 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. 请求示例代码
OkHttpClient client = new OkHttpClient().newBuilder().build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"startCreateTime\":\"2025-09-10 00:00:00\",\"endCreateTime\":\"2025-09-11 00:00:00\",\"orderStatus\":\"2\",\"orderType\":\"Y\"}");
Request request = new Request.Builder()
.url("https://sandbox.nengmao.net/api/order/list")
.method("POST", body)
.addHeader("timestamp", "175665600000")
.addHeader("appKey", "userAppkey")
.addHeader("sign", "userSign")
.addHeader("appSecret", "userSecret")
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
5. 返回错误值说明
| 错误代码 |
类型 |
说明 |
| 200 |
正确 |
请求成功 |
| 400 |
客户端异常 |
请求参数异常 |
| 401 |
客户端异常 |
请求时间戳为空 |
| 402 |
客户端异常 |
请求时间戳超过最大值 |
| 403 |
客户端异常 |
请求时间戳非数字 |
| 404 |
客户端异常 |
请求参数appKey或appSecret为空 |
| 405 |
客户端异常 |
请求参数appKey或appSecret不存在 |
| 406 |
客户端异常 |
请求集合参数超过1000 |
| 407 |
客户端异常 |
请求参数sign不匹配 |
| 408 |
客户端异常 |
请求sku或upcCode参数至少包括其中之一 |
| 409 |
客户端异常 |
请求参数sign为空 |
| 410 |
客户端异常 |
请求sku不存在 |
| 411 |
客户端异常 |
请求orderSn不存在 |
| 412 |
客户端异常 |
请求returnSn不存在 |
| 413 |
客户端异常 |
请求goodsList为空 |
| 414 |
客户端异常 |
请求Json数据格式错误 |
| 415 |
客户端异常 |
请求Json参数错误 |
| 416 |
客户端异常 |
请求订单商品数量超过在库库存 |
| 417 |
客户端异常 |
订单已经存在 |
| 418 |
客户端异常 |
订单商品不能为空 |
| 419 |
客户端异常 |
订单已经发货,不可重复发货 |
| 420 |
客户端异常 |
请求参数goodsSnList和skuList不能同时使用 |
| 421 |
客户端异常(order/ship接口) |
部分订单发货成功(successList),部分订单请求sku或数量与订单不一致(failureList) |
| 422 |
客户端异常(order/ship接口) |
发货失败,请求sku或数量与订单不一致(failureList) |
| 423 |
客户端异常(order/cancelConfirm接口) |
部分订单确认取消成功(successList),部分订单取消失败(failureList) |
| 424 |
客户端异常(order/cancelConfirm接口) |
确认取消失败,请求订单当前状态不允许取消(failureList) |
| 500 |
服务器端异常 |
系统异常 |
| 500+ |
服务器端异常 |
系统异常 |
6. 商品API
6.1. 商品列表
接口说明
请求地址
https://api.nengmao.net/api/goods【生产环境】
https://sandbox.nengmao.net/api/goods【沙箱环境】
请求方式 :
POST
公共参数
| 名称 |
是否必须 |
类型 |
描述 |
| appKey |
是 |
String |
api访问key |
| appSecret |
是 |
String |
api访问secret |
| timestamp |
是 |
String |
当前时间戳 |
| sign |
是 |
String |
签名 |
| format |
是 |
String |
示例:json |
请求参数(以下参数不可同时为空)
| 名称 |
是否必须 |
类型 |
描述 |
| goodsList |
是 |
array |
商品列表 (注:数据量不应超过100条) |
| brand |
是 |
String |
品牌名称 |
| brandImage |
否 |
String |
品牌图片地址 |
| goodsSn |
是 |
String |
商品货号 |
| goodsTitle |
是 |
String |
商品标题 |
| goodsCategory |
否 |
String |
商品分类 |
| goodsSeason |
否 |
String |
商品季节 |
| goodsSeries |
否 |
String |
商品系列 |
| goodsYears |
否 |
String |
商品年份 |
| weight |
是 |
String |
重量(单位:kg) |
| description |
否 |
String |
商品文字描述 |
| descriptionImage |
否 |
String |
商品描述图片地址 |
| target |
否 |
String |
物流方式 |
| hscode |
否 |
String |
海关编码 |
| sizeChart |
否 |
String |
尺码表 |
| material |
是 |
String |
材质 |
| volume |
否 |
String |
体积 |
| measure |
否 |
String |
尺寸 |
| characteristics |
否 |
String |
特征信息,多个特征信息用|分割 |
| currency |
否 |
String |
商品货币 |
| originCountry |
否 |
String |
来源地 |
| careInfo |
否 |
String |
注意事项 |
| shippingRestriction |
否 |
String |
运输限制 |
| newArrivals |
否 |
String |
是否新款 |
| updateInfo |
否 |
String |
更新内容 |
| remarks |
否 |
String |
备注 |
| targetActiveDate |
否 |
String |
目标上架时间 |
| merchClass |
否 |
String |
商品级别 |
| priority |
否 |
String |
优先上线 1、优先上线 |
| deliverySeperate |
否 |
String |
是否拆单 |
| dimensions |
否 |
String |
尺寸/规模 |
| modelNotes |
否 |
String |
注意事项 |
| additionalDescription |
否 |
String |
附加说明 |
| vendorBrand |
否 |
String |
供应商品牌 |
| careFacet |
否 |
String |
护理说明 |
| goodsStyleNo |
否 |
String |
商品货号编码 |
| fitMeasurement |
否 |
array |
尺寸介绍 |
| tmallLocalNotes |
否 |
String |
内部天猫备注 |
| productID |
否 |
String |
产品id |
| skuList |
是 |
array |
商品SKU列表 |
| color |
是 |
String |
颜色 |
| colorCode |
否 |
String |
颜色代码 |
| size |
是 |
String |
尺码 |
| sizeCode |
否 |
String |
尺码代码 |
| sku |
是 |
String |
商品sku |
| upcCode |
否 |
String |
商品国际码 |
| internalId |
否 |
String |
内部代码 |
| marketPrice |
是 |
number |
市场价格 |
| salePrice |
是 |
number |
销售价格 |
| importFee |
否 |
number |
税费 |
| colorImage |
否 |
String |
颜色图 |
| images |
是 |
String |
商品主图,多张图片用|分割 |
| video |
否 |
String |
商品视频,多条视频用|分割 |
| videoImage |
否 |
String |
商品视频缩略图,多张图片用|分割 |
| isDiscount |
否 |
String |
是否折扣 |
| stocks |
否 |
number |
库存 |
| shippingRestriction |
否 |
String |
承运说明 |
| tmallNotes |
否 |
String |
天猫备注 |
| ipStatus |
否 |
String |
ip状态 |
| safeValid |
否 |
Boolean |
是否开启安全库存 |
| colorId |
否 |
String |
颜色ID |
| sizeId |
否 |
String |
尺码ID |
| tmallLocalNotes |
否 |
String |
内部天猫备注 |
返回参数说明
| 名称 |
类型 |
描述 |
| errorCode |
number |
返回代码 |
| msg |
String |
返回信息 |
| data |
array |
商品列表 |
| brand |
String |
品牌名称 |
| brandImage |
String |
品牌图片地址 |
| goodsSn |
String |
商品货号 |
| goodsTitle |
String |
商品标题 |
| goodsCategory |
String |
商品分类 |
| goodsSeason |
String |
商品季节 |
| goodsSeries |
String |
商品系列 |
| goodsYears |
String |
商品年份 |
| weight |
String |
重量(单位:kg) |
| description |
String |
商品文字描述 |
| descriptionImage |
String |
商品描述图片地址 |
| target |
String |
物流方式 |
| hscode |
String |
海关编码 |
| sizeChart |
String |
尺码表 |
| material |
String |
材质 |
| volume |
String |
体积 |
| characteristics |
String |
特征信息,多个特征信息用|分割 |
| measure |
String |
尺寸 |
| originCountry |
String |
来源地 |
| careInfo |
String |
注意事项 |
| shippingRestriction |
String |
运输限制 |
| newArrivals |
String |
是否新款 |
| updateInfo |
String |
更新内容 |
| priority |
String |
优先上线 1、优先上线 |
| remarks |
String |
备注 |
| currency |
String |
商品货币 |
| targetActiveDate |
String |
目标上架时间 |
| merchClass |
String |
商品级别 |
| deliverySeperate |
String |
是否拆单 |
| dimensions |
String |
尺寸/规模 |
| modelNotes |
String |
注意事项 |
| additionalDescription |
String |
附加说明 |
| vendorBrand |
String |
供应商品牌 |
| careFacet |
String |
护理说明 |
| goodsStyleNo |
String |
商品货号编码 |
| fitMeasurement |
array |
尺寸介绍 |
| tmallLocalNotes |
String |
内部天猫备注 |
| productID |
String |
产品id |
| skuList |
array |
商品SKU列表 |
| color |
String |
颜色 |
| colorCode |
String |
颜色代码 |
| size |
String |
尺码 |
| sizeCode |
String |
尺码代码 |
| sku |
String |
商品sku |
| upcCode |
String |
商品国际码 |
| internalId |
String |
内部代码 |
| marketPrice |
number |
市场价格 |
| salePrice |
number |
销售价格 |
| importFee |
number |
税费 |
| colorImage |
String |
颜色图 |
| images |
String |
商品主图,多张图片用|分割 |
| video |
String |
商品视频 |
| videoImage |
String |
商品视频缩略图,多张图片用|分割 |
| isDiscount |
String |
是否折扣 |
| inventory |
number |
库存 |
| lockInventory |
number |
锁定库存 |
| shippingRestriction |
String |
承运说明 |
| tmallNotes |
String |
天猫备注 |
| ipStatus |
String |
ip状态 |
| safeValid |
Boolean |
是否开启安全库存 |
| colorId |
String |
颜色ID |
| sizeId |
String |
尺码ID |
| tmallLocalNotes |
String |
内部天猫备注 |
请求参数示例
{
"goodsList": [
{
"brand": "nike",
"brandImage": "https://img.alicdn.com/bJjy1XcXXcpdXXa.jpg",
"goodsSn": "Brand12903261803",
"goodsTitle": "NIKE AIR MAX 男子气垫训练鞋 032618",
"goodsCategory": "运动鞋",
"goodsSeason": "春季",
"goodsSeries": "",
"goodsYears": "2019 年",
"weight": "11",
"description": "211221222",
"descriptionImage": "https://img.alicdn.com/i!890482188.jpg",
"target": "B2C",
"hscode": "11212290",
"sizeChart": "42",
"material": "",
"volume": "",
"characteristics": "dddd",
"measure": "12",
"originCountry": "USA",
"careInfo": "Hand wash",
"shippingRestriction": "air",
"newArrivals": "yes",
"deliverySeperate": "no",
"updateInfo": "",
"priority": "",
"remarks": "new shoes",
"currency": "USD",
"targetActiveDate": "",
"merchClass": "1",
"dimensions": "",
"modelNotes": "",
"additionalDescription": "",
"vendorBrand": "",
"careFacet": "",
"goodsStyleNo":"",
"tmallLocalNotes":"",
"productID":"",
"fitMeasurement":[
{
"measurementTitle":"Length",
"us":"13.0","metric":"33.02"
},
{
"measurementTitle":"Strap Length",
"us":"16.5","metric":"41.91"
}
],
"skuList": [
{
"color": "red",
"colorCode": "aa",
"size": "X",
"sizeCode": "X",
"sku": "Branda03261805",
"upcCode": "23121212",
"internalId": "",
"marketPrice": 1099,
"salePrice": 999,
"importFee": 32,
"colorImage": "https://img.alicdn.com/im_430x430q90.jpg",
"images": "https://img.alicdn.com/im_430x430q90.jpg|https://img.alicdn.com/im_01.jpg|https://img.alicdn.com/im_02.jpg",
"video":"",
"videoImage":"",
"isDiscount":"",
"stocks": 110,
"shippingRestriction": "",
"tmallNotes": "",
"safeValid":true,
"ipStatus":"C3",
"colorId":"000",
"sizeId":"10021",
"tmallLocalNotes":""
}
]
}
]
}
返回示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": [
{
"brand": "nike",
"brandImage": "https://img.alicdn.com/bJjy1XcXXcpdXXa.jpg",
"goodsSn": "1VB90065 127",
"goodsTitle": "NIKE AIR MAX 男子气垫训练鞋 869633",
"goodsCategory": "运动鞋",
"goodsSeason": "秋季",
"goodsSeries": "",
"goodsYears": "2017 年",
"weight": "11",
"description": "211221222",
"descriptionImage": "https://img.alicdn.com/i!890482188.jpg",
"target": "12231",
"hscode": "11212",
"sizeChart": "1ag",
"material": "",
"volume": "",
"characteristics": "112",
"measure": "11",
"originCountry": "",
"careInfo": "",
"shippingRestriction": "",
"newArrivals": "yes",
"deliverySeperate": "no",
"updateInfo": "",
"priority": "",
"remarks": "",
"currency": "",
"targetActiveDate": "",
"merchClass": "",
"dimensions": "",
"modelNotes": "",
"additionalDescription": "",
"vendorBrand": "",
"careFacet": "",
"goodsStyleNo":"",
"tmallLocalNotes":"",
"productID":"",
"fitMeasurement":[
{
"measurementTitle":"Length",
"us":"13.0","metric":"33.02"
},
{
"measurementTitle":"Strap Length",
"us":"16.5","metric":"41.91"
}
],
"createTime": "2018-09-04 16:23:47",
"modifyTime": "2018-09-04 16:23:47",
"skuList": [
{
"color": "red",
"colorCode": "aa",
"size": "X",
"sizeCode": "X",
"sku": "Branda31869633",
"upcCode": "6919721232",
"internalId": "",
"marketPrice": 900,
"salePrice": 629,
"importFee": 12,
"colorImage": "https://img.alicdn.com/im_430x430q90.jpg",
"images": "https://img.alicdn.com/im_430x430q90.jpg|https://img.alicdn.com/im_01.jpg|https://img.alicdn.com/im_02.jpg",
"video": "",
"videoImage": "",
"isDiscount": "",
"inventory": 110,
"lockInventory": 0,
"shippingRestriction": "",
"tmallNotes": "",
"safeValid":true,
"ipStatus":"C3",
"colorId":"000",
"sizeId":"10021",
"tmallLocalNotes":""
}
]
}
],
"total": 13
}
6.2. 商品查询列表
接口说明
请求地址
https://api.nengmao.net/api/goods/list【生产环境】
https://sandbox.nengmao.net/api/goods/list【沙箱环境】
请求方式 :
POST
公共参数
| 名称 |
是否必须 |
类型 |
描述 |
| appKey |
是 |
String |
api访问key |
| appSecret |
是 |
String |
api访问secret |
| timestamp |
是 |
String |
当前时间戳 |
| sign |
是 |
String |
签名 |
| format |
是 |
String |
示例:json |
请求参数(以下参数不可同时为空)
| 名称 |
是否必须 |
类型 |
描述 |
| startCreateTime |
否 |
String |
商品创建时间开始(格式:yyyy-MM-dd HH:mm:ss) |
| endCreateTime |
否 |
String |
商品创建时间结束(格式:yyyy-MM-dd HH:mm:ss) |
| startModifyTime |
否 |
String |
商品修改时间开始(格式:yyyy-MM-dd HH:mm:ss) |
| endModifyTime |
否 |
String |
商品修改时间结束(格式:yyyy-MM-dd HH:mm:ss) |
| goodSnList |
否 |
array |
产品编号数组;数组长度不能大于100(注:goodSnList和skuList不能同时使用) |
| skuList |
否 |
array |
产品的SKU编号数组;数组长度不能大于100(注:goodSnList和skuList不能同时使用 |
| pageNo |
否 |
number |
页码 默认1 |
| pageSize |
否 |
number |
每页条数 默认10条,最大100条 |
返回参数说明
| 名称 |
类型 |
描述 |
| errorCode |
number |
返回代码 |
| msg |
String |
返回信息 |
| data |
array |
订单列表 |
| brand |
String |
品牌名称 |
| brandImage |
String |
品牌图片地址 |
| goodsSn |
String |
商品货号 |
| goodsTitle |
String |
商品标题 |
| goodsCategory |
String |
商品分类 |
| goodsSeason |
String |
商品季节 |
| goodsSeries |
String |
商品系列 |
| goodsYears |
String |
商品年份 |
| weight |
String |
重量(单位:kg) |
| description |
String |
商品文字描述 |
| descriptionImage |
String |
商品描述图片地址 |
| target |
String |
物流方式 |
| hscode |
String |
海关编码 |
| sizeChart |
String |
尺码表 |
| material |
String |
材质 |
| volume |
String |
体积 |
| characteristics |
String |
特征信息,多个特征信息用|分割 |
| measure |
String |
尺寸 |
| originCountry |
String |
来源地 |
| careInfo |
String |
注意事项 |
| shippingRestriction |
String |
运输限制 |
| newArrivals |
String |
是否新款 |
| updateInfo |
String |
更新内容 |
| priority |
String |
优先上线 1、优先上线 |
| remarks |
String |
备注 |
| currency |
String |
商品货币 |
| targetActiveDate |
String |
目标上架时间 |
| merchClass |
String |
商品级别 |
| deliverySeperate |
String |
是否拆单 |
| dimensions |
String |
尺寸/规模 |
| modelNotes |
String |
注意事项 |
| additionalDescription |
String |
附加说明 |
| vendorBrand |
String |
供应商品牌 |
| careFacet |
String |
护理说明 |
| goodsStyleNo |
String |
商品货号编码 |
| fitMeasurement |
array |
尺寸介绍 |
| tmallLocalNotes |
String |
内部天猫备注 |
| productID |
String |
产品id |
| skuList |
array |
商品SKU列表 |
| color |
String |
颜色 |
| colorCode |
String |
颜色代码 |
| size |
String |
尺码 |
| sizeCode |
String |
尺码代码 |
| sku |
String |
商品sku |
| upcCode |
String |
商品国际码 |
| internalId |
String |
内部代码 |
| marketPrice |
number |
市场价格 |
| salePrice |
number |
销售价格 |
| importFee |
number |
税费 |
| colorImage |
String |
颜色图 |
| images |
String |
商品主图,多张图片用|分割 |
| video |
String |
商品视频 |
| videoImage |
String |
商品视频缩略图,多张图片用|分割 |
| isDiscount |
String |
是否折扣 |
| inventory |
number |
库存 |
| lockInventory |
number |
锁定库存 |
| shippingRestriction |
String |
承运说明 |
| tmallNotes |
String |
天猫备注 |
| safeValid |
Boolean |
是否开启安全库存 |
| ipStatus |
String |
ip状态 |
| colorId |
String |
颜色ID |
| sizeId |
String |
尺码ID |
| tmallLocalNotes |
String |
内部天猫备注 |
| total |
number |
总记录数 |
请求参数示例
{
"startCreateTime": "2018-01-04 16:23:47",
"endCreateTime": "2018-10-24 16:23:47",
"startModifyTime":"2018-01-04 16:23:47",
"endModifyTime":"2018-10-24 16:23:47",
"goodSnList":["121212","abc1111"],
"skuList":["12345678","2345678"],
"pageNo": 1,
"pageSize": 1
}
返回示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": [
{
"brand": "nike",
"brandImage": "https://img.alicdn.com/bJjy1XcXXcpdXXa.jpg",
"goodsSn": "121212",
"goodsTitle": "NIKE AIR MAX 男子气垫训练鞋 869633",
"goodsCategory": "运动鞋",
"goodsSeason": "秋季",
"goodsSeries": "",
"goodsYears": "2017 年",
"weight": "11",
"description": "211221222",
"descriptionImage": "https://img.alicdn.com/i!890482188.jpg",
"target": "12231",
"hscode": "11212",
"sizeChart": "1ag",
"material": "",
"volume": "",
"characteristics": "112",
"measure": "11",
"originCountry": "",
"careInfo": "",
"shippingRestriction": "",
"newArrivals": "yes",
"deliverySeperate":"no",
"updateInfo": "",
"priority": "",
"remarks": "",
"currency": "",
"targetActiveDate": "",
"merchClass": "",
"dimensions": "",
"modelNotes": "",
"additionalDescription": "",
"vendorBrand": "",
"careFacet": "",
"goodsStyleNo":"",
"tmallLocalNotes":"",
"productID":"",
"fitMeasurement":[
{
"measurementTitle":"Length",
"us":"13.0","metric":"33.02"
},
{
"measurementTitle":"Strap Length",
"us":"16.5","metric":"41.91"
}
],
"createTime": "2018-09-04 16:23:47",
"modifyTime": "2018-09-04 16:23:47",
"skuList": [
{
"color": "red",
"colorCode": "aa",
"size": "X",
"sizeCode": "X",
"sku": "12345678",
"upcCode": "6919721232",
"internalId": "",
"marketPrice": 900,
"salePrice": 629,
"importFee": 12,
"colorImage": "https://img.alicdn.com/im_430x430q90.jpg",
"images": "https://img.alicdn.com/im_430x430q90.jpg|https://img.alicdn.com/im_01.jpg|https://img.alicdn.com/im_02.jpg",
"video": "",
"videoImage": "",
"isDiscount": "",
"inventory": 110,
"lockInventory": 0,
"shippingRestriction": "",
"tmallNotes": "",
"safeValid":true,
"ipStatus":"C3",
"colorId":"000",
"sizeId":"10021",
"tmallLocalNotes":""
}
]
}
],
"total": 13
}
6.3. 库存更新
接口说明
请求地址
https://api.nengmao.net/api/stocks/update【生产环境】
https://sandbox.nengmao.net/api/stocks/update【沙箱环境】
请求方式 :
POST
公共参数
| 名称 |
是否必须 |
类型 |
描述 |
| appKey |
是 |
String |
api访问key |
| appSecret |
是 |
String |
api访问secret |
| timestamp |
是 |
String |
当前时间戳 |
| sign |
是 |
String |
签名 |
| format |
是 |
String |
示例:json |
请求参数(以下参数不可同时为空)
| 名称 |
是否必须 |
类型 |
描述 |
| updateType |
是 |
number |
库存更新类型0全量1增量 |
| skuList |
是 |
array |
商品sku列表 (注:数据量不应超过2000条) |
| sku |
是 |
String |
商品sku |
| upcCode |
否 |
String |
商品upcCode |
| internalId |
否 |
String |
商品internalId |
| stocks |
是 |
number |
商品库存 |
请求参数示例
{
"updateType": 0,
"skuList": [
{
"sku": "869aa622133",
"internalId": "",
"stocks": 12
},
{
"sku": "869aa622134",
"internalId": "",
"stocks": 0
}
]
}
响应示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": {}
}
6.4. 库存查询列表
接口说明
请求地址
https://api.nengmao.net/api/stocks/list【生产环境】
https://sandbox.nengmao.net/api/stocks/list【沙箱环境】
请求方式 :
POST
公共参数
| 名称 |
是否必须 |
类型 |
描述 |
| appKey |
是 |
String |
api访问key |
| appSecret |
是 |
String |
api访问secret |
| timestamp |
是 |
String |
当前时间戳 |
| sign |
是 |
String |
签名 |
| format |
是 |
String |
示例:json |
请求参数(以下参数不可同时为空)
| 名称 |
是否必须 |
类型 |
描述 |
| startModifyTime |
否 |
String |
库存修改时间开始(注:(格式:yyyy-MM-dd HH:mm:ss)修改时间和skuList至少有一个必填) |
| endModifyTime |
否 |
String |
库存修改时间结束(注:(格式:yyyy-MM-dd HH:mm:ss)修改时间和skuList至少有一个必填) |
| skuList |
否 |
array |
产品的SKU编号数组;数组长度不能大于100 (注:修改时间和skuList至少有一个必填) |
| pageNo |
否 |
number |
页码 默认1 |
| pageSize |
否 |
number |
每页条数 默认10条,最大100条 |
返回参数说明
| 名称 |
类型 |
描述 |
| errorCode |
number |
返回代码 |
| msg |
String |
返回信息 |
| data |
array |
库存列表 |
| sku |
String |
SKU |
| stocks |
number |
库存数量 |
| lastModifyTime |
String |
上次修改时间 |
| total |
number |
总记录数 |
请求参数示例
{
"startModifyTime":"2019-01-04 16:23:47",
"endModifyTime":"2020-05-20 16:23:47",
"skuList":["10009272","10333383","11634854","13037544"],
"pageNo":1,
"pageSize":100
}
返回示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": [
{
"sku": "10009272",
"stocks": 0,
"lastModifyTime": "2020-03-17 04:35:19"
},
{
"sku": "10333383",
"stocks": 0,
"lastModifyTime": "2020-03-17 04:35:19"
},
{
"sku": "11634854",
"stocks": 0,
"lastModifyTime": "2020-03-17 04:35:19"
},
{
"sku": "13037544",
"stocks": 0,
"lastModifyTime": "2020-03-17 04:35:19"
}
],
"total": 4
}
}
6.5. 价格更新
接口说明
请求地址
https://api.nengmao.net/api/price/update【生产环境】
https://sandbox.nengmao.net/api/price/update【沙箱环境】
请求方式 :
POST
公共参数
| 名称 |
是否必须 |
类型 |
描述 |
| appKey |
是 |
String |
api访问key |
| appSecret |
是 |
String |
api访问secret |
| timestamp |
是 |
String |
当前时间戳 |
| sign |
是 |
String |
签名 |
| format |
是 |
String |
示例:json |
请求参数(以下参数不可同时为空)
| 名称 |
是否必须 |
类型 |
描述 |
| skuList |
是 |
array |
商品sku列表 (注:数据量不应超过2000条) |
| sku |
是 |
String |
商品sku |
| upcCode |
否 |
String |
商品upcCode |
| internalId |
否 |
String |
商品internalId |
| salePrice |
是 |
number |
商品售卖价格 |
| isDiscount |
否 |
String |
是否折扣 |
请求示例
{
"skuList": [
{
"sku": "Branda31869633",
"internalId": "121212",
"salePrice": 1900,
"isDiscount": "true"
}
]
}
响应示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": {}
}
6.6. 价格查询列表
接口说明
请求地址
https://api.nengmao.net/api/price/list【生产环境】
https://sandbox.nengmao.net/api/price/list【沙箱环境】
请求方式 :
POST
公共参数
| 名称 |
是否必须 |
类型 |
描述 |
| appKey |
是 |
String |
api访问key |
| appSecret |
是 |
String |
api访问secret |
| timestamp |
是 |
String |
当前时间戳 |
| sign |
是 |
String |
签名 |
| format |
是 |
String |
示例:json |
请求参数(以下参数不可同时为空)
| 名称 |
是否必须 |
类型 |
描述 |
| startModifyTime |
否 |
String |
价格修改时间开始(注:(格式:yyyy-MM-dd HH:mm:ss)修改时间和skuList至少有一个必填) |
| endModifyTime |
否 |
String |
价格修改时间结束(注:(格式:yyyy-MM-dd HH:mm:ss)修改时间和skuList至少有一个必填) |
| skuList |
否 |
array |
产品的SKU编号数组;数组长度不能大于100(注:修改时间和skuList至少有一个必填) |
| pageNo |
否 |
number |
页码 默认1 |
| pageSize |
否 |
number |
每页条数 默认10条,最大100条 |
返回参数说明
| 名称 |
类型 |
描述 |
| errorCode |
number |
返回代码 |
| msg |
String |
返回信息 |
| data |
array |
价格列表 |
| sku |
String |
SKU |
| price |
number |
价格 |
| lastModifyTime |
String |
上次修改时间 |
| total |
number |
总记录数 |
请求参数示例
{
"startModifyTime":"2020-01-04 16:23:47",
"endModifyTime":"2020-03-15 16:23:47",
"skuList":["32329221","89849829"],
"pageNo":1,
"pageSize":100
}
返回示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": [
{
"sku": "32329221",
"price": 1900.00,
"lastModifyTime": "2020-03-17 04:29:48"
},
{
"sku": "89849829",
"price": 2020.00,
"lastModifyTime": "2020-03-17 06:01:53"
}
],
"total": 2
}
7. 交易API
7.1. 订单列表
接口说明
请求地址
https://api.nengmao.net/api/order/list【生产环境】
https://sandbox.nengmao.net/api/order/list【沙箱环境】
请求方式 :
POST
公共参数
| 名称 |
是否必须 |
类型 |
描述 |
| appKey |
是 |
String |
api访问key |
| appSecret |
是 |
String |
api访问secret |
| timestamp |
是 |
String |
当前时间戳 |
| sign |
是 |
String |
签名 |
| format |
是 |
String |
示例:json |
请求参数(以下参数不可同时为空)
| 参数 |
是否必须 |
类型 |
描述 |
| startCreateTime |
否 |
String |
订单创建时间开始(格式:yyyy-MM-dd HH:mm:ss) |
| endCreateTime |
否 |
string |
订单创建时间结束(格式:yyyy-MM-dd HH:mm:ss) |
| startModifyTime |
否 |
String |
订单修改时间开始(格式:yyyy-MM-dd HH:mm:ss) |
| endModifyTime |
否 |
String |
订单修改时间结束(格式:yyyy-MM-dd HH:mm:ss) |
| orderStatus |
否 |
number |
订单状态 0:已创建;1:待发货; 2:已发货;3:已取消; 4:确认取消;5:部分取消; 6:仓库全部发货;7:仓库部分发货; 默认1:待发货 |
| orderType |
否 |
String |
订单类型 Y新订单 N旧订单 默认Y |
| pageNo |
否 |
number |
页码 默认1 |
| pageSize |
否 |
number |
每页条数,默认10条,最大100条 |
返回参数说明
| 名称 |
类型 |
描述 |
| errorCode |
number |
返回代码 |
| 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 |
收货人地址 |
| zipcode |
String |
邮政编码 |
| telephone |
String |
收货人电话 |
| mobile |
String |
收货人手机号码 |
| platform |
String |
销售平台 |
| paymentSn |
String |
支付订单号 |
| paymentType |
String |
支付方式(alipay为支付宝支付,wx为微信支付,others为其他支付方式) |
| createTime |
String |
创建时间 |
| payTime |
String |
支付时间 |
| shippingStatus |
String |
发货状态 |
| status |
String |
订单状态 |
| lpCode |
String |
lp编码 |
| lpUrl |
String |
lp地址 |
| orderOriginSn |
String |
平台原始单号 |
| remark |
String |
备注 |
| invoiceNumber |
String |
发票单号 |
| orderGoods |
array |
订单商品集合 |
| sku |
String |
商品sku编码 |
| upcCode |
String |
商品69码 |
| saleAmount |
number |
单件商品货值(单件商品的货值,去掉税费运费优惠券等,不管是否包税都减去税费) |
| tagPrice |
number |
商品吊牌价 |
| internalId |
String |
品牌商品internal id |
| qty |
number |
商品销售数量 |
| subOrderTaxFee |
number |
子订单税费(同一sku购买多件的情况下,该税费是多件的税费总和) |
| taxFree |
Boolean |
是否包税 |
| cid |
String |
天猫类目ID |
| cname |
String |
天猫类目名称:服务费费率 |
| engraving |
String |
定制信息 |
| total |
number |
总记录数 |
请求参数示例
{
"startCreateTime": "2020-03-26 16:23:47",
"endCreateTime": "2020-03-27 16:23:47",
"orderStatus": 1,
"orderType": "Y",
"pageNo": 1,
"pageSize": 1
}
返回示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": [
{
"orderSn": "101080953050411111",
"orderAccount": "可key",
"orderAmount": 3810.00,
"shippingFee": 0.00,
"discountAmountSum": 300.00,
"consignee": "胡轩",
"country": "中国",
"province": "广东省",
"city": "深圳市",
"district": "福田区",
"address": " 梅林街道 翰岭院111栋11B",
"zipcode": "000000",
"telephone": "135*******9",
"mobile": "135*******9",
"platform": "TM",
"paymentSn": "2020032622001132000011111222",
"paymentType": "alipay",
"createTime": "2020-03-26 21:33:33",
"payTime": "2020-03-26 21:33:38",
"shippingStatus": "shipped(已发货)",
"lpCode": "LP00088515736389",
"lpUrl": "https://sandbox.nengmao.net/XXX/20190430/424462143579654257377.pdf",
"orderOriginSn": "1675956925941301266",
"remark": "",
"invoiceNumber": "",
"status" : "1",
"orderGoods": [
{
"cid": "",
"cname": "",
"engraving": "",
"internalId": "",
"subOrderTaxFee": 161.82,
"taxFree": true,
"upcCode": "",
"sku": "20-2-Q23-TP0001",
"saleAmount": 1636.57,
"tagPrice": 1940.00,
"qty": 1
},
{
"cid": "",
"cname": "",
"engraving": "",
"internalId": "",
"subOrderTaxFee": 181.00,
"taxFree": true,
"upcCode": "",
"sku": "21-1-008320-E00008",
"saleAmount": 1830.61,
"tagPrice": 2170.00,
"qty": 1
}
]
}
],
"total": 57
}
7.2.订单确认
接口说明
- 订单确认、退货单确认,确认已获取到订单或退货单。支持多笔订单
请求地址
https://api.nengmao.net/api/status/confirmation 【生产环境】
https://sandbox.nengmao.net/api/status/confirmation【沙箱环境】
请求方式 :
POST
公共参数
| 名称 |
是否必须 |
类型 |
描述 |
| appKey |
是 |
String |
api访问key |
| appSecret |
是 |
String |
api访问secret |
| timestamp |
是 |
String |
当前时间戳 |
| sign |
是 |
String |
签名 |
| format |
是 |
String |
示例:json |
请求参数(以下参数不可同时为空)
| 名称 |
是否必须 |
类型 |
描述 |
| orderSnList |
否 |
array |
订单列表(注:订单确认操作时orderSnList是必填项) |
| returnSnList |
否 |
array |
退单列表(注:退单确认操作时returnSnList是必填项) |
返回参数说明
| 名称 |
类型 |
描述 |
| errorCode |
number |
返回代码 |
| msg |
String |
返回信息 |
| data |
array |
返回数据 |
| orderResult |
对象 |
订单处理结果 |
| successList |
array |
成功列表 |
| failureList |
array |
失败列表 |
| returnResult |
对象 |
退货处理结果 |
请求参数示例
{
"orderSnList": [
"104587766749540598"
],
"returnSnList": [
"9109033548491234"
]
}
返回示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": {
"orderResult": {
"successList": [
"104587766749540598"
],
"failureList": []
},
"returnResult": {
"successList": [
"9109033548491234"
],
"failureList": []
}
}
}
7.3. 主动取消订单
接口说明
请求地址
https://api.nengmao.net/api/order/cancelbybrand【生产环境】
https://sandbox.nengmao.net/api/order/cancelbybrand【沙箱环境】
请求方式 :
POST
公共参数
| 名称 |
是否必须 |
类型 |
描述 |
| appKey |
是 |
String |
api访问key |
| appSecret |
是 |
String |
api访问secret |
| timestamp |
是 |
String |
当前时间戳 |
| sign |
是 |
String |
签名 |
| format |
是 |
String |
示例:json |
请求参数(以下参数不可同时为空)
| 名称 |
是否必须 |
类型 |
描述 |
| cancelList |
是 |
array |
订单取消集合 |
| orderSn |
是 |
String |
tmall平台订单号 |
| status |
是 |
number |
取消状态 10:成功20:失败 |
| message |
否 |
String |
取消结果原因 |
| goodsList |
是 |
array |
商品列表 |
| sku |
是 |
String |
商品sku |
| internalId |
否 |
String |
商品internalId |
| qty |
是 |
number |
商品数量 |
返回参数说明
| 名称 |
类型 |
描述 |
| errorCode |
number |
返回代码 |
| msg |
String |
返回信息 |
| data |
array |
返回数据 |
| successList |
array |
成功列表 |
| failureList |
array |
失败列表 |
请求参数示例
{
"cancelList": [
{
"orderSn": "162724553352511111",
"status": 10,
"message": "品牌方缺货取消",
"goodsList": [
{
"sku": "3840438387414",
"internalId": "11122211221",
"qty": 1
}
]
}
]
}
返回示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": {
"successList": [
"162724553352511111"
],
"failureList": []
}
}
7.4. 订单取消确认
接口说明
请求地址
https://api.nengmao.net/api/order/cancelConfirm【生产环境】
https://sandbox.nengmao.net/api/order/cancelConfirm【沙箱环境】
请求方式 :
POST
公共参数
| 名称 |
是否必须 |
类型 |
描述 |
| appKey |
是 |
String |
api访问key |
| appSecret |
是 |
String |
api访问secret |
| timestamp |
是 |
String |
当前时间戳 |
| sign |
是 |
String |
签名 |
| format |
是 |
String |
示例:json |
请求参数(以下参数不可同时为空)
| 名称 |
是否必须 |
类型 |
描述 |
| cancelList |
是 |
array |
取消订单集合 |
| orderSn |
是 |
String |
tmall平台订单号 |
| status |
否 |
number |
订单取消状态(取消成功:10,取消失败:20) |
| message |
否 |
String |
备注 |
返回参数说明
| 名称 |
类型 |
描述 |
| errorCode |
number |
返回代码 |
| msg |
String |
返回信息 |
| data |
array |
返回数据 |
| successList |
array |
成功列表 |
| failureList |
array |
失败列表 |
请求参数示例
{
"cancelList": [{
"orderSn": "472396610503512365",
"status": "10",
"message": "取消成功"
},{
"orderSn": "396526610503512365",
"status": "20",
"message": "取消失败"
}]
}
返回示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": {
"successList": [
"472396610503512365",
"396526610503512365"
],
"failureList": []
}
}
7.5. 订单发货
接口说明
请求地址
https://api.nengmao.net/api/order/ship【生产环境】
https://sandbox.nengmao.net/api/order/ship【沙箱环境】
请求方式 :
POST
公共参数
| 名称 |
是否必须 |
类型 |
描述 |
| appKey |
是 |
String |
api访问key |
| appSecret |
是 |
String |
api访问secret |
| timestamp |
是 |
String |
当前时间戳 |
| sign |
是 |
String |
签名 |
| format |
是 |
String |
示例:json |
请求参数(以下参数不可同时为空)
| 名称 |
是否必须 |
类型 |
描述 |
| shipOrderList |
是 |
array |
订单发货集合 |
| orderSn |
是 |
String |
tmall平台订单号 |
| shipTime |
是 |
String |
订单的发货时间 |
| expressCompany |
否 |
String |
快递公司 |
| expressNo |
否 |
String |
快递单号 |
| invoiceNumber |
否 |
String |
发票单号 |
| shipmentId |
否 |
String |
系统里的物流单号 |
| serialNumber |
否 |
String |
序列号 |
| shippingOption |
否 |
String |
运送选项 |
| goodsList |
是 |
array |
商品列表 |
| sku |
是 |
String |
商品sku |
| qty |
是 |
number |
商品数量 |
| status |
否 |
String |
发货回传状态 |
| notes |
否 |
String |
发货备注 |
返回参数说明
| 名称 |
类型 |
描述 |
| errorCode |
number |
返回代码 |
| msg |
String |
返回信息 |
| data |
array |
返回数据 |
| successList |
array |
成功列表 |
| failureList |
array |
失败列表 |
请求参数示例
{
"shipOrderList": [{
"orderSn": "811010000207",
"shipTime": "2018-11-01 12:53:58",
"expressCompany": "bskd",
"expressNo": "51241003103688",
"invoiceNumber":"1111",
"shipmentId": "51241003103799",
"serialNumber": "47173580",
"shippingOption": "Cainiao",
"goodsList": [{
"sku": "5221414_580_50",
"qty": 1,
"status": "shipped",
"notes": "分开发货"
}]
}]
}
返回示例
{
"errorCode": 200,
"msg": "operate successful(操作成功)",
"data": {
"successList": [
"162724553352511111"
],
"failureList": []
}
}
8. 退货API
8.1. 退货列表
接口说明
请求地址
https://api.nengmao.net/api/return/list【生产环境】
https://sandbox.nengmao.net/api/return/list【沙箱环境】
请求方式 :
POST
公共参数
| 名称 |
是否必须 |
类型 |
描述 |
| appKey |
是 |
String |
api访问key |
| appSecret |
是 |
String |
api访问secret |
| timestamp |
是 |
String |
当前时间戳 |
| sign |
是 |
String |
签名 |
| format |
是 |
String |
示例:json |
请求参数(以下参数不可同时为空)
| 名称 |
是否必须 |
类型 |
描述 |
| startCreateTime |
是 |
String |
退单创建时间开始(格式:yyyy-MM-dd HH:mm:ss) |
| endCreateTime |
是 |
String |
退单创建时间结束(格式:yyyy-MM-dd HH:mm:ss) |
| returnStatus |
是 |
number |
退单状态 默认1,(已审核) |
| returnType |
否 |
number |
退单类型 Y新退单 N旧退单 默认Y |
| pageNo |
否 |
number |
页码 默认1 |
| pageSize |
否 |
number |
每页条数 默认10条,最大100条 |
返回参数说明
| 名称 |
类型 |
描述 |
| errorCode |
number |
错误代码 |
| msg |
string |
信息提示 |
| data |
array |
返回数据 |
| total |
number |
总记录数 |
| returnList |
array |
退货列表 |
| returnSn |
string |
能猫OMS退货单号 |
| 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 |
系统订单号 |
| orderOriginSn |
string |
平台原始单号 |
| goodsList |
array |
退货商品列表 |
| sku |
string |
商品SKU |
| upcCode |
string |
商品69码 |
| internalId |
string |
商品内部ID |
| goodsAmount |
number |
商品总金额 |
| qty |
number |
退货商品数量 |
请求参数示例
{
"startCreateTime": "2018-04-10 16:23:47",
"endCreateTime": "2018-04-15 16:23:47",
"returnStatus": 1,
"returnStatus": Y,
"pageNo": 1,
"pageSize": 10
}
返回示例
{
"errorCode": 200,
"msg": "",
"total": 1,
"data": [
{
"returnSn": "182010102121",
"returnAccount": "abc123",
"returnAmount": 100,
"returnShippingFee": 20,
"returnee": "abc123",
"province": "上海",
"city": "上海",
"district": "黄浦区",
"zipcode": "200000",
"address": "aaaa",
"expressCompay": "sf",
"expressSn": "1212121",
"telephone": "",
"mobile": "137*******2",
"orderSn": "1223123",
"orderOriginSn": "1112231223",
"remark": "test",
"goodsList": [
{
"sku": "1122123",
"upcCode": "6911212312",
"goodsAmount": 100,
"qty": 1,
"receiveStatus": 0
}
]
}
]
}