v2.global_product.get_shop_publishable_status
GET /api/v2/global_product/get_shop_publishable_status
Get publishable shop list for global item in pages.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/global_product/get_shop_publishable_status
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 |
|---|---|---|---|---|
| global_item_id | int | True | 3000141126 | Id of global item. |
| offset | int | True | 0 | 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.Max=100 |
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 | Warning message. | |
| request_id | string | 98eae35efff24dd0974c21a847127184 | The identifier for an API request for error tracking. |
| response | object | Detail informations you are querying. | |
| shop_publishable_status_list | object[] | Detail of publishable shops. | |
| shop_id | int | 1000567 | Id of publishable shop. |
| region | string | TW | Region of published shop. |
| shop_publishable_status | boolean | true | If the shop is publishable, ture means shop is publishable, fals means shop is unpublishable |
| unpublishable_reason | string | The shop is under penalty | Return the unpublishable reason. If the shop is publishable, will return empty for this field. |
| has_next_page | boolean | true | 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 | 1 | if has_next_page is true, this value need set to next request.offset |