v2.shop.get_shop_holiday_mode
GET /api/v2/shop/get_shop_holiday_mode
Use this API to check whether a shop has enabled holiday mode and its ongoing and upcoming holiday mode period.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/shop/get_shop_holiday_mode
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 |
No Request Parameters Set.
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | error_shop_not_exists | Indicate error type if hit error. Empty if no error happened. |
| message | string | Invalid partner_id or shopid. | Indicate error details if hit error. Empty if no error happened. |
| request_id | string | 6745b892295d750abf83a29430510400 | The identifier for an API request for error tracking. |
| response | object | ||
| holiday_mode_on | boolean | true | Indicate whether the shop has enabled holiday mode. true means ON, false means OFF. |
| holiday_mode_mtime | timestamp | 1763435974 | The last time the holiday mode was modifies. |
| holiday_mode_type | int32 | 1 | Indicate whether the holiday mode is partial holiday or full holiday. 1: Partial Holiday: seller can still receive orders during partial holiday 0: Full Holiday: seller can not receive orders during full holiday only when holiday_mode_on = true will the holiday_mode_type work |
| holiday_mode_start_time | timestamp | 1770883200 | Holiday start time timestamp. |
| holiday_mode_end_time | timestamp | 1773305999 | Holiday end time timestamp. |
| holiday_mode_description | string | "Spring Festival" | Description of the holiday |
| debug_msg | string | "" | Debug message. |