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:33

Properties

`Protected`config

config: ShopeeConfig

Methods

addDiscount

addDiscount(params?: AddDiscountRequest): Promise<AddDiscountResponse>
Use this api to add shop discount activity
Parameters
- Optionalparams: AddDiscountRequest
  Request parameters
Returns Promise<AddDiscountResponse>
Promise resolving to the response
- Defined in src/managers/discount.manager.ts:42

addDiscountItem

addDiscountItem(
params?: AddDiscountItemRequest,
): Promise<AddDiscountItemResponse>
Use this api to add shop discount item.
Parameters
- Optionalparams: AddDiscountItemRequest
  Request parameters
Returns Promise<AddDiscountItemResponse>
Promise resolving to the response
- Defined in src/managers/discount.manager.ts:56

deleteDiscount

deleteDiscount(params?: DeleteDiscountRequest): Promise<DeleteDiscountResponse>
Use this api to delete one discount activity
Parameters
- Optionalparams: DeleteDiscountRequest
  Request parameters
Returns Promise<DeleteDiscountResponse>
Promise resolving to the response
- Defined in src/managers/discount.manager.ts:69

deleteDiscountItem

deleteDiscountItem(
params?: DeleteDiscountItemRequest,
): Promise<DeleteDiscountItemResponse>
Use this api to delete items of the discount activity
Parameters
- Optionalparams: DeleteDiscountItemRequest
  Request parameters
Returns Promise<DeleteDiscountItemResponse>
Promise resolving to the response
- Defined in src/managers/discount.manager.ts:83

deleteSipDiscount

deleteSipDiscount(
params?: DeleteSipDiscountRequest,
): Promise<DeleteSipDiscountResponse>
Delete SIP Overseas Discounts for SIP affiliate region. Please use Primary shop's Shop ID to request, and provide the region of the Affiliate shop to be deleted, the API will delete the discount from that region's Affiliate shop.
Parameters
- Optionalparams: DeleteSipDiscountRequest
  Request parameters
Returns Promise<DeleteSipDiscountResponse>
Promise resolving to the response
- Defined in src/managers/discount.manager.ts:102

endDiscount

endDiscount(params?: EndDiscountRequest): Promise<EndDiscountResponse>
Use this api to end shop discount activity
Parameters
- Optionalparams: EndDiscountRequest
  Request parameters
Returns Promise<EndDiscountResponse>
Promise resolving to the response
- Defined in src/managers/discount.manager.ts:121

getDiscount

getDiscount(params?: GetDiscountRequest): Promise<GetDiscountResponse>
Use this api to get one shop discount activity detail
Parameters
- Optionalparams: GetDiscountRequest
  Request parameters
Returns Promise<GetDiscountResponse>
Promise resolving to the response
- Defined in src/managers/discount.manager.ts:135

getDiscountList

getDiscountList(
params?: GetDiscountListRequest,
): Promise<GetDiscountListResponse>
Use this api to get shop discount activity list
Parameters
- Optionalparams: GetDiscountListRequest
  Request parameters
Returns Promise<GetDiscountListResponse>
Promise resolving to the response
- Defined in src/managers/discount.manager.ts:149

getSipDiscounts

getSipDiscounts(
params?: GetSipDiscountsRequest,
): Promise<GetSipDiscountsResponse>
Get SIP Overseas Discounts. Only regions that have upcoming/ongoing discounts will be returned. Please 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.
Parameters
- Optionalparams: GetSipDiscountsRequest
  Request parameters
Returns Promise<GetSipDiscountsResponse>
Promise resolving to the response
- Defined in src/managers/discount.manager.ts:168

setSipDiscount

setSipDiscount(params?: SetSipDiscountRequest): Promise<SetSipDiscountResponse>
Set SIP Overseas Discount for SIP affiliate region. Please use Primary shop's Shop ID to request, and 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.
Parameters
- Optionalparams: SetSipDiscountRequest
  Request parameters
Returns Promise<SetSipDiscountResponse>
Promise resolving to the response
- Defined in src/managers/discount.manager.ts:187

updateDiscount

updateDiscount(params?: UpdateDiscountRequest): Promise<UpdateDiscountResponse>
Use this api to update one discount information
Parameters
- Optionalparams: UpdateDiscountRequest
  Request parameters
Returns Promise<UpdateDiscountResponse>
Promise resolving to the response
- Defined in src/managers/discount.manager.ts:206

updateDiscountItem

updateDiscountItem(
params?: UpdateDiscountItemRequest,
): Promise<UpdateDiscountItemResponse>
Use this api to update items of the discount promotion.
Parameters
- Optionalparams: UpdateDiscountItemRequest
  Request parameters
Returns Promise<UpdateDiscountItemResponse>
Promise resolving to the response
- Defined in src/managers/discount.manager.ts:220

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

Returns Promise<GetDiscountResponse>

getDiscountList

Parameters

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