v2.product.get_item_promotion
GET /api/v2/product/get_item_promotion
Get item promotion info.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/product/get_item_promotion
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 |
|---|---|---|---|---|
| item_id_list | int64[] | True | 13233406680,17924576533 | Item ID list, can send 1 to 50 items. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | product.error_param | 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 | Waring message. | |
| request_id | string | The identifier for an API request for error tracking. | |
| response | object | ||
| success_list | object[] | Success item promotion info. | |
| item_id | int | The identity of product item. | |
| promotion | object[] | Item promotion info list | |
| promotion_type | string | Campaign | Promotion type, Applicable values: See Data Definition- PromotionType. |
| promotion_id | int64 | The identity of item promotion. | |
| model_id | int64 | The identity of product model. | |
| start_time | timestamp | Promotion start tiem. | |
| end_time | timestamp | Promotion end item. | |
| promotion_price_info | object[] | Promotion price info. | |
| promotion_price | float | Promotion price. | |
| promotion_staging | string | Could be ongoing/upcoming | |
| promotion_stock_info_v2 | object | new promotion stock | |
| summary_info | object | stock summary info | |
| total_reserved_stock | int32 | 10 | Total Stock reserved for promotion |
| failure_list | object[] | Fail item promotion info. | |
| item_id | int64 | The identity of item. | |
| failed_reason | string | Fail reason. |