1. Introduction

• Domain Name : sh-api.nengmao.net/tm
• Request Protocol: Support http/https
• Data Transferring Format: json
• Product Barcode: SKU

2. Currier Company Code

Currier Code	Company Name
sf	ShunFeng
ems	EMS
sto	ShenTong
yto	YuanTong
zto	ZhongTong
zjs	ZhaiJiSong
yunda	Yunda
cces	CCES
ttkdex	TianTian
dbl	DeBang
jd	JingDong

3. Request Parameter Signature

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. Respond Error Code

Error_Code	Type	Message
200	Correct	Request Successful
400	Client Exception	Parameter Exception
400+	Client Exception	Parameter Exception
500	Server Exception	System Exception
500+	Server Exception	System Exception

5. Sales

5.1. Order List

Description

• Order information and Product information

Request URL

https://sh-api.nengmao.net/tm/api/order/list【Production Environment】
https://sh-sandbox.nengmao.net/tm/api/order/list【Sandbox Environment】

Request Method : POST

Public Parameters

Parameter	Mandatory	Type	Description
appKey	Yes	string	API access key
appSecret	Yes	string	API access secret
timestamp	Yes	int	Time Stamp, 2mins variance
sign	Yes	string	Signature
format	No	string	Respond data format, Json as default

Parameters

Parameter	Mandatory	Type	Description
startModifyTime	No	string	Order modify start time
endModifyTime	No	string	Order modify end time
orderStatus	No	number	Order status 0:Created; 1:To be delivered; 2: Delivered; 3: Cancelled; Default=1
pageNo	No	number	Page number, default=1
pageSize	No	number	Order lines per page, default=10, Max=100

Request Parameter Example

{
    "startModifyTime": "2017-04-10",
    "endModifyTime": "2018-11-15",
    "orderStatus": 2,
    "pageNo": 1,
    "pageSize": 1
}

Return Example

{
    "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
}

Return Parameter Example

Parameter	Type	Description
orderSn	string	Magic Panda OMS order number
orderOriginSn	string	Tmall platform order number
orderAccount	string	Tmall account
orderAmount	number	Order total amount
shippingFee	number	Order shipping fee
discountSum	number	Order discount total amount
consignee	string	Order consignee
country	string	Consignee country
province	string	Consignee province
city	string	Consignee city
district	string	Consignee district
address	string	Consignee address
telephone	string	Consignee telephone
mobile	string	Consignee mobile
platform	string	Sale platform
paymentSn	string	Order pay number
paymentType	string	Order payment type
createTime	string	Create time
payTime	string	Payment time
modifyTime	string	Modification time
shippingStatus	string	Shipping status
remark	string	Order remarks
orderGoods	array	Order product list
sku	string	Product SKU
upcCode	string	Barcode
saleAmount	number	Product sale total amount
tagPrice	number	Product tag price
qty	number	Product sold quantity
total	number	Total record

5.2. Order Delivery

Description

• Order delivery (Single order)
• Support multiple orders

Request URL

https://sh-api.nengmao.net/tm/api/order/ship【Production Environment】
https://sh-sandbox.nengmao.net/tm/api/order/ship【Sandbox Environment】

Request Method : POST

Public Parameters

Parameter	Mandatory	Type	Description
appKey	Yes	string	API access key
appSecret	Yes	string	API access secret
timestamp	Yes	int	Time Stamp, 2mins variance
sign	Yes	string	Signature
format	No	string	Respond data format , default=json

Parameters

Parameter	Mandatory	Type	Description
shipOrderList	Yes	array	Order delivery list
orderSn	Yes	string	MP OMS Order number
shipTime	Yes	string	Order delivery time
expressCompany	Yes	string	Currier name
expressNo	Yes	string	Currier tracking number
goodsList	Yes	array	Delivered product list
sku	Yes	string	Product sku
serialNumber	No	string	serial Number
qty	Yes	string	Delivered product quantity

Request Parameter Example

{
  "shipOrderList": [{
      "orderSn": "811010000207",
      "shipTime": "2018-11-01 12:53:58",
      "expressCompany": "bskd",
      "expressNo": "51241003103688",
      "goodsList": [{
          "sku": "5221414_580_50",
          "serialNumber": "37890530_test",
          "qty": 1
      }]
  }]
}

Return Example

{
  "errorCode": 200,
  "msg": "操作成功",
  "data": {}
}

Return Parameter Description

Parameter	Type	Remarks
errorCode	number	Request Result, 200:Success; 400+:Client Exception; 500+:Server Exception
msg	string	Request return information
data	string	Response result data

5.3. Order Cancellation Confirmation

Description

• Order Cancellation Confirmation (Support multiple order cancellation)

Request URL

https://sh-api.nengmao.net/tm/api/order/cancel【Production Environment】
https://sh-sandbox.nengmao.net/tm/api/order/cancel【Sandbox Environment】

Request Method : POST

Public Parameters

Parameter	Mandatory	Type	Description
appKey	Yes	string	API access key
appSecret	Yes	string	API access secret
timestamp	Yes	int	Time Stamp, 2mins variance
sign	Yes	string	Signature
format	No	string	Respond data format , default=json

Parameters

Parameter	Mandatory	Type	Description
cancelList	Yes	array	Order cancellation list
orderSn	Yes	string	MP Order number
status	Yes	number	Cancellation Status. 10=success, 20=failed
message	Yes	string	Cancel reason

Request Parameter Example

{
  "cancelList": [{
      "orderSn": "80404121212",
      "status": 10,
      "message": "取消成功"
  },{
      "orderSn": "80404121213",
      "status": 20,
      "message": "取消失败"
  }]
}

Return Example

{
  "errorCode": 200,
  "msg": "操作成功",
  "data": {}
}

Return Parameter Description

Parameter	Type	Remarks
errorCode	number	Request Result, 200:Success; 400+:Client Exception; 500+:Server Exception
msg	string	Request return information
data	string	Response result data

6. Return

6.1. Return List

Description

• Return List (support multiple page search)

Request URL

https://sh-api.nengmao.net/tm/api/refund/list【Production Environment】
https://sh-sandbox.nengmao.net/tm/api/refund/list【Sandbox Environment】

Request Method : POST

Public Parameters

Parameter	Mandatory	Type	Description
appKey	Yes	string	API access key
appSecret	Yes	string	API access secret
timestamp	Yes	int	Time Stamp, 2mins variance
sign	Yes	string	Signature
format	No	string	Respond data format , default=json

Parameters

Parameter	Mandatory	Type	Description
startModifyTime	No	string	Return modify start time
endModifyTime	No	string	Return modify end time
returnStatus	No	int	Return status 0:Created; 1:To be delivered; 2: Delivered; 3: Cancelled
pageNo	No	int	Page number, default=1
pageSize	No	int	Lines per page, default=10, max=100

Request Parameter Example

{
    "startModifyTime": "2018-4-10",
    "endModifyTime": "2018-11-15",
    "returnStatus": 1,
    "pageNo": 1,
    "pageSize": 1
}

Return Example

{
    "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
}

Return Parameter Description

Parameter	Type	Description
errorCode	number	Request Result, 200:Success; 400+:Client Exception; 500+:Server Exception
msg	string	Request return information
data	array	Refund information list
returnSn	string	MP OMS return number
returnAccount	string	Return account number
returnAmount	number	Total return amount
returnShippingFee	number	Return delivery fee
returnee	string	Return customer name
province	string	Province
city	string	City
district	string	District
zipcode	string	Zip code
address	string	Address
expressCompany	string	Currier Company name
expressSn	string	Currier number
telephone	string	Telephone number
mobile	string	Mobile phone number
orderOriginSn	string	Original order number
orderSn	string	MP OMS order number
createTime	string	Refund create time
modifyTime	string	Refund modify time
goodsList	array	Return product list
sku	string	SKU
upcCode	string	Barcode
goodsAmount	number	Total product amount
qty	number	Return quantity
receiveStatus	number	Return product receive status
total	number	Return query total

6.2. Return Received

Description

• Return & receive
• Support multiple orders

Request URL

https://sh-api.nengmao.net/tm/api/refund/receipt【Production Environment】
https://sh-sandbox.nengmao.net/tm/api/refund/receipt【Sandbox Environment】

Request Method : POST

Public Parameters

Parameter	Mandatory	Type	Description
appKey	Yes	string	API access key
appSecret	Yes	string	API access secret
timestamp	Yes	int	Time Stamp, 2mins variance
sign	Yes	string	Signature
format	No	string	Respond data format, Json as default

Parameters

Parameter	Mandatory	Type	Description
receiptList	Yes	array	Return list
returnSn	Yes	string	MP return number
receiptTime	Yes	string	Return received time
goodsList	Yes	array	Return product list
sku	Yes	string	Return sku
upcCode	Yes	string	Return barcode
goodsStatus	Yes	string	Product status
serialNumber	No	string	serial Number
qty	Yes	string	Return product quantity

Request Parameter Example

{
  "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": "37890530_test",
        "goodsStatus": "良品",
        "qty": 1
    }]
  }]
}

Return Example

{
  "errorCode": 200,
  "msg": "操作成功",
  "data": {}
}

Return Parameter Description

Parameter	Type	Remarks
errorCode	number	Request Result, 200:Success; 400+:Client Exception; 500+:Server Exception
msg	string	Request return information
data	string	Response result data

6.3. Cancellation Confirmed

Description

• Cancellation confirmation (support multiple orders)

Request URL

https://sh-api.nengmao.net/tm/api/refund/cancel【Production Environment】
https://sh-sandbox.nengmao.net/tm/api/refund/cancel【Sandbox Environment】

Request Method : POST

Public Parameters

Parameter	Mandatory	Type	Description
appKey	Yes	string	API access key
appSecret	Yes	string	API access secret
timestamp	Yes	int	Time Stamp, 2mins variance
sign	Yes	string	Signature
format	No	string	Respond data format, Json as default

Parameters

Parameter	Mandatory	Type	Description
cancelList	Yes	array	Return cancellation list
returnSn	Yes	string	MP OMS return number
status	Yes	number	Cancell Status. 10=success, 20=failed
message	Yes	string	Cancel reason

Request Parameter Example

{
  "cancelList": [{
      "returnSn": "180404121212",
      "status": 10,
      "message": "取消成功"
  },{
      "returnSn": "180404121213",
      "status": 20,
      "message": "取消失败"
  }]
}

Return Example

{
  "errorCode": 200,
  "msg": "操作成功",
  "data": {}
}

Return Parameter Description

Parameter	Type	Remarks
errorCode	number	Request Result, 200:Success; 400+:Client Exception; 500+:Server Exception
msg	string	Request return information
data	string	Response result data

7. Product

7.1. Product Upload

Description

• Brand upload your Product List

Request URL

https://sh-api.nengmao.net/tm/api/goods/upload【Production Environment】
https://sh-sandbox.nengmao.net/tm/api/goods/upload【Sandbox Environment】

Request Method : POST

Public Parameters

Parameter	Mandatory	Type	Description
appKey	Yes	string	API access key
appSecret	Yes	string	API access secret
timestamp	Yes	int	Time Stamp, 2mins variance
sign	Yes	string	Signature
format	No	string	Respond data format, Json as default

Parameters

Parameter	Mandatory	MP Suggestion	Type	Description
goodsList	Yes	Yes	array	Product list
brand	Yes	Yes	string	Brand Name
brandImage	No	No	string	Brand image address
goodsSn	Yes	Yes	string	Product number
goodsTitle	Yes	Yes	string	Product title
goodsCategory	No	Yes	string	Product category
goodsSeason	No	No	string	Season
goodsSeries	No	No	string	Series
goodsYears	Yes	Yes	string	Years
weight	Yes	Depends	string	Weight
description	No	Yes	string	Product description
descriptionImage	No	No	string	Product description image address
sizeChart	No	Yes	string	Size Chart
material	Yes	Yes	string	Material
volume	No	No	string	Volume
characteristics	No	No	string	Product special info, separate sign=|
originCountry	No	Yes	array	Original country
careInfo	No	Yes	string	Care Info
shippingRestriction	No	Yes	string	Shipping Restriction
newArrivals	No	Yes	string	Indicate if it is new arrivals
update	No	Yes	string	Update info for existing items
priority	No	Yes	string	Priority to be online
remarks	No	Yes	string	Remarks
currency	No	Yes	string	Currency
targetActiveDate	No	No	string	Target activation date, yyyy-MM-dd
merchClass	No	No	string	Merchandize Class (class A, class B, etc)
additionalDescription	No	No	string	Additional description
vendorBrand	No	No	string	Brand of vendor
careFacet	No	No	string	Care facet
goodsStyleNo	No	No	string	Number of goods style
fitMeasurement	No	No	Array	Fit Measurement
tmallLocalNotes	No	No	string	CN Local Notes
SkuList array starts
skuList	Yes	Yes	array	Brand’s SKU family
color	No	Yes	string	Color
colorCode	No	No	string	Color Code
size	No	Yes	string	Size
sizeCode	No	No	string	Size Code
sku	Yes	Yes	string	Product SKU
upcCode	No	No	string	Barcode
marketPrice	No	No	number	Tag price
salePrice	Yes	Yes	number	Sales Price
colorImage	No	No	string	Color table
images	Yes	Yes	number	Product images, at least one image. Separate sign=|
stocks	No	No	number	Product inventory
shippingRestriction	No	No	string	Restriction of shipping
tmallNotes	No	No	string	Notes for tmall
ipStatus	No	No	string	ipStatus
tmallLocalNotes	No	No	string	tmall CN Local Notes
colorId	No	No	string	colorId + sizeId as reference point
sizeId	No	No	string	colorId + sizeId as reference point
Skulist array ends

Request Parameter Example

{
  "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",
      "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",
          "ipStatus": "test ipStatus"
      }]
  }]
}

Return Example

{
    "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"
        }]
    }]
}

Return Parameter Description

Parameter	Type	Remarks
errorCode	number	Request Result, 200:Success; 400+:Client Exception; 500+:Server Exception
msg	string	Request return information
data	array	Product information list
goodsSn	string	Product number
goodsTitle	string	Title
brand	string	Brand
brandImage	string	Brand image
goodsCategory	string	Category
goodsSeason	string	Season
goodsSeries	string	Series
goodsYears	string	Years
weight	string	Weight
description	string	Description
descriptionImage	string	Description image
material	string	Material
volume	string	Volume
characteristics	string	Characteristics
measure	array	Measure
sizeChart	string	Size chart
currency	string	Currency
originCountry	string	Origin country
careInfo	string	Care info
shippingRestriction	string	Shipping restriction
newArrivals	string	New arrivals
remarks	string	Remarks
targetActiveDate	string	Target active date
priority	string	Priority
merchClass	string	Merchandise class
createTime	string	Create time
modifyTime	string	Modify time
status	number	Product status
goodsList	array	Product list
goodsSn	string	Product number
color	string	Color
colorCode	string	Color code
size	string	Size
sizeCode	string	Size code
upcCode	string	Barcode
sku	string	SKU
marketPrice	number	Tag price
salePrice	number	Sales price
inventory	number	Total inventory
lockInventory	number	Lock inventory
status	number	Product status (0 in Stock; 1 on Sale)
images	string	Images
colorImage	string	Color image

7.2. Inventory Update

Description

• Full Inventory Update(2am daily)
• Incremental Inventory Update (Procurement Stock In & Out, Shared inventory update from offline store)
• Product SKU and/or Barcode
• Supports up to 1000 SKUs at a time

Request URL

https://sh-api.nengmao.net/tm/api/stocks/update【Production Environment】
https://sh-sandbox.nengmao.net/tm/api/stocks/update【Sandbox Environment】

Request Method : POST

Public Parameters

Parameter	Mandatory	Type	Description
appKey	Yes	string	API access key
appSecret	Yes	string	API access secret
timestamp	Yes	int	Time Stamp, 2mins variance
sign	Yes	string	Signature
format	No	string	Respond data format, Json as default

Request Parameters

Parameter	Mandatory	MP Suggestion	Type	Description
updateType	Yes	Yes	int	Inventory update Type, 0:Full; Type 1:Incremental
sku	No	Yes	string	Product SKU
upcCode	No	No	string	Barcode
stocks	Yes	No	int	Inventory
goodsSn	No	Yes	string	Product number

Request Parameter Example

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

Return Example

{
    "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"
    }]
}

Return Parameter Description

Parameter	Type	Description
errorCode	number	Request Result, 200:Success; 400+:Client Exception; 500+:Server Exception
msg	string	Request return information
data	array	Product information list
goodsSn	string	Product number
color	string	Color
size	string	Size
upcCode	string	Barcode
marketPrice	number	Tag price
salePrice	number	Sales price
inventory	number	Total inventory
lockInventory	number	Lock inventory
status	number	Product status (0 in Stock; 1 on Sale)
images	string	Images
colorImage	string	Color image

7.3. Price Update

Description

• Increment of commodity sales price update
• Supports up to 100 products at a time
• Product SKU and/or Barcode

Request URL

https://sh-api.nengmao.net/tm/api/price/update【Production Environment】
https://sh-sandbox.nengmao.net/tm/api/price/update【Sandbox Environment】

Request Method : POST

Public Parameters

Parameter	Mandatory	Type	Description
appKey	Yes	string	API access key
appSecret	Yes	string	API access secret
timestamp	Yes	number	Time Stamp, 2mins variance，Time zone：GMT+8
sign	Yes	string	Signature
format	No	string	Respond data format, Json as default

Parameters

Parameter	Mandatory	MP Suggestion	Type	Description
skuList	Yes	Yes	array	Product SKU list
sku	No	Yes	string	Product SKU
upcCode	No	No	string	Product International Code
salePrice	Yes	Yes	number	Product sale price
goodsSn	No	Yes	string	Product number

Request Parameter Example

{
    "skuList":[{
        "sku":"goata31869633",
        "salePrice":1900
    }]
}

Return Example

{
    "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"
    }]
}

Return Parameter Description

Parameter	Type	Remarks
errorCode	number	Request Result, 200:Success; 400+:Client Exception; 500+:Server Exception
msg	string	Request return information
data	array	Product information list
goodsSn	string	Product number
color	string	Color
size	string	Size
upcCode	string	Barcode
marketPrice	number	Tag price
salePrice	number	Sales price
inventory	number	Total inventory
lockInventory	number	Lock inventory
status	number	Product status (0 in Stock; 1 on Sale)
images	string	Images
colorImage	string	Color image

7.4. Product Query List

Description

• Query product status (online, price, inventory etc.)
• Supports up to 100 products at a time

Request URL

https://sh-api.nengmao.net/tm/api/goods/query【Production Environment】
https://sh-sandbox.nengmao.net/tm/api/goods/query【Sandbox Environment】

Request Method : POST

Public Parameters

Parameter	Mandatory	Type	Description
appKey	Yes	string	API access key
appSecret	Yes	string	API access secret
timestamp	Yes	number	Time Stamp, 2mins variance，Time zone：GMT+8
sign	Yes	string	Signature
format	No	string	Respond data format, Json as default

Parameters

Parameter	Mandatory	Type	Description
startModifyTime	No	string	goods modify start time
endModifyTime	No	string	goods modify end time
goodsStatus	No	number	goods status 0:in stock; 1:online, Default=null
goodSnList	No	array	goodSn string array; array length <=100
skuList	No	array	sku string array; array length <=100
pageNo	No	number	Page number, default=1
pageSize	No	number	Goods lines per page default=10, Max=100

Request Parameter Example

{
	"startModifyTime":"2018-01-04 16:23:47",
	"endModifyTime":"2018-10-24",
	"goodsStatus":0,
	"goodSnList":["121212","abc1111"],
	"skuList":["12345678","2345678"],
	"pageNo":1,
	"pageSize":1
}

Return Example

{
    "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",
            "tmallLocalNotes": "test tmallLocalNotes",
            "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"
                }
            ],
            "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": "",
                    "ipStatus": "test ipStatus",
                    "tmallLocalNotes": "tmallLocalNotes test",
                    "colorId": "colorId test",
                    "sizeId": "sizeId test"
                }
            ]
        }
    ],
    "total": 13
}

Return Parameter Description

Parameter	Type	Remarks
errorCode	number	Request Result, 200:Success; 400+:Client Exception; 500+:Server Exception
msg	string	Request return information
data	array	Product information list
goodsSn	string	Product number
goodsTitle	string	Title
brand	string	Brand
brandImage	string	Brand image
goodsCategory	string	Category
goodsSeason	string	Season
goodsSeries	string	Series
goodsYears	string	Years
weight	string	Weight
description	string	Description
descriptionImage	string	Description image
material	string	Material
volume	string	Volume
characteristics	string	Characteristics
measure	array	Measure
sizeChart	string	Size chart
currency	string	Currency
originCountry	string	Origin country
careInfo	string	Care info
shippingRestriction	string	Shipping restriction
newArrivals	string	New arrivals
remarks	string	Remarks
targetActiveDate	string	Target active date
priority	string	Priority
merchClass	string	Merchandise class
additionalDescription	string	Additional description
vendorBrand	string	Brand of vendor
careFacet	string	Care facet
goodsStyleNo	string	Number of goods style
fitMeasurement	Array	Fit Measurement
tmallLocalNotes	string	tmall CN Local Notes
createTime	string	Create time
modifyTime	string	Modify time
status	number	Product status
goodsList	array	Product list
goodsSn	string	Product number
color	string	Color
colorCode	string	Color code
size	string	Size
sizeCode	string	Size code
upcCode	string	Barcode
sku	string	SKU
marketPrice	number	Tag price
salePrice	number	Sales price
inventory	number	Total inventory
lockInventory	number	Lock inventory
status	number	Product status (0 in Stock; 1 on Sale)
images	string	Images
colorImage	string	Color image
video	string	video
tmallNotes	string	Restriction of shipping
shippingRestriction	string	Notes for tmall
tmallLocalNotes	string	tmall CN Local Notes
colorId	string	colorId + sizeId as reference point
sizeId	string	colorId + sizeId as reference point
total	number	Product list total number