v2.shop.set_shop_holiday_mode
POST /api/v2/shop/set_shop_holiday_mode
Use this API to set holiday periods in advance for automatic on/off of holiday mode and there are two holiday modes allowing sellers to choose whether to accept new orders during holiday.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/shop/set_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 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| holiday_mode_on | boolean | True | true | Indicate whether to enable holiday mode for the shop. true means turn ON, false means turn OFF. |
| holiday_mode_type | int32 | False | 1 | Holiday type: 0 - Full holiday，buyers cannot place new orders. The behavior remains consistent with the current Holiday Mode. 1 - Partial holiday, buyers can continue placing orders, and the system will automatically extend the order’s Ship-By-Date (SBD). |
| holiday_mode_start_time | timestamp | False | 1770883200 | Holiday start time should be whole hour and could be parsed as "2026:01:16 15:00:00" |
| holiday_mode_end_time | timestamp | False | 1773305999 | Holiday end time plus one second should be whole hour, which means the input timestamp must be able to be parsed as "2025:01:20 17:59:59" and the holiday_end_time must be larger than holiday_start_time |
| holiday_mode_description | string | False | "Spring Festival" | Description of the holiday |
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 | ||
| debug_msg | string | "" | Debug message. |