API version：v1.2.

ZoodMall Local Merchant API

V1.2.0（2020-11-02）
 API version：v1.2.0

CONTENTS
ZoodMall Local Merchant API .......................................................................................................... 1
1 Calls Specification ........................................................................................................................ 3
1.1 Request URL ........................................................................................................................ 3
1.2 HTTP Request Method ................................................................................................... 4
1.3 Request Description ........................................................................................................ 4

2 Add Products, Update Products(Same API will work) ............................................ 7

2.1 NAME: LocalProductRpc.create ................................................................................. 7

2.2 Request Parameter .......................................................................................................... 7
2.3 Return Parameters ........................................................................................................ 10
2.4 Descr .................................................................................................................................... 10
2.4.1 categoryId ..................................................................................................................... 11
3 Retrieve Product ........................................................................................................................ 13
3.1 NAME: LocalProductRpc.finds ................................................................................ 13
3.2 Request Parameter ....................................................................................................... 13
3.3 Return Parameters ........................................................................................................ 14
4 Retrieve Orders .......................................................................................................................... 16
4.1 NAME: OrderRpc.finds ................................................................................................ 16
4.2 Request Parameter ....................................................................................................... 16
4.3 Return Parameters ........................................................................................................ 17
5 Retrieve Shipping Label ......................................................................................................... 22
5.1 NAME: ParcelLabelRpc.get ........................................................................................ 22
5.2 Request Parameter ....................................................................................................... 22
6 Update Product information ................................................................................................ 24
6.1 NAME: ProductRpc. change ...................................................................................... 24
6.2 Return Parameters ........................................................................................................ 25
7 Add new variations................................................................................................................... 25
7.1 NAME: ProductRpc. addSku ..................................................................................... 25
7.2 Request Parameter ....................................................................................................... 25
2
 API version：v1.1.0

7.3 Return Parameters ........................................................................................................ 26

8 Update variations Property Value ..................................................................................... 26
8.1 NAME: ProductRpc. changeSku .............................................................................. 26
8.2 Request Parameter ....................................................................................................... 26
8.3 Return Parameters ........................................................................................................ 26
9 Stop sales of SKU/variations ................................................................................................ 27
9.1 NAME: ProductRpc.changeSaleStatus ................................................................. 27
9.2 Request Parameter ....................................................................................................... 27
9.3 Return Parameters ........................................................................................................ 27
9.4 Return Parameters ........................................................................................................ 27
10 Check Products verification information ....................................................................... 27
10.1 NAME: ProductRpc. checkAuditStatus............................................................ 27
10.2 Request Parameter ................................................................................................... 27
10.3 Return Parameters ................................................................................................... 28
11 Cancel tracknumber in order............................................................................................... 28
11.1 NAME: DeleteParcelRpc.cancelParcel ............................................................. 28
11.2 Request Parameter ................................................................................................... 28
11.3 Return Parameters ................................................................................................... 29
12 Error Codes .................................................................................................................................. 29

1 Calls Specification
1.1 Request URL
Production environment：https://open.zoodmall.com/rpc.php

Test environment：https://staging-main-open.zoodmall.com/rpc.php

Sign up for test account:

https://staging-main-merchant.zoodmall.com/index.php?m=main&a=register
Contact ZoodMall manager to enable your test account
3
 API version：v1.2.0

Set default shipping fee and default delivery time in back office for each market
before uploading products

1.2 HTTP Request Method

JSON-RPC 2.0
http://www.jsonrpc.org/specification

1.3 Request Description

A. Request Format
{
"jsonrpc":"JSON-RPC protocol version，must be 2.0",

"method":"the name of method",

"params":"parameters of method",
"id":" identification of client (string which is defined by merchant)"
}

B. Request Header Parameter

{
"Content-Type":"application/json",
"X-RPC-Auth-Username":" seller ID ",
"X-Rpc-Auth-Password":"seller’s secret key (which can be found in seller’s
backoffice)",
}

Request parameters X-RPC-Auth-Username and X-RPC-Auth-Password is required to

post Request Header.

C. Response Parameter
4
 API version：v1.1.0

"jsonrpc":" JSON-RPC protocol version，must be 2.0",

"id":" identification of client (string which is defined by merchant)",

"result":"",
"error":""
}

D. Parameters Description
Find instructions for PHP and Python below:
https://github.com/subutux/json-rpc2php/

E .example of getting the parameters of order

curl -i \
-H "Content-Type: application/json" \
-H "X-Rpc-Auth-Username: 44" \
-H "X-Rpc-Auth-Password: a4340ef576cf7021797e332f3eb33839" \
-X POST \
-d '{
"jsonrpc":"2.0",
"method":"ProductRpc.finds",
"params":[
{
"sku":"595b65d03629be7063bcf047"
}
],
"id":"7SItvCfdXnWWiQzF"
}' \
https://open.zoodmall.com/rpc.php

Response：

HTTP/1.1 200 OK
Date: Wed, 17 Jan 2018 10:20:09 GMT
Server: Apache
X-Powered-By: PHP/5.4.35
Set-Cookie: PHPSESSID=87lu9nt6ui9rpftmh2qccj8mt3; path=/
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0

5
 API version：v1.2.0

Pragma: no-cache
x-RPC-Auth-Session: 87lu9nt6ui9rpftmh2qccj8mt3
Content-Length: 1974
Content-Type: application/json

{"jsonrpc":"2.0","id":"7SItvCfdXnWWiQzF","result":{"products":[],"pagination":{"
page":1,"rowsPerPage":10,"totalCount":"0"}}

6
 API version：v1.1.0

2 AddProducts, Update Products(Same API will

work)

2.1 NAME: LocalProductRpc.create

2.2 Request Parameter

[
[{
"spu": "product SKU(SPU if these are products with variations) [string(200)",
"name": "product name[string(200)]",
"defaultPrice": "product Price[double(10,2)]",
"picture": [
"image url 1[string(400)]",
...
"image url x[string(400)]"
],
"categoryId": category ID of product (refer to 2.4.1 categoryId)[int(10)],
"property": [
{
"sku": ":"SKU of variation product [string(200)]",
"color":"value of variation property(e.g. black)[string(200)]",
"size": "value of variation property(e.g. XL)[string(200)]",
"propertyImage": "one image url of variation product [string(1000)]",
"price": "the price of variation product [dobule(10,2)]",
"crossedPrice":"VariantMSRP(Manufacturer Suggested Retail
Price)[double(10,2)]"
"quantity": available quantity of SKU
}
],
7
 API version：v1.2.0

"sproperty":[
{
"name":" specification name of product[string(50)]",
"value":" specification value of product[string(50)]"
},
...
{
"name":" specification name of product[string(50)]",
"value":" specification value of product[string(50)]"
}
],
"brand": "Brand Name[string(200)]",
"shippingFee": "shipping cost to local market[dobule (10,2)]",
"description": "description of product[string(4000)]",
"productHeight": "package heighth (mm)[int(10)]",
"productLength": "package length (mm) [int(10)]",
"productWidth": "package width (mm) [int(10)]",
"productWeight": "package weight(g)[dobule(12,4)]",
"tags": "product tags (separated by ||) [string(200)]",
"crossedPrice": "MSRP(Manufacturer Suggested Retail Price)[double(10,2)]",
"sizeGuideUrl":"picture of size guide [string(1000)]"
}
]]
Requestmaximum (Add, update)10 products each time.

Example:
[
[{
"spu": "290301_01",
"name": "29March",
8
 API version：v1.1.0

"defaultPrice": "25.00",
"picture": [
"http://res.cloudinary.com/demo/basketball_shot.jpg"
],
"categoryId":"561,abc,123",
"property": [
{
"sku": "270301__02_1",
"size": "M_S",
"color":"&Pink#Blue#White",
"price": "12.00",
"crossedPrice":"30.00",
"quantity":1
},
{
"sku": "270301__02_2",
"size": "S_L",
"color":"&Pink#Blue#White",
"price": "21.00",
"crossedPrice":"30.00",
"quantity":1
}
],
"sproperty": [
{
"name": "TYPE",
"value": "IMPRINT"
}
],
"brand": "Vintage Adidas",
9
 API version：v1.2.0

"shippingFee": "15.00",
"description": "Description_Text",
"productHeight": "5.7",
"productLength": "5.7",
"productWidth": "32",
"productWeight": "56",
"tags": "Tank||Oil Cup||Clutch Tank||Fluid Cup||Motorcycle Accessories||Oil Fluid Cu
p||Repair Tool||Gadget||Motorcycle Clutch||Unoversal",
"crossedPrice": "30.00",
"sizeGuideUrl":"https://cdn.shopify.com/s/files/1/1380/3157/files/168293_origin
al_1-2_2048x2048.png"
}
]]

2.3 Return Parameters

[
{
"sku":" product SKU(SPU if these are products with variations) [string(200)]",
"productId":"product ID[int(10)]"
},
...
]

2.4 Descr
If the SKU already exists in ZoodMall database,the product will be updated.
If the SKU does not exist, the product will be added.

10
 API version：v1.1.0

2.4.1 categoryId
CategoryId Category
1 Women’s Clothing
2 Men’s Clothing
3 Phones & Accessories
4 Computer & Office
5 Consumer Electronics
6 Jewelry & Accessories
7 Home & Garden
8 Luggage & Bags
9 Toys & Hobbies
10 Sports & Entertainment
11 Beauty & Health
12 Automobiles & Motorcycles
13 Home Improvement
14 Food
15 Handicraft
2028 Hair Extensions & Wigs
2337 Furniture
2383 Education & Office Supplies
3091 Weddings & Events
3214 Security & Protection
3266 Home Appliances
3467 Watches
3664 Shoes
4006 Mother & Kids
4148 Apparel Accessories
4247 Electronic Components & Supplies
4417 Lights & Lighting

11
 API version：v1.2.0

CategoryId Category
4523 Novelty & Special Use
4562 Tools
4709 Underwear & Sleepwears

Attention: Above table only lists main categories, products category should be
based on the specific category list that we provide, not above table.
The correct category list can be found in the import products template, which can
be downloaded at the Seller Back Office.
To define the category of products, please make sure that the category is the
deepest category of this product. For example, MP3 Player’s category ID should be
1035 (sub2 subcategory-MP3&MP4 Player), it should Not be 1034 (subcategory-
Portable Audio & Video) or 5 (category-Consumer Electronics).

2.4.2 marketCodes
marketCodes Country
KZ Kazakhstan
LB Lebanon
IR Iran
AF Afghanistan
AZ Azerbaijan
UZ Uzbekistan
TR Turkey
IQ Iraq
KW Kuwait
JO Jordan
KSA Kingdom of Saudi Arabia

These products can be added only if default logistics information (default

shipping cost, default delivery time) has been configurated successfully in back
12
 API version：v1.1.0

office.

If shipping cost is not uploaded, the default shipping cost will take effect for these
products.

3 RetrieveProduct
3.1 NAME:LocalProductRpc.finds

3.2 Request Parameter

A. get product by product ID [
{
"productId":"product ID[int(10)]"
}]
B. get multiple products by product IDs[
{
"productIds":"product ID1, product ID2, ...product IDn [string(200)]"
}]
C. get product by SPU[
{
"spu":"product SPU[stirng(200)]",
}]
D. get products by conditions/filters[
{
"status":"sales status(1:avalible 2:disabled)",
"categoryId":" category of product(refer to 2.4.1 categoryId ) ",
"nameSearch":"keywords of product name ",
"defaultPriceFrom":"minimumPrice(>=)",

"defaultPriceTo":"maximumPrice(<=)",
13
 API version：v1.2.0

"page":"page parameter,pagenumber[int(10)]"，

"rowsPerPage":"pageparameter,quantity of results per page(max 20 products)

[int(10)]"
}]

3.3 Return Parameters

{
"products":[
{
"productId":"product ID",
"sku":"product SKU or SPU [string(200)]",
"name":"product name[string(200)]",
"defaultPrice":"product price[dobule (10,2)]",
"picture":[
"image url 1[string(400)]",
...
"image url x[string(400)]"
],
"categoryId":" category ID of product(refer to 2.4.1 categoryId) [int(10)]",
"propertyName":"name of variation property(separated by ||)
[string(200)]"
"property":[
{
"sku":" SKU of product property[string(200)]",
"propertyValue":"value of variation property (if has 2 varoations,
separated by ||, eg Red||XL) [string(200)]",
"propertyImage":" image url of variation product[string(1000)]",
"price":" the price of variation product[dobule (10,2)]"
},

14
 API version：v1.1.0

...
{
"sku":" SKU of product property [string(200)]",
"propertyValue":"value of variationproperty(if has 2 varoations,
separated by ||, eg Red||XL) [string(200)]",
"propertyImage":"property of image [string(1000)]",
"price":" the price of variation product [dobule (10,2)]"
}
],
"sproperty":[
{
"name":" name of specification [string(50)]",
"value":" value of specification [string(50)]"
},
...
{
"name":" name of specification [string(50)]",
"value":" value of specification [string(50)]"
}
],

"skuType":"SKU type(1 product without variations 2 product with

variations)[int(3)]"
"marketCodes":" codes of market(refer to 2.4.2 marketCodes)
[string(10)]" ,
"shippingFee_xx":" shipping cost to local market(XX means the country
code of the local market , eg shippingFee_KZ) [dobule (10,2)]",
"description":" description of product [string(4000)]"
"declaredValue":"product value declared to Customs[dobule(10,2)]",
"hsCode":"HS code[string(50)]",
"productHeight":"package heighth (mm)[int(10)]",

15
 API version：v1.2.0

"productLength":"package length (mm) [int(10)]",

"productWidth":"package width (mm) [int(10)]",
"productWeight":"package weight(g)[dobule(12,4)]",
"tags":"product tags (separated by ||) [string(200)]",
"crossedPrice":"MSRP(Manufacturer Suggested Retail
Price)[dobule(10,2)]",
"sizeGuideUrl":"picture of size guide [string(1000)]",
"hasBattery":"1=battery inside;2=no battery)[int(3)]",
"hasPowder":"1=powder; 2=not powder [int(3)]",
"hasLiquid":"1=liquid included; 2=no liquid[int(3)]"
}
...
],
"pagination":{
"page":" current page[int(10)]",
"rowsPerPage":"results per page[int(10)]",
"totalCount":"total quantityof results[int(10)]"
}
}
}

4 Retrieve Orders
4.1 NAME: OrderRpc.finds

4.2 Request Parameter

A. search by multi conditions
[{

16
 API version：v1.1.0

"timePaidGeq":"date of order paid from", // e.g. 2018-09-10

"timePaidLeq":"date of order paid to", // e.g. 2018-09-21
"dateCancelGeq":"date of order cancelled from", // e.g. 2019-08-31,
"dateCancelLeq":"date of order cancelledto", // e.g. 2019-09-10,
Recommendusing date of payment to download information of new orders

"status":"order status(2:paid, 3:shipped)[int(3)]",

"hasPicking":"status of picking orders[int(3)]" [1. In preparation; 2 new orders
which are paid but waiting to be processed]
"processOrder":1 // 1: change order status into “In preparatin”
Pleasechange order status into “In preparation” as soon as you download
new orders successfully

"page":"page parameter, page number[int(10)]"，

"rowsPerPage":" page parameter, results per page (max 20 results) [int(10)]"

}
data format of dateCodeGeq and dateCodeLeq, e.g.,20170101

B. search by order ID of ZoodMall

{
"code":" order ID [string(30)]"
}
C. search by order IDs
{
"codes":" order ID1, order ID2, ..., order IDx [string(300)]"
}

4.3 Return Parameters

{
"orders":[{
17
 API version：v1.2.0

"code":" order ID of ZoodMall [string(30)]",

"status":"order status (1: unpaid; 2: paid 3 shipped 5 completed 9 canceled)
[int(3)]",
"customerName":"customer name [string]",
"timeCreated":" order creation time [datetime]",
"timeCreatedUnix": "order creation time[stamp] ",
"goodsAmount":"total amount of items[double(10,2)](Euro)",
"actualAmount":"total amount of orders[double(10,2)] (Euro)",
"shippingAmount":" Total Shippcost [double(10,2)](Euro)",
"orderAmount":"amount customer paid[double(10,2)](Euro)",
"hasRefund":"refunded or not?(1:Yes; 2.No),
"refundStatus":3,(1:is refunding; 2: Has refunded; 3: no refund)
"refundAmount":"Total Refund amount[double(10,2)](Euro)",
"canShipping": "ready to ship?(1: Yes; 2: No)",
"currencyCode":"Euro symbol [string(10)]",
"customerCurrencyCode":"symbol of local currency that customer paid
[string(10)]",
"currencyRate":" exchange rate when order is placed[number(12,6)] ",
"timePaid":"time of payment[datetime]",
"timePaidUnix":"time of payment [timestamp]",
"timeRefund":"time of refund[datetime]",
"timeRefundUnix":"time of refund [timestamp]",
"timeAllShipped":"time of all items are shipped[datetime]",
"timeAllShippedUnix":"time of all items are shipped [timestamp]",
"declaredValue":"product value declared to Customs[double(10,2)]",
"hasBattery":"1=battery inside;2=no battery)[int(3)]",
"hasPowder":"1=powder; 2=not powder [int(3)]",
"hasLiquid":"1=liquid included; 2=no liquid[int(3)]"
"trackNumber":"Tracking Number[string(200)]",
"itemListQuantity":"item quantity [int(10)]",
"itemList":[
18
 API version：v1.1.0

"spu":"product SPU[string(200)]",

"sku":"product SKU[string(200)]",
"productName":"product name[string(200)]",
"quantity":" item quantity[int(10)]",
"price":" total amount of this variation[double(10,2)]",
"shippingPrice":" shippingfee of this product[double(10,2)]",
"productUrl":"product URL[string(400)]",
"productId":"product Id[string(10)]",
“declareValue”: product declare Value [double(10,2)],
“hsCode”: product hscode[string(10)],
"hasBattery":"1=battery inside;2=no battery)[int(3)]",
"hasPowder":"1=powder; 2=not powder [int(3)]",
"hasLiquid":"1=liquid included; 2=no liquid[int(3)]",
"productHeight":"package heighth (mm)[int(10)]",
"productLength":"package length (mm) [int(10)]",
"productWidth":"package width (mm) [int(10)]",
"productWeight":"package weight(g)[double(12,4)]",
“refundQuantity”: the quantity of refund item[int(10)],
"refundStatus":3(1:is refunding; 2: Has refunded; 3: no refund),
"trackList":[
"trackNumber":"tracking number [string(50)]",
"timeShipped":"time of shipping [datetime]",
"timeShippedUnix": 1571217322,
],
shippedQuantity: the quantity of shipped item[int(10)],
},
...
{
19
 API version：v1.2.0

"spu":"product SPU[string(200)]",

"sku":"product SKU[string(200)]",
"productName":"product name[string(200)]",
"quantity":" item quantity[int(10)]",
"price":" total amount of this variation[double(10,2)]",
"shippingPrice":" shippingfee of this product[double(10,2)]",
"productUrl":"product URL[string(400)]",
"productId":"product Id[string(10)]",
“declareValue”: product declare Value [double(10,2)],
“hsCode”: product hscode[string(10)],
"hasBattery":"1=battery inside;2=no battery)[int(3)]",
"hasPowder":"1=powder; 2=not powder [int(3)]",
"hasLiquid":"1=liquid included; 2=no liquid[int(3)]",
"productHeight":"package heighth (mm)[int(10)]",
"productLength":"package length (mm) [int(10)]",
"productWidth":"package width (mm) [int(10)]",
"productWeight":"package weight(g)[double(12,4)]",
“refundQuantity”: the quantity of refund item[int(10)],
"refundStatus":3(1:is refunding; 2: Has refunded; 3: no refund),
"trackList":[
"trackNumber":"tracking number [string(50)]",
"timeShipped":"time of shipping [datetime]",
"timeShippedUnix": 1571217322,
],
shippedQuantity: the quantity of shipped item[int(10)],
},
,
"address":{
"countryCode":"the code of recipient”s country[string(100)]"
"receiver":" recipient[string(200)]",
20
 API version：v1.1.0

"province":" province of recipient[string(100)]",

"firstName":" recipient first name[string(200)]",
"lastName":" recipient last name[string(200)]",
"province":"province of recipient [string(100)]",
"city":"city of recipient [string(100)]",
"state":"state of recipient [string(100)]",
"area":"area of recipient [string(100)]",
"street1":"recipient address1 [string(100)]",
"street2":" recipient address2 [string(100)]",
"street3":" recipient address3 [string(100)]",
"mobile":"mobile phone number of recipient [string(100)]",
"email":"email of recipient [string(200)]",
"zipcode":"zipcode of recipient[string(20)]"
},
"orderType": "cross-borderor local"[string(20)],
"customerInfo": {
"firstName":,recipient first name[string(200)]",
"lastName": recipient last name[string(200)]",
}
}],
"pagination":{
"page":"current page[int(10)]",
"rowsPerPage":"results per page[int(10)]",
"totalCount":"quantityof total results[int(10)]"
},
"error": None
}

21
 API version：v1.2.0

5 Retrieve Shipping Label

5.1 NAME: ParcelLabelRpc.get

5.2 Request Parameter

[{
"customerOrderNumber": "seller’s internal identifier"[string(50)],
"parcelWeightInGrams":weight in gram[int(10)]",
"recipientOrderNumber": "order ID of ZoodMall" [string(50)],//e.g.
Z1913300127220
"batteryType":0
"liquid":0
"powder":0
"items": [
{
"itemSku": "Product SKU in ZoodMall back office "[string(50)],
"itemName": "Short product name in English"[string(200)],
"itemNameLocalLang": "Short product name in local language "[string(200)],
"itemDescription": "product name"[string(300)],
"itemQty": quantity of product in this parcel[int(10)],
"itemTotalWeightInGrams": total weight of this product in the parcel in
gram[int(10)],
"itemHsCode":"HS code "[string(32)],//non mandatory

"itemBrand": "brand of product " [string(50)]//non mandatory

}
],
"handOverType": handover type, [int(10)]// 0, drop-shipping, 1 pick up
"senderContact" : //pick up address,keep blank for each field’s value below if
handoverType equals 0
22
 API version：v1.1.0

{
"contactName":"Seller_contact Name"[string(128)],
"contactPhone":"Contact phone Number"[string(255)],
"address":"Seller Address"[string(512)],
"zipcode":"Seller_Zipcode"[string(50)],
"city":"Seller_City"[string(32)],
"province":"Seller_Province"[string(32)],
"country":" country"[string(50)]

}
,
"returnAddress"://return address
{
"contactName":"Seller_Name"[string(128)],
"contactPhone":"contact phone number"[string(255)],
"address":"Seller_address"[string(512)],
"zipcode":"Seller_zipcode"[string(50)],
"city":"Seller_city"[string(32)],
"province":"Seller_province"[string(32)],
"country":"Seller_country"[string(50)]
}
,
"shippingProvider":0 [int(10)]//
}]
The tracking number will be saved with corresponding item in the ItemList.

23
 API version：v1.2.0

6 UpdateProductinformation
6.1 NAME: ProductRpc. change
update informationofMax 100 products each time. This is to update information of SPU
All fields are optional except productId

[{
"productId":"product ID [int(10)]",
"name":"product name [string(200)]",
"categoryId":"product category ID[int(10)]",
"description":"product description[string(4000)]",
"sproperty":[
{
"name":"specification name[string(50)]",
"value":" specification value[string(50)]"
},
...
{
"name":" specification name [string(50)]",
"value":"specification value [string(50)]"
}
],
"picture":[
"image url 1[string(400)]",
...
"image url x[string(400)]"
],

24
 API version：v1.1.0

"defaultPrice":"product Priceonly for single sku product[double(10,2)]",

"tags":"product tags (separated by ||) [string(200)]",
"crossedPrice":"MSRP(Manufacturer Suggested Retail Price)[double(10,2)]",
"onSale":"1= onsale; 2=stop sale [int(3)]"
},
...
]
update Max 100 products each time
Allfieldsarenotmandatoryexcept productid

6.2 Return Parameters

[
{
"spu":"product SPU[string(200)]",

"productId":"productID [int(10)]"
},
...
]

7 Addnew variations
7.1 NAME: ProductRpc. addSku

7.2 Request Parameter

[
{
"productId":"ProductID[int(10)]",
"sku":"productSKU[string(200)]",
"propertyValue":"value of variation property (size, color etc., separated by "||", e.g.
size||color ) [string(200)]",
"price":"Price of this SKU [double(10,2)]",
"propertyImage":"one image url of variation product [string(1000)] "
}
25
 API version：v1.2.0

7.3 Return Parameters

[
{
"sku":"product SKU[string(200)]",
"productId":"product ID [int(10)]"
}
]

8 Updatevariations PropertyValue
8.1 NAME: ProductRpc. changeSku

8.2 Request Parameter

[
{
"productId":"ProductID[int(10)]",
"sku":"productSKU[string(200)]",
"propertyValue":"value of variation property (color||size,eparated by "||", e.g.
Black||XL , M) [string(200)]",
"price":"Price of this SKU [double(10,2)]",
"propertyImage":"one image url of variation product [string(1000)] "
}
]

8.3 Return Parameters

[{
"sku":"product SKU[string(200)]",
"productId":"product ID [int(10)]"
}]

26
 API version：v1.1.0

9 Stop sales of SKU/variations

9.1 NAME: ProductRpc.changeSaleStatus

9.2 Request Parameter

[{
"productId":"productID[int(10)]",
“spu”:”Product SPU”,
"sku":"productSKU[string(200)]",
"onSale":"1= onsale; 2=stop sale [int(3)]"
}]

9.3 Return Parameters

[{
"sku":"product SKU[string(200)]",
"productId":"product ID [int(10)]"
}]

9.4 Return Parameters

[
{
"sku":"product SKU[string(200)]",
"productId":"product ID [int(10)]"
},
...
]

10 Check Products verificationinformation

10.1 NAME: ProductRpc. checkAuditStatus

10.2 Request Parameter

{
"productId ":"product ID[int(10)]",
"marketCode":"Market Code [string(10)]",

27
 API version：v1.2.0

"page":"page parameter, page number [int(10)]"，

"rowsPerPage":"page parameter, results per page (max 20 results) [int(10)]"

}

marketCodeis required, other fields are optional.

10.3 Return Parameters

[{
"marketCode":"Market Code[string(10)]",
"productId":"Product ID [int(10)]",

"auditStatus":"verification status：1 waiting for verification 2 approved 3 rejected

[int(3)]",
"timeAudit":"Audit time[date]",
"auditRemark":
[
{
"time":"Audit time[date]",
"timeStamp":"Audit Timestamp [time]",
"remark":"Audit Remarks[string(200)]"
}
...
]
}
...
]

11 Cancel tracknumber in order

11.1 NAME: DeleteParcelRpc.cancelParcel

11.2 Request Parameter

[{
28
 API version：v1.1.0

"trackNumbers": [
"RRB600019224GE",…,“UUH900262981GE"
]
}]
Only can cancel 10 tracking numers most.

11.3 Return Parameters

{
"status": "OK",
"message": "Please find details as below",
"result": [
{
"trackNumber": "RRB600019224GE",
"status": "success",
"msg": "Cancelled Successfully"
},…
{
"trackNumber": "UUH900262981GE ",
"status": "failed",
"msg": "This track number does not exist, please check"
}
]
}

12 Error Codes

29
 API version：v1.2.0

code reason

100001 post search conditions error

110001 post parameters error

110002 more than 10 products(SPUs) are submitted for each time

110003 seller’s shop error

110004 sku is missing

110005 name is missing

110006 defaultPrice is missng

110007 propertyName is missing

110008 shipFee is missing

110009 currency is missing

110010 description is missing

110011 picture must be array

110012 property must be array

110013 sproperty must be array

110014 each property must contain sku

110015 each property must contain propertyValue

110017 each property must contain price

110018 each sproperty must contain name

110019 each sproperty must contain value

110020 categoryId does not exist

30
 API version：v1.1.0

110021 skuType is not the same as set before

110022 Default logistic information has not been set in back office

120001 Productid is required

120002 sku is required

120003 propertyValue is required
120004 price is required
120005 Product does not exist
120006 This product cannot have variations
120007 Skualready exists
130001 productid is required
130002 Sku is required
130003 propertyValue is required
130004 price is required
130005 Product does not exist
130006 This product cannot have variations
130007 Property doesn’t exist
140001 Productid is required
140002 sku is required
140003 product doesn’t exist
140004 property cannot be deleted
140005 property doesn’t exist
140006 Last property cannot be deleted
150001 Wrong parameter
150002 Parameter exceeds 100
150003 Productid is required
150004 marketCodes is required
150005 product doesn’t exist
150006 Logistic information should be set in this market
31
 API version：v1.2.0

160001 Wrong parameter

160002 Parameter exceeds 100
160003 Productid is required
160004 marketCodesis required
160005 product doesn’t exist
160006 Product should be put in this market first
170001 Wrong parameter
170002 Parameter exceeds 100
170003 Productid is required
170004 product doesn’t exist
170005 Name is required
170006 nameLangmust be array
170007 descriptionLang must be array
170008 sproperty must be array
170009 Each spropertymust contain specification name
170010 Each spropertymust contain specification value
170011 spropertyLang must be array
170012 Picture must be array
180001 Productid is required
180002 marketCode is required
180003 The is product is not found in this market
200001 post search conditions error

200002 the order does not exist in order list

200003 exceptional order/items

200004 The item in this order is on refunding process

200005 Current order can not be shipped

32