Class FollowPrizeManager

Hierarchy (View Summary)

BaseManager
- FollowPrizeManager

Index

Constructors

constructor

new FollowPrizeManager(config: ShopeeConfig): FollowPrizeManager
Parameters
- config: ShopeeConfig
Returns FollowPrizeManager
Overrides BaseManager.constructor
- Defined in src/managers/follow-prize.manager.ts:20

Properties

`Protected`config

config: ShopeeConfig

Methods

addFollowPrize

addFollowPrize(params: AddFollowPrizeParams): Promise<AddFollowPrizeResponse>
Add a new follow prize activity
Parameters
- params: AddFollowPrizeParams
  Parameters for creating a new follow prize
Returns Promise<AddFollowPrizeResponse>
The response containing the created follow prize ID

The follow prize allows shops to reward followers with vouchers when they follow the shop.
Throws
When the API request fails or returns an error
- follow_prize.campaign_num_max_limit: Max number of follow prizes reached (1000 ongoing and upcoming)
- follow_prize.campaign_overlap: Another follow prize already exists during this time period
- follow_prize.name_length_limit: Please input up to 20 characters
- follow_prize.percentage_RANGE: Please enter a value between 1 and 99
- follow_prize.end_time_min_limit: End time must be at least 1 day after start time
- follow_prize.quota_out_range: Please enter a value between 1 and 200000
- follow_prize.start_time_min_limit: Start time must be later than current time
- follow_prize.time_future_limit: Start/end time should not exceed 2037-12-31 23:59:59
- Defined in src/managers/follow-prize.manager.ts:41

deleteFollowPrize

deleteFollowPrize(
params: DeleteFollowPrizeParams,
): Promise<DeleteFollowPrizeResponse>
Delete an existing follow prize activity
Parameters
- params: DeleteFollowPrizeParams
  Parameters for deleting a follow prize
Returns Promise<DeleteFollowPrizeResponse>
The response containing the deleted follow prize ID
Throws
When the API request fails or returns an error
- follow_prize.campaign_none: The promotion id does not exist
- follow_prize.delete_type: Only upcoming promotions can be deleted
- Defined in src/managers/follow-prize.manager.ts:64

endFollowPrize

endFollowPrize(params: EndFollowPrizeParams): Promise<EndFollowPrizeResponse>
End an ongoing follow prize activity immediately
Parameters
- params: EndFollowPrizeParams
  Parameters for ending a follow prize
Returns Promise<EndFollowPrizeResponse>
The response containing the ended follow prize ID
Throws
When the API request fails or returns an error
- follow_prize.campaign_none: The promotion id does not exist
- follow_prize.end_type: Only ongoing follow prizes can be ended
- Defined in src/managers/follow-prize.manager.ts:87

getFollowPrizeDetail

getFollowPrizeDetail(
params: GetFollowPrizeDetailParams,
): Promise<GetFollowPrizeDetailResponse>
Get detailed information about a follow prize activity
Parameters
- params: GetFollowPrizeDetailParams
  Parameters for getting follow prize details
Returns Promise<GetFollowPrizeDetailResponse>
The response containing comprehensive follow prize information

The response includes:
- campaign_status: The status of the follow prize (upcoming/ongoing/expired)
- campaign_id: The unique identifier for the follow prize
- follow_prize_name: The name of the follow prize
- start_time: When the follow prize becomes valid
- end_time: When the follow prize expires
- usage_quantity: The total quantity available
- min_spend: Minimum basket price required
- reward_type: Type of reward (1: fix amount, 2: percentage, 3: coin cash back)
- discount_amount/percentage/max_price: Reward details based on reward_type
Throws
When the API request fails or returns an error
- follow_prize.campaign_none: The promotion id does not exist
- Defined in src/managers/follow-prize.manager.ts:120

getFollowPrizeList

getFollowPrizeList(
params: GetFollowPrizeListParams,
): Promise<GetFollowPrizeListResponse>
Get a list of follow prize activities with pagination
Parameters
- params: GetFollowPrizeListParams
  Parameters for retrieving follow prize list
  
  Parameters for getting a list of follow prizes
  - [key: string]: string | number | boolean | undefined
  - Optionalpage_no?: number
    Specifies the page number of data to return. Default 1
  - Optionalpage_size?: number
    Maximum number of entries to retrieve per page. Default 20, max 100
  - status: FollowPrizeStatus
    The status filter for retrieving follow prize list
Returns Promise<GetFollowPrizeListResponse>
The response containing a paginated list of follow prizes

The response includes:
- more: Boolean indicating if there are more pages
- follow_prize_list: Array of follow prize information containing:
  - campaign_id: The unique identifier
  - campaign_status: Current status
  - follow_prize_name: Name of the follow prize
  - start_time/end_time: Validity period
  - usage_quantity: Total quantity
  - claimed: Quantity already claimed
- Defined in src/managers/follow-prize.manager.ts:154

updateFollowPrize

updateFollowPrize(
params: UpdateFollowPrizeParams,
): Promise<UpdateFollowPrizeResponse>
Update an existing follow prize activity
Parameters
- params: UpdateFollowPrizeParams
  Parameters for updating a follow prize
Returns Promise<UpdateFollowPrizeResponse>
The response containing the updated follow prize ID

Update restrictions:
- Cannot rename ongoing follow prizes
- Cannot update minimum basket price for ongoing follow prizes
- Cannot update start time for ongoing follow prizes
- Start time can only be changed to a later timing (for upcoming)
- End time can only be changed to an earlier timing
- Cannot reduce dispatch quantity
- Cannot update expired follow prizes
Throws
When the API request fails or returns an error
- follow_prize.campaign_none: The promotion id does not exist
- follow_prize.update_expired_campaign: Cannot update expired follow prizes
- follow_prize.update_prize_name_ongoing: Cannot rename ongoing follow prizes
- follow_prize.update_min_spend_ongoing: Cannot update minimum basket price for ongoing
- follow_prize.update_start_time_ongoing: Cannot update start time for ongoing
- follow_prize.update_start_time_earlier: Start time can only be changed to later
- follow_prize.update_end_time_later: End time can only be changed to earlier
- follow_prize.update_quantity_reduce: Cannot reduce dispatch quantity
- Defined in src/managers/follow-prize.manager.ts:192

Class FollowPrizeManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FollowPrizeManager

Properties

Protectedconfig

Methods

addFollowPrize

Parameters

Returns Promise<AddFollowPrizeResponse>

Throws

deleteFollowPrize

Parameters

Returns Promise<DeleteFollowPrizeResponse>

Throws

endFollowPrize

Parameters

Returns Promise<EndFollowPrizeResponse>

Throws

getFollowPrizeDetail

Parameters

Returns Promise<GetFollowPrizeDetailResponse>

Throws

getFollowPrizeList

Parameters

[key: string]: string | number | boolean | undefined

Optionalpage_no?: number

Optionalpage_size?: number

status: FollowPrizeStatus

Returns Promise<GetFollowPrizeListResponse>

updateFollowPrize

Parameters

Returns Promise<UpdateFollowPrizeResponse>

Throws

Settings

On This Page

`Protected`config

`Optional`page_no?: number

`Optional`page_size?: number