Shopee SDK API Reference - v2.8.0
    Preparing search index...

    Interface SetShopHolidayModeRequest

    Request parameters for 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.

    interface SetShopHolidayModeRequest {
        holiday_mode_description?: string;
        holiday_mode_end_time?: number | Date;
        holiday_mode_on: boolean;
        holiday_mode_start_time?: number | Date;
        holiday_mode_type?: number;
    }
    Index

    Properties

    holiday_mode_description?: string

    Description of the holiday

    holiday_mode_end_time?: number | Date

    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_on: boolean

    Indicate whether to enable holiday mode for the shop. true means turn ON, false means turn OFF.

    holiday_mode_start_time?: number | Date

    Holiday start time should be whole hour and could be parsed as "2026:01:16 15:00:00"

    holiday_mode_type?: number

    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).