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, closed interval, same as createTimeTo |
| createTimeTo | N | String | 2025-04-15 | Shop create time end, closed interval (includes that day) |
| updateTimeFrom | N | String | 2025-04-15 | Shop update time start, closed interval, same as createTimeFrom |
| updateTimeTo | N | String | 2025-04-15 | Shop update time end, closed interval (includes that day) |
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 | |
| managerName | N | String | John Smith | Shop manager |
| shopGroupName | N | String | East China,Key Accounts | Shop group names, separated by commas |
| updateTime | N | String | 2026-08-31 10:58:54 | Update time |
| shopCustomFieldValueList | N | List<ShopCustomFieldValue> | Shop custom fields |
ShopGroup
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| id | Y | Long | 1 | Shop group id |
| shopGroupName | Y | String | group1 | Shop group name |
ShopCustomFieldValue
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| columName | Y | String | Finance ID | Custom field name |
| columType | Y | String | STRING | Custom field type: NUMBER, DATE, STRING, or SELECT |
| value | Y | String | FIN-001 | Custom field value; DATE values use the yyyy/MM/dd format |
Request example:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/shop' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_SHOP_LIST"' \
--form 'bizParam="{\"page\":1,\"pageSize\":3}"' \
--form 'timestamp="1756865700001"' \
--form 'sign="6a7a3ee175d0cfab63198c5e49bddc60"'
Response example:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"authExpiredStatus\":\"NORMAL\",\"createTime\":1756867627000,\"currency\":\"IDR\",
\"expireTime\":2114352000000,\"isDeleted\":0,\"name\":\"CS355\",\"platform\":\"INDEPENDENT\",\"shopId\":30598,\"status\":\"UNLOCK\",
\"timeZoneId\":\"Asia/Jakarta\"},{\"authExpiredStatus\":\"NORMAL\",\"createTime\":1756867558000,\"currency\":\"JPY\",\"isDeleted\":0,
\"name\":\"黑咪批发店\",\"platform\":\"DLZ_B2B\",\"shopId\":30597,\"status\":\"UNLOCK\",\"timeZoneId\":\"Asia/Tokyo\"},
{\"authExpiredStatus\":\"NORMAL\",\"createTime\":1756864609000,\"currency\":\"IDR\",\"isDeleted\":0,\"name\":\"zctpaytest\",\"onlineShopId\":\"BS000099\",
\"platform\":\"DLZ_POS\",\"shopId\":30594,\"status\":\"UNLOCK\",\"timeZoneId\":\"Asia/Jakarta\"}],\"state\":\"success\",\"total\":1517}",
"requestId": "5ec9b933-d704-4070-9735-913f8e78ebb4"
}