v2.global_product.get_brand_list
GET /api/v2/global_product/get_brand_list
Use this call to get a list of brand. Only for China mainland sellers and Korean sellers.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/global_product/get_brand_list
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 |
|---|---|---|---|---|
| offset | int | True | 1 | Specifies the starting entry of data to return in the current call. Default is 0. if data is more than one page, the offset can be some entry to start next call. |
| page_size | int | True | 10 | the size of one page. |
| category_id | int | True | 12345 | ID of category. |
| status | int | True | 1 | Brand status , 1: normal brand, 2: pending brand. |
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. | |
| warning | string | Indicate waring details if hit waring. Empty if no waring happened. | |
| request_id | string | 7b9da0c6926642199c33ee9dd3a266f5 | The identifier for an API request for error tracking |
| response | object | ||
| brand_list | object[] | ||
| brand_id | int | 0 | Id of brand. |
| original_brand_name | string | nike | Original name of brand |
| display_brand_name | string | nike | Display name of brand |
| has_next_page | boolean | This is to indicate whether the item 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 items. | |
| next_offset | int | If has_next_page is true, this value need set to next request.offset | |
| is_mandatory | boolean | Whether is mandatory. | |
| input_type | string | Input type: DROP_DOWN |