v2.merchant.get_shop_list_by_merchant
GET /api/v2/merchant/get_shop_list_by_merchant
Use this call to get shop_list bound to merchant_id.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/merchant/get_shop_list_by_merchant
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| merchant_id | int | 1 | Shopee’s unique identifier for a merchant. Required for all merchant level requests(CB CNSC user calling global product related APIs). |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, merchant_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| page_no | int32 | True | 1 | Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call. |
| page_size | int32 | True | 100 | Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call), and the "page_no" to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data.No more than 500. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | a3a4277823b1019960cc92cfd972c506 | The identifier for an API request for error tracking. |
| shop_list | object[] | list of shop authorized to the partner and bound to the merchant. | |
| shop_id | int64 | 600000 | Shopee's unique identifier for a shop. |
| sip_affi_shops | object[] | List of SIP affiliate shops.Only primary shop will return this parameter | |
| affi_shop_id | int64 | 123456 | Affiliate shop's id. |
| more | boolean | false | This is to indicate whether the list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of datas. |