Class AccountHealthManager

Hierarchy (View Summary)

BaseManager
- AccountHealthManager

Index

Constructors

Properties

Methods

getLateOrders getListingsWithIssues getMetricSourceDetail getPenaltyPointHistory getPunishmentHistory getShopPerformance

Constructors

constructor

new AccountHealthManager(config: ShopeeConfig): AccountHealthManager
Parameters
- config: ShopeeConfig
Returns AccountHealthManager
Overrides BaseManager.constructor
- Defined in src/managers/account-health.manager.ts:21

Properties

`Protected`config

config: ShopeeConfig

Methods

getLateOrders

getLateOrders(params?: GetLateOrdersRequest): Promise<GetLateOrdersResponse>
Get the Late Orders to take action to avoid order cancellation and penalty points.
Parameters
- Optionalparams: GetLateOrdersRequest
  Request parameters
Returns Promise<GetLateOrdersResponse>
Promise resolving to the response
- Defined in src/managers/account-health.manager.ts:30

getListingsWithIssues

getListingsWithIssues(
params?: GetListingsWithIssuesRequest,
): Promise<GetListingsWithIssuesResponse>
Get the Problematic Listings to improve the listings to avoid incurring penalty points.
Parameters
- Optionalparams: GetListingsWithIssuesRequest
  Request parameters
Returns Promise<GetListingsWithIssuesResponse>
Promise resolving to the response
- Defined in src/managers/account-health.manager.ts:48

getMetricSourceDetail

getMetricSourceDetail(
params?: GetMetricSourceDetailRequest,
): Promise<GetMetricSourceDetailResponse>
Get the Affected Orders / Relevant Listings / Relevant Violations details of metrics.
Parameters
- Optionalparams: GetMetricSourceDetailRequest
  Request parameters
Returns Promise<GetMetricSourceDetailResponse>
Promise resolving to the response
- Defined in src/managers/account-health.manager.ts:67

getPenaltyPointHistory

getPenaltyPointHistory(
params?: GetPenaltyPointHistoryRequest,
): Promise<GetPenaltyPointHistoryResponse>
Get the penalty point records generated in the current quarter.
Parameters
- Optionalparams: GetPenaltyPointHistoryRequest
  Request parameters
Returns Promise<GetPenaltyPointHistoryResponse>
Promise resolving to the response
- Defined in src/managers/account-health.manager.ts:107

getPunishmentHistory

getPunishmentHistory(
params?: GetPunishmentHistoryRequest,
): Promise<GetPunishmentHistoryResponse>
Get the punishment records generated in the current quarter.
Parameters
- Optionalparams: GetPunishmentHistoryRequest
  Request parameters
Returns Promise<GetPunishmentHistoryResponse>
Promise resolving to the response
- Defined in src/managers/account-health.manager.ts:127

getShopPerformance

getShopPerformance(
params?: GetShopPerformanceRequest,
): Promise<GetShopPerformanceResponse>
The data metrics of shop performance.
Parameters
- Optionalparams: GetShopPerformanceRequest
  Request parameters
Returns Promise<GetShopPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/account-health.manager.ts:151