v2.public.get_merchants_by_partner
GET /api/v2/public/get_merchants_by_partner
Use this API to get basic info of merchants which have authorized to the partner.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/public/get_merchants_by_partner
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. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp 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_size | int | False | 1 | 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. |
| page_no | int | False | 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. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| authed_merchant_list | object[] | A list of merchants authorized to the partner. | |
| region | string | SG | Merchant's area |
| merchant_id | int | 1 | Shopee's unique identifier for a merchant. |
| auth_time | timestamp | 123 | The timestamp when the merchant was authorized to the partner. |
| expire_time | timestamp | 12312 | Use this field to indicate the expiration date for merchant authorization. |
| request_id | string | asdasq | The identifier for an API request for error tracking. |
| 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. |
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. |