ZoodMall Merchant API 2.0.16-En

API version：v2.0.
16
ZoodMall Merchant API

v2.0.16（2018-12-03）
API version：v2.0.16
CONTENTS
ZoodMall Merchant API.................................................................................................................... 1
1 Calls Specification ..................................................................................................................... 4
1.1 Request URL .................................................................................................................... 4
1.2 HTTP Request Method ................................................................................................ 4
1.3 Request Description ..................................................................................................... 4
2 Add Products，Update Products ....................................................................................... 6
2.1 NAME: ProductRpc.create ......................................................................................... 6
2.2 Request Parameter ....................................................................................................... 6
2.3 Return Parameters ........................................................................................................ 7
2.4 Descr ................................................................................................................................... 7
2.4.1 categoryId..................................................................................................................... 7
2.4.2 marketCodes ............................................................................................................... 8
3 Retrieve Product ........................................................................................................................ 9
3.1 NAME: ProductRpc.finds ............................................................................................ 9
3.2 Request Parameter ....................................................................................................... 9
3.3 Return Parameters ........................................................................................................ 9
4 Retrieve Orders ....................................................................................................................... 12
4.1 NAME: OrderRpc.finds ............................................................................................. 12
4.2 Request Parameter .................................................................................................... 12
4.3 Return Parameters ..................................................................................................... 12
5 Update Tracking Number of Order ................................................................................. 14
5.1 NAME: OrderRpc.updateTrackNumber ............................................................ 14
6 Update Product information ............................................................................................. 15
6.1 NAME: ProductRpc. change.................................................................................... 15
7 Add new variations ............................................................................................................... 17
7.1 NAME: ProductRpc. addSku ................................................................................... 17
8 Update variations Property Value ................................................................................... 17
8.1 NAME: ProductRpc. changeSku ............................................................................ 17
9 Stop sales of SKU/variations ............................................................................................. 18
9.1 NAME: ProductRpc.changeSaleStatus ............................................................... 18
10 Put Products to markets...................................................................................................... 18
10.1 NAME: ProductRpc. onShelves ......................................................................... 18
10.2 Request Parameter ................................................................................................ 18
10.3 Return Parameters ................................................................................................ 18
11 disable Products in one markets ..................................................................................... 19
2
11.1 NAME: ProductRpc. offShelves ......................................................................... 19
12 Check Products verification information ..................................................................... 19
12.1 NAME: ProductRpc. checkAuditStatus .......................................................... 19
13 Cancel items in order............................................................................................................ 20
13.1 NAME: cancelOrder ............................................................................................... 20
14 Error Codes ............................................................................................................................... 20
3
1 Calls Specification
1.1 Request URL
Production environment：https://open.zoodmall.com/rpc.php
Test environment：https://staging-in-open.zoodmall.com/rpc.php
Sign up for test account:

https://staging-in-merchant.zoodmall.com/index.php?m=main&a=register
Contact ZoodMall manager to enable your test account

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 find in seller’s back
office)",
}
Request parameters X-RPC-Auth-Username and X-RPC-Auth-Password is required to

post Request Header.
C. Response Parameter
{
"jsonrpc":" JSON-RPC protocol version，must be 2.0",
"id":" identification of client (string which is defined by merchant)",
4
"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
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"}}
5
2 Add Products，Update Products

2.1 NAME: ProductRpc.create
2.2 Request Parameter

[[{
"sku":"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)]",
"propertyName":" name of variation property (separated by ||) [string(200)]"
"property":[
{
"sku":"SKU of variation product [string(200)]",
"propertyValue":"value of variation property (size, color etc., separated
by ||, e.g. size||color )[string(200)]",
"propertyImage":" one image url of variation product [string(1000)]",
"price":"the price of variation product [double(10,2)]"
},
...
{
"sku":"SKU of variation product [string(200)]",
"propertyValue":"value of variation property (size, color etc., separated
by ||, e.g. size||color )[string(200)]",
"propertyImage":" one image url of variation product [string(1000)]",
"price":"the price of variation product [double(10,2)]"
}
],
"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)]"
}
],
6
"marketCodes":"codes of market (separated by”,”, refer to 2.4.2
marketCodes )[string(10)]" ,
"shippingFee_KZ":" shipping cost to Kazakhstan [double(10,2)]",
...
"shippingFee_LB":" shipping cost to Lebanon[double(10,2)]",
"description":" description of product[string(4000)]"
"declaredValue":"product value declared to Customs[double(10,2)]",
"hsCode":"HS code[string(50)]",
"productHeight":"package heighth (mm)[int(10)]",
"productLenght":"package length (mm) [int(10)]",
"productWidth":"package width (mm) [int(10)]",
"productWeight":"package weight(g)[double(12,4)]",
"tags":"product tags (separated by ||) [string(200)]",
"crossedPrice":"MSRP(Manufacturer Suggested Retail Price)[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)]"
},
...
]]
Request maximum (Add, update)10 products each time.
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.
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 & Watches
7
CategoryId Category
7 Home & Garden
8 Bags & Shoes
9 Toys, Kids & Baby
10 Sports & Outdoors
11 Health & Beauty
12 Automobiles & Motorcycles
13 Home Improvement
14 Food
15 Handicraft
2.4.2 marketCodes
marketCodes Country
KZ Kazakhstan
LB Lebanon
IR Iran
AF Afghanistan
AZ Azerbaijan
UZ Uzbekistan
TR Turkey
IQ Iraq
These products can be added only if default logistics information (default

shipping cost, default delivery time) has been configurated successfully in back
office.
If shipping cost is not uploaded, the default shipping cost will take effect for these
products.
8
3 Retrieve Product
3.1 NAME: ProductRpc.finds

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
[{
"sku":"product SPU[stirng(200)]",
}]
D. get multiple products by SPUs
[{
"skus":"product SPU1, product SPU2, ...product SPUn [string(40000)]"
}]
E. 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":"minimum Price(>=)",
"defaultPriceTo":" maximum Price(<=)",
"page":"page parameter, page number[int(10)]"，
"rowsPerPage":"page parameter, quantity of results per page (max 20 products)
[int(10)]"
}]

{
"products":[
{
"productId":"product ID",
"sku":"product SKU or SPU [string (200)]",
"name":"product name [string (200)]",
"defaultPrice":"product price [double (10,2)]",
"picture":[
9
...
],
"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 (separated by ||)
[string(200)]",
"propertyImage":" image url of variation product [string(1000)]",
"price":" the price of variation product [dobule(10,2)]"
},
...
{
"sku":" SKU of product property [string(200)]",
"propertyValue":" value of variation property (separated by ||)
[string(200)]",
"propertyImage":"property of image [string(1000)]",
"price":" the price of variation product [double(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)]"
}
],
"spropertyLang":{
"ru":[
{
"name":" specification name in Russian[string(50)]",
"value":" specification value in Russian [string(50)]"
},
...
{
"name":" specification name in Russian [string(50)]",
}
],
...
10
"fa":[
{
"name":" specification name in Farsi [string(50)]",
"value":" specification value in Farsi[string(50)]"
},
...
{
"value":" specification value in Farsi [string(50)]"
}
]
"skuType":"SKU type (1 product without variations 2 product with

variations)[int(3)]"
"marketCodes":" codes of market (separated by”,” , refer to 2.4.2
marketCodes) [string(10)]" ,
"shippingFee_KZ":" shipping cost to Kazakhstan [double(10,2)]",
...
"shippingFee_LB":" shipping cost to Lebanon [double(10,2)]",
"description":" description of product [string(4000)]"
"descriptionLang":{
"ru":"description in Russian[string(4000)]",
...
"fa":"description in Russian[string(4000)]",
},
}
...
],
"pagination":{
"page":" current page[int(10)]",
"rowsPerPage":"results per page[int(10)]",
"totalCount":"total quantity of results[int(10)]"
}
}
11
4 Retrieve Orders
4.1 NAME: OrderRpc.finds

A. search by multi conditions
[{
"dateCodeGeq":"date of order created from [int(8)]", // e.g. 2018-09-10
"dateCodeLeq":"date of order created to[int(8)]", // e.g. 2018-09-13
"timePaidGeq":"date of order paid from", // e.g. 2018-09-10
"timePaidLeq":"date of order paid to", // e.g. 2018-09-21
Recommend using date of payment to download information of new orders
"status":"order status[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”
"page":"page parameter, page number[int(10)]"，

"rowsPerPage":" page parameter, results per page (max 20 results) [int(10)]"
}]
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)]"
}]

{
"orders":[{
"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)",
12
"orderAmount":"amount customer paid[double(10,2)] (Euro)",
"hasRefund":"refunded or not? (1: Yes; 2. No)",
"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]",
"trackNumber":"Tracking Number[string(200)]",
"itemListQuantity":"item quantity [int(10)]",
"itemList":[
{
"sku":"product SKU[string(200)]",
"productName":"product name[string(200)]",
"quantity":" item quantity[int(10)]",
"price":" total amount of this variation[double(10,2)]",
"productUrl":"product URL[string(400)]",
"productId":"product Id[string(10)]",
"trackNumber":"tracking number [string(50)]"
"timeShipped":"time of shipping [datetime]"
},
...
{
"productName":"product name[string(200)]",
"quantity":" item quantity[int(10)]",
"price":" total amount of this variation [double(10,2)]",
"productUrl":"product URL[string(400)]",
"productId":"product Id[string(10)]",
"trackNumber":"tracking number [string(50)]"
"timeShipped":"time of shipping [datetime]"
}
],
"address":{
"countryCode":"the code of recipient’s country[string(100)]"
"receiver":" recipient [string(200)]",
"province":" province of recipient[string(100)]",
13
"city":"city of recipient [string(100)]",

"area":"area of recipient [string(100)]",
"street1":" recipient address1 [string(100)]",
"mobile":"mobile phone number of recipient [string(100)]",
"email":"email of recipient [string(200)]",
"zipcode":"zipcode of recipient [string(20)]"
}
}
...
],
"pagination":{
"page":"current page[int(10)]",
"rowsPerPage":"results per page[int(10)]",
"totalCount":"quantity of total results[int(10)]"
}
}
5 Update Tracking Number of Order

5.1 NAME: OrderRpc.updateTrackNumber

[{
"code":"order number of ZoodMall[string(30)]",
"trackNumber":"tracking number[string(50)]",
"itemList":[
"product SKU[string(200)]",
...
"product SKU[string(200)]"
]
}]
The tracking number will be saved with corresponding item in the ItemList.

{
"code":" order number of ZoodMall[string(30)]",
"status":" order status(1:Unpaid; 2: paid; 3: shipped; 5:completed; 9 : canceled)
[int(3)]"
}
14
6 Update Product information

6.1 NAME: ProductRpc. change
update information of Max 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)]",
"nameLang":{
"ru":"product name in Russian [string(200)]",
...
"fa":" product name in Farsi[string(200)]",
},
"categoryId":"product category ID[int(10)]",
"description":"product description[string(4000)]",
"descriptionLang":{
"ru":" product description in Russian [string(4000)]",
...
"fa":" product description in Farsi [string(4000)]",
},
"sproperty":[
{
"name":" specification name[string(50)]",
"value":" specification value[string(50)]"
},
...
{
"name":" specification name [string(50)]",
"value":" specification value [string(50)]"
}
],
"spropertyLang":{
"ru":[
{
"name":" specification name in Russian[string(50)]",
},
...
{
"name":" specification name in Russian [string(50)]",
}
],
...
15
"fa":[
{
"value":" specification value in Farsi[string(50)]"
},
...
{
"value":" specification value in Farsi [string(50)]"
}
]
},
"picture":[
...
],
"defaultPrice":" product Price [double(10,2)]",
"onSale":"1= on sale; 2= stop sale [int(3)]",
},
...
]]
update Max 100 products each time

All fields are not mandatory except productid

[
{
"sku":"product SPU[string(200)]",
"productId":"product ID [int(10)]"
},
...
]
16
7 Add new variations

7.1 NAME: ProductRpc. addSku

[
{
"productId":"Product ID [int(10)]",
"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)] "
}
]
[
{
}
]
8 Update variations Property Value
8.1 NAME: ProductRpc. changeSku

[
{
"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)] "
}
]
[{
}]
17
9 Stop sales of SKU/variations

9.1 NAME: ProductRpc.changeSaleStatus

[{
"productId":"product ID[int(10)]",
“spu”:”Product SPU”,
“onSale”:”2”//2=FALSE
}]

[{
}]
10 Put Products to markets
10.1 NAME: ProductRpc. onShelves

[[{
"productId":" product Id [int(10)]",
"marketCodes":"market code (separated by”,”,) [string(10)]" ,
"useDefault_KZ":"use default shipping fee?: 1 yes 2 no",
…
"useDefault_LB":"use default shipping fee?: 1 yes 2 no",
"shippingFee_KZ":"shipping fee in KZ[double(10,2)]",
...
"shippingFee_LB":" shipping fee in LB [double(10,2)]",
}
…
]]
[
{
"productId":" product ID [int(10)]"
},
...
]
18
11 disable Products in one markets

11.1 NAME: ProductRpc. offShelves

[[ {
"productId":"productID[int(10)]",
"marketCodes":"market code (separated by”,”,) [string(10)]" ,
}
…
]]
[
{
"productId":" product ID [int(10)]"
},
...
]
12 Check Products verification information

12.1 NAME: ProductRpc. checkAuditStatus

[{
"productId ":"product ID[int(10)]",
"marketCode":"Market Code [string(10)]",
"page":" page parameter, page number [int(10)]"，
"rowsPerPage":" page parameter, results per page (max 20 results) [int(10)]"
}]
marketCode is required, other fields are optional.

[{
"marketCode":"Market Code[string(10)]",
"auditStatus":"verification status：1 waiting for verification 2 approved 3 rejected
[int(3)]",
"timeAudit":"Audit time[date]",
19
"auditRemark":
[
{
"time":"Audit time[date]",
"timeStamp":"Audit Timestamp [time]",
"remark": "Audit Remarks[string(200)]"
}
...
]
}
...
]
13 Cancel items in order
13.1 NAME: cancelOrder

[{
" code":" ZoodMall OrderID[string(30)]",
" refundReason":"Cancel Reason/Refund Reason [string(200)]",
" items":
[
{
"quantity":" quantity of canceled items[int(10)]"
},
…
]
}]
{
" code":" ZoodMall orderID[string(30)]",
}
14 Error Codes
code reason
100001 post search conditions error
110001 post parameters error
20
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
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 Sku already 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
21
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
150004 marketCodes is required
150006 Logistic information should be set in this market
160004 marketCodes is required
160006 Product should be put in this market first
170005 Name is required
170006 nameLang must be array
170007 descriptionLang must be array
170008 sproperty must be array
170009 Each sproperty must contain specification name
170010 Each sproperty must contain specification value
170011 spropertyLang must be array
170012 Picture must be array
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
22

ZoodMall Merchant API 2.0.16-En

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ZoodMall Merchant API 2.0.16-En

Uploaded by

Copyright:

Available Formats

API version：v2.0.

ZoodMall Merchant API

Sign up for test account:

Contact ZoodMall manager to enable your test account

1.2 HTTP Request Method

B. Request Header Parameter

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

E .example of getting the parameters of order

2 Add Products，Update Products

2.2 Request Parameter

2.3 Return Parameters

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

3.2 Request Parameter

3.3 Return Parameters

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

4.2 Request Parameter

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

B. search by order ID of ZoodMall

4.3 Return Parameters

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

5 Update Tracking Number of Order

5.2 Request Parameter

5.3 Return Parameters

6 Update Product information

update Max 100 products each time

6.2 Return Parameters

7 Add new variations

7.2 Request Parameter

8.2 Request Parameter

9 Stop sales of SKU/variations

9.2 Request Parameter

9.3 Return Parameters

10.2 Request Parameter

11 disable Products in one markets

11.2 Request Parameter

12 Check Products verification information

12.2 Request Parameter

marketCode is required, other fields are optional.

12.3 Return Parameters

13.2 Request Parameter

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

120001 Productid is required

140002 sku is required

200005 Current order can not be shipped

You might also like