v2.add_on_deal.get_add_on_deal
GET /api/v2/add_on_deal/get_add_on_deal
Get Add-on Deal
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/add_on_deal/get_add_on_deal
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 |
|---|---|---|---|---|
| add_on_deal_id | int | True | 12069 | Shopee's unique identifier for an add on deal activity. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Error code | |
| message | string | The description of error code | |
| request_id | string | c1712c064039dfea0eefe73c7f8cc26d | The identifier of the API request for error tracking |
| response | object | ||
| start_time | int | 1656601200 | The time when add on deal activity start. |
| end_time | int | 1656604800 | 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 | 0.0 | The minimum purchase amount that needs to be met to buy the gift with min.Spend |
| add_on_deal_id | int | 12069 | Shopee's unique identifier for an add on deal activity. |
| per_gift_num | int | 0 | Number of gifts that buyers can get |
| sub_item_priority | int[] | The order of the sub item | |
| promotion_purchase_limit | int | 100 | Max. number of add-on products that a customer can purchase per order. |
| add_on_deal_name | string | add on deal test | Title of the add on deal |
| source | int | 1 |