External API document For MagicPanda Update Date: 2025-11-24

1. Introduction

  • Domain Name : api.nengmao.net
  • 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. Request example code

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

Error_Code Type Message
200 Correct Successful request
400 Client exception Request parameter exception
401 Client exception Request parameter timestamp is empty
402 Client exception Request parameter timestamp exceeds the maximum
403 Client exception Request parameter timestamp is non-numeric
404 Client exception Request parameter appKey or appSecret is empty
405 Client exception Request parameter appKey or appSecret does not exist
406 Client exception Request list parameter exceeds 1000
407 Client exception Request parameter sign does not match
408 Client exception Request sku or upcCode parameters include at least one of them
409 Client exception Request parameter sign is empty
410 Client exception Request sku does not exist
411 Client exception Request orderSn does not exist
412 Client exception Request returnSn does not exist
413 Client exception Request goodsList is empty
414 Client exception Request Json data format error
415 Client exception Request Json data format error
416 Client exception Request order quantity more than in stock
417 Client exception The order is exist
418 Client exception The orderGoods Can not be empty
419 Client exception The order has been shipped,it can not be shipped repeatedly
420 Client exception Request parameters goodssnlist and skulist cannot be used at the same time
421 Client exception(order/ship) orders in [successList] operate successful,but the SKU or quantity of [failureList] error
422 Client exception(order/ship) the SKU or quantity of the failureList error
423 Client exception(order/cancelConfirm) Orders in [successList] operate successful,the orderSn in the failureList confirm failed
424 Client exception(order/cancelConfirm) The current status of the requested order does not allow cancellation
500 Server Exception Server-side exception
500+ Server Exception Server-side exception

6. Commodity API

6.1. List of Goods

Description

  • Upload commodity PRD, create or modify commodity information

Request URL

https://api.nengmao.net/api/goods【Production Environment】
https://sandbox.nengmao.net/api/goods【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 String Current timestamp
sign Yes String Signature
format Yes String Example: JSON

Request Parameters(The following parameters cannot be empty at the same time)

Parameter Mandatory Type Description
goodsList Yes array List of Goods
(Note:The number of data should not exceed 100)
brand Yes String Brand name
brandImage No String Brand Picture Address
goodsSn Yes String product code
goodsTitle Yes String Commodity Title
goodsCategory No String Classification of commodities
goodsSeason No String Commodity Season
goodsSeries No String Commodity Series
goodsYears No String Commodity year
weight Yes String weight(Unit:kg)
description No String Character Description of Commodities
descriptionImage No String Product Description Picture Address
target No String Logistics mode
hscode No String The HS (Harmonized System) code
sizeChart No String Size table
material Yes String Texture of material
volume No String volume
measure No String size
characteristics No String Feature information, multi-feature information using-segmentation
currency No String Commodity currency
originCountry No String Origin
careInfo No String Matters needing attention
shippingRestriction No String Transport restrictions
newArrivals No String Is there a new paragraph
updateInfo No String Update content
remarks No String Remarks
targetActiveDate No String Target shelf time
merchClass No String Commodity grade
priority No String Priority on-line 1. Priority on-line
deliverySeperate No String split orders or not
dimensions No String dimensions
modelNotes No String modelNotes
additionalDescription No String Additional description
vendorBrand No String Brand of vendor
careFacet No String Care facet
goodsStyleNo No String Number of goods style
fitMeasurement No array Fit Measurement Info
tmallLocalNotes No String Tmall Local Notes
productID No String productID
skuList Yes array Commodity SKU List
color Yes String color
colorCode No String Color code
size Yes String Size
sizeCode No String Size code
sku Yes String Commodity SKU
upcCode No String International Code of Commodities
internalId No String Internal code
marketPrice Yes number market price
salePrice Yes number Selling price
importFee No number Taxation
colorImage No String Color map
images Yes String Main Map of Commodity, Multiple Pictures Used | Segmented
video No String Video url of Commodity, Multiple Video Used | Segmented
videoImage No String Product video thumbnail, Multiple Pictures Used | Segmented
isDiscount No String Is discount
stocks No number Stock
shippingRestriction No String Restriction of shipping
tmallNotes No String Notes for tmall
ipStatus No String ip status
safeValid No Boolean Is Safe Inventory Or Not
colorId No String Color ID
sizeId No String Size ID
tmallLocalNotes No String Tmall Local Notes

Return Parameter Description

Parameter Type Remarks
errorCode number Return code
msg String Return information
data array Order List
brand String Brand name
brandImage String Brand Picture Address
goodsSn String product code
goodsTitle String Commodity Title
goodsCategory String Classification of commodities
goodsSeason String Commodity Season
goodsSeries String Commodity Series
goodsYears String Commodity year
weight String weight(Unit:kg)
description String Character Description of Commodities
descriptionImage String Product Description Picture Address
target String Logistics mode
hscode String The HS (Harmonized System) code
sizeChart String Size table
material String Texture of material
volume String volume
characteristics String Feature information, multi-feature information using-segmentation
measure String size
originCountry String Origin
careInfo String Matters needing attention
shippingRestriction String Transport restrictions
newArrivals String Is there a new paragraph
updateInfo String Update content
priority String Priority on-line 1. Priority on-line
remarks String Remarks
currency String Commodity currency
targetActiveDate String Target shelf time
merchClass String Commodity grade
deliverySeperate String split orders or not
dimensions String dimensions
modelNotes String modelNotes
additionalDescription String Additional description
vendorBrand String Brand of vendor
careFacet String Care facet
goodsStyleNo String Number of goods style
fitMeasurement array Fit Measurement Info
tmallLocalNotes String Tmall Local Notes
productID String productID
skuList array Commodity SKU List
color String colour
colorCode String Color code
size String Size
sizeCode String Size code
sku String Commodity SKU
upcCode String International Code of Commodities
internalId String Internal code
marketPrice number market price
salePrice number Selling price
importFee number Taxation
colorImage String Color map
images String Main Map of Commodity, Multiple Pictures Used | Segmented
video String Video url of Commodity
videoImage String Product video thumbnail, Multiple Pictures Used | Segmented
isDiscount String Is discount
inventory number Inventory
lockInventory number Lock in stock
shippingRestriction String Restriction of shipping
tmallNotes String Notes for tmall
ipStatus String ip status
safeValid Boolean Is Safe Inventory Or Not
colorId String Color ID
sizeId String Size ID
tmallLocalNotes String Tmall Local Notes

Request Parameter Example

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

Return Example

{
    "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",
            "dimensions": "",
            "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": "",
            "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. Commodity Query List

Description:

  • Query merchandise data based on creation time

Request URL

https://api.nengmao.net/api/goods/list【Production Environment】
https://sandbox.nengmao.net/api/goods/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 String Current timestamp
sign Yes String Signature
format Yes String Example: JSON

Request Parameters(The following parameters cannot be empty at the same time)

Parameter Mandatory Type Description
startCreateTime No String Goods Creation Time Begins(format:yyyy-MM-dd HH:mm:ss)
endCreateTime No String Goods Creation Time Ends (format:yyyy-MM-dd HH:mm:ss)
startModifyTime No String Goods Modify Time Begins (format:yyyy-MM-dd HH:mm:ss)
endModifyTime No String Goods Modify Time Ends (format:yyyy-MM-dd HH:mm:ss)
goodSnList No array goodSn string array; array length <=100 (Note:goodSnList and skuList cannot be used at the same time)
skuList No array sku string array; array length <=100 (Note:goodSnList and skuList cannot be used at the same time)
pageNo No number Page number default 1
pageSize No number The default number of entries per page is 10, with a maximum of 100 entries.

Return Parameter Description

Parameter Type Remarks
errorCode number Return code
msg String Return information
data array Response result data
brand String Brand name
brandImage String Brand Picture Address
goodsSn String product code
goodsTitle String Commodity Title
goodsCategory String Classification of commodities
goodsSeason String Commodity Season
goodsSeries String Commodity Series
goodsYears String Commodity year
weight String weight(Unit:kg)
description String Character Description of Commodities
descriptionImage String Product Description Picture Address
target String Logistics mode
hscode String The HS (Harmonized System) code
sizeChart String Size table
material String Texture of material
volume String volume
characteristics String Feature information, multi-feature information using-segmentation
measure String size
originCountry String Origin
careInfo String Matters needing attention
shippingRestriction String Transport restrictions
newArrivals String Is there a new paragraph
updateInfo String Update content
priority String Priority on-line 1. Priority on-line
remarks String Remarks
currency String Commodity currency
targetActiveDate String Target shelf time
merchClass String Commodity grade
deliverySeperate String split orders or not
dimensions String dimensions
modelNotes String modelNotes
additionalDescription String Additional description
vendorBrand String Brand of vendor
careFacet String Care facet
goodsStyleNo String Number of goods style
fitMeasurement array Fit Measurement Info
tmallLocalNotes String Tmall Local Notes
productID String productID
skuList array Commodity SKU List
color String colour
colorCode String Color code
size String Size
sizeCode String Size code
sku String Commodity SKU
upcCode String International Code of Commodities
internalId String Internal code
marketPrice number market price
salePrice number Selling price
importFee number Taxation
colorImage String Color map
images String Color Map Commodity Main Map, Multiple Pictures Used | Segmented by
video String Video of Commodity
videoImage String Product video thumbnail, Multiple Pictures Used | Segmented
isDiscount String Is discount
inventory number Stock
lockInventory number Lock in stock
shippingRestriction String Restriction of shipping
tmallNotes String Notes for tmall
safeValid Boolean Is Safe Inventory Or Not
ipStatus String ip status
colorId String Color ID
sizeId String Size ID
tmallLocalNotes String Tmall Local Notes
total number Total number of records

Request Parameter Example

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

Return Example

{
    "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. Inventory Update

Description

  • Renewal of commodity stock

Request URL

https://api.nengmao.net/api/stocks/update【Production Environment】
https://sandbox.nengmao.net/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 String Current timestamp
sign Yes String autograph
format Yes String Example: JSON

Request Parameters(The following parameters cannot be empty at the same time)

Parameter Mandatory Type Description
updateType Yes number Inventory Update Type 0 Full Volume 1 Increment
skuList Yes array Commodity SKU list
(Note:The number of data should not exceed 2000)
sku Yes String Commodity SKU
upcCode No String Commodity upcCode
internalId No String Commodity internalId
stocks Yes number Commodity Inventory

Request Parameter Example

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

Return Example

{
    "errorCode": 200,
    "msg": "operate successful(操作成功)",
    "data": {}
}

6.4. Stocks Query List

Description:

  • Query Stocks data based on Modification time

Request URL

https://api.nengmao.net/api/stocks/list【Production Environment】
https://sandbox.nengmao.net/api/stocks/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 String Current timestamp
sign Yes String Signature
format Yes String Example: JSON

Request Parameters(The following parameters cannot be empty at the same time)

Parameter Mandatory Type Description
startModifyTime No String Stocks Modification Time Begins (Note:(format:yyyy-MM-dd HH:mm:ss) At least one of modification time and skulist is required)
endModifyTime No String Stocks Modification Time Ends (Note:(format:yyyy-MM-dd HH:mm:ss) At least one of modification time and skulist is required)
skuList No array sku string array; array length <=100 (Note:At least one of modification time and skulist is required)
pageNo No number Page number default 1
pageSize No number The default number of entries per page is 10, with a maximum of 100 entries.

Return Parameter Description

Parameter Type Remarks
errorCode number Return code
msg String Return information
data array Response result data
sku String SKU
stocks number stocks
lastModifyTime String last modification time
total number Total number of records

Request Parameter Example

{
    "startModifyTime":"2019-01-04 16:23:47",
    "endModifyTime":"2020-05-20 16:23:47",
    "skuList":["10009272","10333383","11634854","13037544"],
    "pageNo":1,
    "pageSize":100
}

Return Example

{
    "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. Price Update

Description

  • Update commodity prices

Request URL

https://api.nengmao.net/api/price/update【Production Environment】
https://sandbox.nengmao.net/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 String Current timestamp
sign Yes String Signature
format Yes String Example: JSON

Request Parameters(The following parameters cannot be empty at the same time)

Parameter Mandatory Type Description
skuList Yes array Commodity SKU list
(Note:The number of data should not exceed 2000)
sku Yes String Commodity SKU
upcCode No String Commodity upcCode
internalId No String Commodity internalId
salePrice Yes number Sale Price of Commodity
isDiscount No String Is discount

Request Parameter Example

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

Return Example

{
    "errorCode": 200,
    "msg": "operate successful(操作成功)",
    "data": {}
}

6.6. Price Query List

Description:

  • Query Price data based on Modification time

Request URL

https://api.nengmao.net/api/price/list【Production Environment】
https://sandbox.nengmao.net/api/price/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 String Current timestamp
sign Yes String Signature
format Yes String Example: JSON

Request Parameters(The following parameters cannot be empty at the same time)

Parameter Mandatory Type Description
startModifyTime No String Price Modification Time Begins (Note:(format:yyyy-MM-dd HH:mm:ss) At least one of modification time and skulist is required)
endModifyTime No String Price Modification Time Ends (Note:(format:yyyy-MM-dd HH:mm:ss) At least one of modification time and skulist is required)
skuList No array sku string array; array length <=100 (Note:At least one of modification time and skulist is required)
pageNo No number Page number default 1
pageSize No number The default number of entries per page is 10, with a maximum of 100 entries.

Return Parameter Description

Parameter Type Remarks
errorCode number Return code
msg String Return information
data array Response result data
sku String SKU
price number price
lastModifyTime String last modification time
total number Total number of records

Request Parameter Example

{
    "startModifyTime":"2020-01-04 16:23:47",
    "endModifyTime":"2020-03-15 16:23:47",
    "skuList":["32329221","89849829"],
    "pageNo":1,
    "pageSize":100
}

Return Example

{
    "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. Transaction API

7.1. Order List

Description

  • Query transaction data based on creation time state

Request URL

https://api.nengmao.net/api/order/list【Production Environment】
https://sandbox.nengmao.net/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 String Current timestamp
sign Yes String Signature
format Yes String Respond data format, Json as default

Request Parameters(The following parameters cannot be empty at the same time)

Parameter Mandatory Type Description
startCreateTime NO String Order creation time begins (format:yyyy-MM-dd HH:mm:ss)
endCreateTime NO string Order Creation Time Ends (format:yyyy-MM-dd HH:mm:ss)
startModifyTime No String Order Modify Time Begins (format:yyyy-MM-dd HH:mm:ss)
endModifyTime No String Order Modify Time Ends (format:yyyy-MM-dd HH:mm:ss)
orderStatus NO number Order status < br > 0: created; 1: awaiting delivery; < br > 2: delivered; 3: cancelled;
4: confirming cancellation; 5: part cancallation
6: ship whole order 7: ship part order
4: confirming cancellation; default 1: awaiting delivery
orderType NO String Order type Y:new order N:old order default:Y
pageNo NO number Page number default 1
pageSize NO number Number of pages, default 10, maximum 100

Return Parameter Description

Parameter Type Remarks
errorCode number Return code
msg String Request return information
data array Response result data
orderSn String System Order Number
orderAccount String Order Purchase Account
orderAmount number Total amount of the orders
shippingFee number Order Freight
discountAmountSum number Order discount price
consignee String Consignee
country String Consignee country
province String Consignee Province
city String Consignee City
district String Consignee area
address String Consignee address
zipcode String Postal Code
telephone String Phone
mobile String Receiver's mobile phone number
platform String Sales Platform
paymentSn String Payment order number
paymentType String Payment method("alipay" for Alipay payment, "wx" for WeChat Pay, and "others" for other payment methods.)
createTime String Creation time
payTime String Pay time
shippingStatus String Delivery status
status String Order status
lpCode String Logistics Waybill Number
lpUrl String Logistics Waybill Url
orderOriginSn String The original order number from the source system
remark String Remarks
invoiceNumber String invoice number
orderGoods array Order Collection
sku String Commodity SKU coding
upcCode String Commodity SKU Code Commodity 69 code
saleAmount number Value of single commodity (The value of a single product, excluding taxes , freight and coupons, etc., regardless of whether tax is free or not, taxfee is subtracted)
tagPrice number Commodity hanging price
internalId String Brand goods internal id
qty number Sales Quantity of Goods
subOrderTaxFee number Suborder tax(If multiple items are purchased for the same sku, the subOrderTaxFee is the sum of the taxes of the multiple items)
taxFree Boolean Whether to Include Tax
cid String Tmall Category ID
cname String Tmall Category Name:Service Rate
engraving String Customized information
total number Total number of records

Request Parameter Example

{
    "startCreateTime": "2020-03-26 16:23:47",
    "endCreateTime": "2020-03-27 16:23:47",
    "orderStatus": 1,
    "orderType": "Y",
    "pageNo": 1,
    "pageSize": 1
}

Return Example

{
    "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.Order confirm

Description

  • Order confirmation, return confirmation, confirm that the order or return receipt has been obtained. Support multiple orders

Request URL

https://api.nengmao.net/api/status/confirmation【Production Environment】
https://sandbox.nengmao.net/api/status/confirmation【Production Environment】

Request Method : POST

Public Parameters

Parameter Mandatory Type Description
appKey Yes String API access key
appSecret Yes String API access secret
timestamp Yes String Current timestamp
sign Yes String Signature
format Yes String Respond data format, Json as default

Request Parameters(The following parameters cannot be empty at the same time)

Parameter Mandatory Type Description
orderSnList NO array Order List (Note:orderSnList is required in order confirmation operation)
returnSnList NO array Return order list (Note:returnSnList is required in returnOrder confirmation operation)

Return Parameter Description

Parameter Type Description
errorCode number Return code
msg String Request return information
data array Product information list
orderResult object Order processing results
successList array Success List
failureList array Failure List
returnResult object Return Processing Result

Request Parameter Example

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

Return Example

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

7.3. Order cancel

Description

  • The merchant cancelled the order because of the shortage. Support multiple orders

Request URL

https://api.nengmao.net/api/order/cancelbybrand【Production Environment】
https://sandbox.nengmao.net/api/order/cancelbybrand【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 String Current timestamp
sign Yes String Signature
format Yes String Example: JSON

Request Parameters(The following parameters cannot be empty at the same time)

Parameter Mandatory Type Description
cancelList Yes array Order Cancellation Collection
orderSn Yes String Tmall Platform Order Number
status Yes number Cancellation 10: Success 20: Failure
message No String Causes for Cancellation of Result
goodsList Yes array List of Goods
sku Yes String Commodity SKU
internalId No String commodity internal Id
qty Yes number Quantity of commodities

Return Parameter Description

Parameter Type Remarks
errorCode number Return code
msg String Return information
data array Product information list
successList array Success List
failureList array Failure List

Request Parameter Example

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

Return Example

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

Public Parameters

Parameter Mandatory Type Description
appKey Yes String API access key
appSecret Yes String API access secret
timestamp Yes String Current timestamp
sign Yes String Signature
format Yes String Example: JSON

Request Parameters(The following parameters cannot be empty at the same time)

Parameter Mandatory Type Description
cancelList Yes array Order cancel list
orderSn Yes String tmall Order number
status No number Order cancellation status (Cancelled successfully:10,Cancelled failed:20)
message No String Remark

Return Parameter Description

Parameter Type Remarks
errorCode number Return code
msg String Return information
data array Product information list
successList array Success List
failureList array Failure List

Request Parameter Example

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

Return Example

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

7.5. Order Ship

Description

  • Order delivery ,Support multiple orders

Request URL

https://api.nengmao.net/api/order/ship【Production Environment】
https://sandbox.nengmao.net/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 String Current timestamp
sign Yes String Signature
format Yes String Example: JSON

Request Parameters(The following parameters cannot be empty at the same time)

Parameter Mandatory Type Description
shipOrderList Yes array Order delivery list
orderSn Yes String tmall Order number
shipTime Yes String Order delivery time
expressCompany No String Currier name
expressNo No String Currier tracking number
invoiceNumber No String invoice number
shipmentId No String Logistics order number in the system
serialNumber No String Serial Number
shippingOption No String Shipping Option
goodsList Yes array Delivered product list
sku Yes String Product sku
qty Yes number Delivered product quantity
status No String Shipment return status
notes No String Shipping remarks

Return Parameter Description

Parameter Type Remarks
errorCode number Return code
msg String Return information
data array Product information list
successList array Success List
failureList array Failure List

Request Parameter Example

{
  "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": "分开发货"
      }]
  }]
}

Return Example

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

8. Return API

8.1. Return List

Description

  • Query return data based on creation time

Request URL

https://api.nengmao.net/api/return/list【Production Environment】
https://sandbox.nengmao.net/api/return/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 String Current timestamp
sign Yes String Signature
format Yes String Example: JSON

Request Parameters(The following parameters cannot be empty at the same time)

Parameter Mandatory Type Description
startCreateTime Yes String Creation time of refund receipt begins (format:yyyy-MM-dd HH:mm:ss)
endCreateTime Yes String Return order creation time is over (format:yyyy-MM-dd HH:mm:ss)
returnStatus Yes number Refund status,default 1,(Approved)<
returnType No number Return type Y:new return N:old return ,default:Y
pageNo No number Page number default 1
pageSize No number The default number of entries per page is 10, with a maximum of 100 entries.

Return Parameter Description

Parameter Type Remarks
errorCode number Request Result, 200:Success; 400+:Client Exception; 500+:Server Exception
msg string Information Tips
data array Return data
total number Total number of records
returnList array Return List
returnSn string OMS Return Bill No. of Neomao
returnAccount string Return account
returnAmount number Total Return Amount
returnShippingFee number Return postage
returnee string Returner
province string Return Provinces
city string Return Cities
district string Return area
zipcode string Return Postal Code
address string Return address
expressCompany string Courier Services Company
expressSn string Courier number
telephone string Return calls
mobile string Return mobile phone number
orderSn string System Order Number
orderOriginSn string The original order number from the source system
goodsList array List of returned goods
sku string Commodity SKU
upcCode string Commodity 69 yards
internalId string Commodity internal ID
goodsAmount number Total amount of goods
qty number Quantity of returned goods

Request Parameter Example

{
    "startCreateTime": "2018-04-10 16:23:47",
    "endCreateTime": "2018-04-15 16:23:47",
    "returnStatus": 1,
    "returnType": Y,
    "pageNo": 1,
    "pageSize": 10
}

Return Example

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