v2.shop.get_authorised_reseller_brand
GET /api/v2/shop/get_authorised_reseller_brand
Get the authorised reseller brand list for the shop.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/shop/get_authorised_reseller_brand
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. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_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 | 10 | 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. The limit of page_size if between 1 and 30. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| 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. | |
| request_id | string | b8b833d5a7284dfd80f3fe8b108a1a15 | The identifier for an API request for error tracking. |
| response | object | ||
| is_authorised_reseller | boolean | true | This is to indicate whether the shop is authorised reseller. |
| total_count | int64 | 12 | The number of authorised brand linked with the shop. |
| more | boolean | true | This is to indicate whether the authorised brand 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 authorised brand. |
| authorised_brand_list | object[] | ||
| brand_id | int64 | 1 | ID of the authorised brand, it may be the same in different regions. |
| brand_name | string | test brand | Name of the authorised brand. |