1. Shop API
API URL
post {HTTP(S)host} /api/{version}/shop
1.1. Shop Query List
1.1.1. SERVICE_TYPE
QUERY_SHOP_LIST
1.1.2. Request
Params |
Require |
DataType |
Sample |
Description |
page |
Y |
Number |
1 |
Page number, default 1 |
pageSize |
Y |
Number |
50 |
Number of records per page. no more than 200; Default is 100 |
platform |
N |
String |
EBAY,AMAZON,ALIEXPRESS |
Platform |
status |
N |
String |
LOCK,UNLOCK |
Shop status |
siteCode |
N |
String |
US,CA |
Shop site country |
name |
N |
String |
Lazada1号店 |
Shop name |
authExpiredStatus |
N |
String |
NORMAL |
shop auth status: NORMAL、NO_AUTH、EXPIRED |
createTimeFrom |
N |
String |
2025-04-15 |
shop create time start |
createTimeTo |
N |
String |
2025-04-15 |
shop create time end |
1.1.3. Reponse
Params |
Require |
DataType |
Sample |
Description |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
Error Code |
errorMsg |
Y |
String |
“The input of Params is incorrect” |
Business Error Messages |
state |
Y |
String |
success |
Response State |
total |
Y |
Number |
100 |
Total num |
result |
Y |
List<Shop> |
|
Shop info |
Shop( Shop )
Params |
Require |
DataType |
Sample |
Description |
name |
Y |
String |
“Lazada1号店” |
Shop Name, up to 50 characters |
platform |
Y |
String |
“EBAY,AMAZON,ALIEXPRESS” |
Platform |
status |
Y |
String |
LOCK,UNLOCK |
Shop status |
siteCode |
N |
String |
US,CA |
Shop site country |
authExpiredStatus |
Y |
String |
NO_AUTH,NORMAL,EXPIRED |
Authorization status |
shopId |
Y |
Long |
11111 |
Shop id |
onlineShopId |
N |
String |
10010 |
Online shop id |
shopGroupVOList |
N |
List<ShopGroup> |
|
ShopGroupInfo |
createTime |
Y |
Long |
1744686179000 |
ShopGroup
Params |
Require |
DataType |
Sample |
Description |
id |
Y |
Long |
1 |
Shop group id |
shopGroupName |
Y |
String |
group1 |
Shop group name |