v2.discount.get_sip_discounts
GET /api/v2/discount/get_sip_discounts
Get SIP Overseas Discounts. Only regions that have upcoming/ongoing discounts will be returned. Please use Primary shop's Shop ID to request, the API will return the list of Affiliate shops under this Primary shop that have set discounts, along with the discount details.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/discount/get_sip_discounts
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 |
|---|---|---|---|---|
| region | string | False | SG | The region of SIP affiliate shop that needs to get discount information. If do not pass, will return the discount information set for all SIP affiliate shops. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | The identifier for an API request for error tracking. | |
| 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. | |
| response | object | ||
| discount_list | object[] | List of discounts in each region. Will be filtered based on the "region" request parameter. | |
| region | string | SG | The region of SIP affiliate shop. |
| status | string | ongoing | The status of discount for SIP affiliate shop in current region, can be upcoming/ongoing, excluding expired discounts. |
| sip_discount_rate | int32 | 10 | The discount rate set for SIP affiliate shop in current region. |
| start_time | timestamp | 1741235212 | The start time of discount for SIP affiliate shop in current region, in UNIX seconds. |
| end_time | timestamp | 1756787212 | The end time of discount for SIP affiliate shop in current region, in UNIX seconds. |
| create_time | timestamp | 1741233412 | The create time of discount for SIP affiliate shop in current region, in UNIX seconds. |
| update_time | timestamp | 1741233412 | The latest update time of discount for SIP affiliate shop in current region, in UNIX seconds. |