Class DiscountManager

Hierarchy (View Summary)

BaseManager
- DiscountManager

Index

Constructors

Properties

Methods

addDiscount addDiscountItem deleteDiscount deleteDiscountItem deleteSipDiscount endDiscount getDiscount getDiscountList getSipDiscounts setSipDiscount updateDiscount updateDiscountItem

Constructors

constructor

new DiscountManager(config: ShopeeConfig): DiscountManager
Parameters
- config: ShopeeConfig
Returns DiscountManager
Overrides BaseManager.constructor
- Defined in src/managers/discount.manager.ts:32

Properties

`Protected`config

config: ShopeeConfig

Methods

addDiscount

addDiscount(params: AddDiscountParams): Promise<AddDiscountResponse>
Add a new shop discount activity
Parameters
- params: AddDiscountParams
  Parameters for creating a new discount
Returns Promise<AddDiscountResponse>
The response containing the created discount ID

Note: The start time must be 1 hour later than current time. The end time must be 1 hour later than start time, and the discount period must be less than 180 days.
- Defined in src/managers/discount.manager.ts:44

addDiscountItem

addDiscountItem(params: AddDiscountItemParams): Promise<AddDiscountItemResponse>
Add items to an existing discount activity
Parameters
- params: AddDiscountItemParams
  Parameters for adding items to a discount
Returns Promise<AddDiscountItemResponse>
The response containing the count of added items and any errors

The response includes:
- discount_id: The ID of the discount activity
- count: Number of items successfully added
- error_list: List of items that failed to be added with error details
- warning: Warning message if any
- Defined in src/managers/discount.manager.ts:69

deleteDiscount

deleteDiscount(params: DeleteDiscountParams): Promise<DeleteDiscountResponse>
Delete an existing discount activity
Parameters
- params: DeleteDiscountParams
  Parameters for deleting a discount
Returns Promise<DeleteDiscountResponse>
The response containing the deleted discount ID and modification time

Note: Can only delete upcoming discounts that haven't started yet. Will return an error if attempting to delete a discount that has already started.
- Defined in src/managers/discount.manager.ts:91

deleteDiscountItem

deleteDiscountItem(
params: DeleteDiscountItemParams,
): Promise<DeleteDiscountItemResponse>
Delete items from an existing discount activity
Parameters
- params: DeleteDiscountItemParams
  Parameters for deleting items from a discount
Returns Promise<DeleteDiscountItemResponse>
The response containing the discount ID and any errors

The response includes:
- discount_id: The ID of the discount activity
- error_list: List of items that failed to be deleted with error details
- Defined in src/managers/discount.manager.ts:114

deleteSipDiscount

deleteSipDiscount(
params: DeleteSipDiscountParams,
): Promise<DeleteSipDiscountResponse>
Delete SIP Overseas Discount for SIP affiliate region
Parameters
- params: DeleteSipDiscountParams
  Parameters for deleting the SIP discount
Returns Promise<DeleteSipDiscountResponse>
The response containing the deleted region

Use Primary shop's Shop ID to request. Provide the region of the Affiliate shop to be deleted, and the API will delete the discount from that region's Affiliate shop.

Note: Cannot edit the promotion within 15 minutes after an update
- Defined in src/managers/discount.manager.ts:294

endDiscount

endDiscount(params: EndDiscountParams): Promise<EndDiscountResponse>
End an ongoing discount activity immediately
Parameters
- params: EndDiscountParams
  Parameters for ending a discount
Returns Promise<EndDiscountResponse>
The response containing the ended discount ID and modification time

Note: Can only end discounts that are currently ongoing/active. Will return an error if attempting to end an upcoming or expired discount.
- Defined in src/managers/discount.manager.ts:136

getDiscount

getDiscount(params: GetDiscountParams): Promise<GetDiscountResponse>
Get detail of a shop discount activity
Parameters
- params: GetDiscountParams
  Parameters for retrieving discount details
  
  Parameters for getting a discount
  - [key: string]: string | number | boolean | undefined
  - discount_id: number
    Shopee's unique identifier for a discount activity
  - page_no: number
    Specifies the page number of data to return. Default 1
  - page_size: number
    Maximum number of entries to retrieve per page. Default 50
Returns Promise<GetDiscountResponse>
The response containing discount details
- Defined in src/managers/discount.manager.ts:316

getDiscountList

getDiscountList(params: GetDiscountListParams): Promise<GetDiscountListResponse>
Get a list of discount activities with pagination
Parameters
- params: GetDiscountListParams
  Parameters for retrieving discount list
  
  Parameters for getting a list of discounts
  - [key: string]: string | number | boolean | undefined
  - discount_status: DiscountStatus
    The status of discount promotion
  - 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 100, max 100
  - Optionalupdate_time_from?: number
    Update time from
  - Optionalupdate_time_to?: number
    Update time to
Returns Promise<GetDiscountListResponse>
The response containing a paginated list of discounts

The response includes:
- Pagination information (more: boolean indicating if there are more pages)
- A list of discounts with basic details such as ID, name, status, start/end time, and source
- Defined in src/managers/discount.manager.ts:162

getSipDiscounts

getSipDiscounts(
params?: GetSipDiscountsParams,
): Promise<GetSipDiscountsResponse>
Get SIP Overseas Discounts
Parameters
- Optionalparams: GetSipDiscountsParams
  Optional parameters for filtering by region
Returns Promise<GetSipDiscountsResponse>
The response containing a list of SIP discounts

Only regions that have upcoming/ongoing discounts will be returned. Use Primary shop's Shop ID to request - the API will return the list of Affiliate shops under this Primary shop that have set discounts, along with the discount details.

The response includes:
- discount_list: Array of discount information for each region
  - region: The region of the SIP affiliate shop
  - status: The status of the discount (upcoming/ongoing)
  - sip_discount_rate: The discount rate percentage
  - start_time: When the discount starts (UNIX timestamp)
  - end_time: When the discount ends (UNIX timestamp)
  - create_time: When the discount was created (UNIX timestamp)
  - update_time: When the discount was last updated (UNIX timestamp)
- Defined in src/managers/discount.manager.ts:242

setSipDiscount

setSipDiscount(params: SetSipDiscountParams): Promise<SetSipDiscountResponse>
Set SIP Overseas Discount for SIP affiliate region
Parameters
- params: SetSipDiscountParams
  Parameters for setting the SIP discount
Returns Promise<SetSipDiscountResponse>
The response containing the created/updated discount details

Use Primary shop's Shop ID to request. Provide the region and discount rate of the Affiliate shop to be set or update - the API will set or update the discount rate for that region's Affiliate shop.

Notes:
- The start time is 30 minutes after the discount is set
- The end time is 180 days after the start time
- Cannot edit the promotion within 15 minutes after an update
- In VN region, discount rate cannot exceed 50%
- Defined in src/managers/discount.manager.ts:270

updateDiscount

updateDiscount(params: UpdateDiscountParams): Promise<UpdateDiscountResponse>
Update an existing discount activity
Parameters
- params: UpdateDiscountParams
  Parameters for updating a discount
Returns Promise<UpdateDiscountResponse>
The response containing the updated discount ID and modification time

Note: For ongoing discounts, update capabilities may be limited. Only certain fields can be modified depending on the discount status.
- Defined in src/managers/discount.manager.ts:184

updateDiscountItem

updateDiscountItem(
params: UpdateDiscountItemParams,
): Promise<UpdateDiscountItemResponse>
Update items in an existing discount activity
Parameters
- params: UpdateDiscountItemParams
  Parameters for updating discount items
Returns Promise<UpdateDiscountItemResponse>
The response containing the count of updated items and any errors

The response includes:
- discount_id: The ID of the discount activity
- count: Number of items successfully updated
- error_list: List of items that failed to be updated with error details
- warning: Warning message if any
- Defined in src/managers/discount.manager.ts:209

Class DiscountManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DiscountManager

Properties

Protectedconfig

Methods

addDiscount

Parameters

Returns Promise<AddDiscountResponse>

addDiscountItem

Parameters

Returns Promise<AddDiscountItemResponse>

deleteDiscount

Parameters

Returns Promise<DeleteDiscountResponse>

deleteDiscountItem

Parameters

Returns Promise<DeleteDiscountItemResponse>

deleteSipDiscount

Parameters

Returns Promise<DeleteSipDiscountResponse>

endDiscount

Parameters

Returns Promise<EndDiscountResponse>

getDiscount

Parameters

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

discount_id: number

page_no: number

page_size: number

Returns Promise<GetDiscountResponse>

getDiscountList

Parameters

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

discount_status: DiscountStatus

Optionalpage_no?: number

Optionalpage_size?: number

Optionalupdate_time_from?: number

Optionalupdate_time_to?: number

Returns Promise<GetDiscountListResponse>

getSipDiscounts

Parameters

Returns Promise<GetSipDiscountsResponse>

setSipDiscount

Parameters

Returns Promise<SetSipDiscountResponse>

updateDiscount

Parameters

Returns Promise<UpdateDiscountResponse>

updateDiscountItem

Parameters

Returns Promise<UpdateDiscountItemResponse>

Settings

On This Page

`Protected`config

`Optional`page_no?: number

`Optional`page_size?: number

`Optional`update_time_from?: number

`Optional`update_time_to?: number