v2.add_on_deal.get_add_on_deal_list
GET /api/v2/add_on_deal/get_add_on_deal_list
Get Add-on Deal List
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/add_on_deal/get_add_on_deal_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. |
| 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 |
|---|---|---|---|---|
| promotion_status | string | True | all | The Status of add on deal，default status is all |
| page_no | int | False | 1 | The default page number is 1 |
| page_size | int | False | 100 | The default page size is 100 |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Error code | |
| message | string | The description of error code | |
| request_id | string | dc46d78810be446693995d31d03312c0 | The identifier of the API request for error tracking |
| response | object | ||
| add_on_deal_list | object[] | The list of add on deal id | |
| start_time | int | 1617105600 | The time when add on deal activity start. |
| end_time | int | 1617195600 | The time when add on deal activity end |
| promotion_type | int | 0 | The type of add on deal：add on discount =0；gift with mini spend=1 |
| purchase_min_spend | float | 3.0 | The minimum purchase amount that needs to be met to buy the gift with min.Spend |
| add_on_deal_id | int | 20183 | Shopee's unique identifier for an add on deal activity. |
| per_gift_num | int | 1 | Number of gifts that buyers can get |
| promotion_purchase_limit | int | 12 | Max. number of add-on products that a customer can purchase per order. |
| add_on_deal_name | string | Bundle deal name test | Title of the add on deal |
| source | int | 1 | The create source of bundle deal：Seller=1，shopee admin=0 |
| sub_item_prioriry | int[] | [100862950,100863523] | The display sequence of sub item in buyer side |
| more | boolean | true | This is to indicate whether the promotion 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 promotions. |