快工助手跨境电商知识与商机助手

v2.shop.set_shop_holiday_mode

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 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.

#

§2 Overview

Overview

FieldValue
ModuleShop
API typeShop
HTTP methodPOST
Path/api/v2/shop/set_shop_holiday_mode
Production URLhttps://partner.shopeemobile.com/api/v2/shop/set_shop_holiday_mode
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/shop/set_shop_holiday_mode
PermissionERP System; Seller In House System; Product Management; Order Management
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
holiday_mode_onbooleanYestrueIndicate whether to enable holiday mode for the shop. true means turn ON, false means turn OFF.
holiday_mode_typeint32No1Holiday 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_timetimestampNo1770883200Holiday start time should be whole hour and could be parsed as "2026:01:16 15:00:00"
holiday_mode_end_timetimestampNo1773305999Holiday 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_descriptionstringNo"Spring Festival"Description of the holiday
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
errorstringerror_shop_not_existsIndicate error type if hit error. Empty if no error happened.
messagestringInvalid partner_id or shopid.Indicate error details if hit error. Empty if no error happened.
request_idstring6745b892295d750abf83a29430510400The identifier for an API request for error tracking.
responseobject
response.debug_msgstring""Debug message.
#

§5 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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
#

§6 Request samples

Request samples

#

§7 Payload

Payload

{
	"holiday_mode_on": true,
	"holiday_mode_type": 1,
	"holiday_mode_start_time": 1770883200,
	"holiday_mode_end_time": 1773305999,
	"holiday_mode_description": "\"Spring Festival\""
}
#

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/shop/set_shop_holiday_mode?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"holiday_mode_description\": \"\\"Spring Festival\\"\",
   \"holiday_mode_end_time\": 1773305999,
   \"holiday_mode_on\": true,
   \"holiday_mode_start_time\": 1770883200,
   \"holiday_mode_type\": 1
}")
.asString();
#

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/shop/set_shop_holiday_mode?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
    "holiday_mode_description": "\\"Spring Festival\\"",
    "holiday_mode_end_time": 1773305999,
    "holiday_mode_on": true,
    "holiday_mode_start_time": 1770883200,
    "holiday_mode_type": 1
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
#

§10 cURL

cURL

curl --location --request POST 'https://partner.shopeemobile.com/api/v2/shop/set_shop_holiday_mode?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "holiday_mode_description": "\"Spring Festival\"",
   "holiday_mode_end_time": 1773305999,
   "holiday_mode_on": true,
   "holiday_mode_start_time": 1770883200,
   "holiday_mode_type": 1
}'
#

§11 Python

Python

import requests
import json

url = "https://partner.shopeemobile.com/api/v2/shop/set_shop_holiday_mode?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "holiday_mode_description": "\"Spring Festival\"",
  "holiday_mode_end_time": 1773305999,
  "holiday_mode_on": True,
  "holiday_mode_start_time": 1770883200,
  "holiday_mode_type": 1
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§12 Response sample

Response sample

#

§13 JSON

JSON

{
	"error": "error_shop_not_exists",
	"message": "Invalid partner_id or shopid.",
	"request_id": "6745b892295d750abf83a29430510400",
	"response": {
		"debug_msg": "\"\""
	}
}
#

§14 Error example

Error example

#

§15 JSON

JSON

{
	"error": "error_shop_not_exists",
	"message": "Invalid partner_id or shopid.",
	"request_id": "6745b892295d750abf83a29430510400"
}
#

§16 Errors

Errors

ErrorDescriptionSolution
10011err_service_internal
10002error_shop_not_exists
#

§17 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspendedThe API is offline. Please call v2 API instead.
error_limitThe total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#

§18 Update log

Update log

DateChange
2026-03-13Add request parameters holiday_mode_type、holiday_mode_start_time、holiday_mode_end_time、holiday_mode_description
2025-11-24New API
#