Class PublicManager

Hierarchy (View Summary)

BaseManager
- PublicManager

Index

Constructors

Properties

Methods

getAccessToken getMerchantsByPartner getShopeeIpRanges getShopsByPartner getTokenByResendCode refreshAccessToken

Constructors

constructor

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

Properties

`Protected`config

config: ShopeeConfig

Methods

getAccessToken

getAccessToken(params?: GetAccessTokenRequest): Promise<GetAccessTokenResponse>
Use the code from the authorization step to call this API to obtain the authorized shop_id, merchant_id, supplier_id, or user_id, and its corresponding access_token and refresh_token.
Parameters
- Optionalparams: GetAccessTokenRequest
  Request parameters
Returns Promise<GetAccessTokenResponse>
Promise resolving to the response
- Defined in src/managers/public.manager.ts:30

getMerchantsByPartner

getMerchantsByPartner(
params?: GetMerchantsByPartnerRequest,
): Promise<GetMerchantsByPartnerResponse>
Use this API to get basic info of merchants which have authorized to the partner.
Parameters
- Optionalparams: GetMerchantsByPartnerRequest
  Request parameters
Returns Promise<GetMerchantsByPartnerResponse>
Promise resolving to the response
- Defined in src/managers/public.manager.ts:43

getShopeeIpRanges

getShopeeIpRanges(
params?: GetShopeeIpRangesRequest,
): Promise<GetShopeeIpRangesResponse>
You can get shopee ip address ranges through this open api.
Parameters
- Optionalparams: GetShopeeIpRangesRequest
  Request parameters
Returns Promise<GetShopeeIpRangesResponse>
Promise resolving to the response
- Defined in src/managers/public.manager.ts:62

getShopsByPartner

getShopsByPartner(
params?: GetShopsByPartnerRequest,
): Promise<GetShopsByPartnerResponse>
get basic info of shops which have authorized to the partner.
Parameters
- Optionalparams: GetShopsByPartnerRequest
  Request parameters
Returns Promise<GetShopsByPartnerResponse>
Promise resolving to the response
- Defined in src/managers/public.manager.ts:80

getTokenByResendCode

getTokenByResendCode(
params?: GetTokenByResendCodeRequest,
): Promise<GetTokenByResendCodeResponse>
Use the resend code to get access token and refresh token. When you lost your access token or refresh token, you can go to authorization management page to resend code by yourselves. You can only use this endpoint in live environment, we don't support in test-stable environment.
Parameters
- Optionalparams: GetTokenByResendCodeRequest
  Request parameters
Returns Promise<GetTokenByResendCodeResponse>
Promise resolving to the response
- Defined in src/managers/public.manager.ts:99

refreshAccessToken

refreshAccessToken(
params?: RefreshAccessTokenRequest,
): Promise<RefreshAccessTokenResponse>
Use this API to refresh the access_token after it expires. Refresh_token can be used once only, this API will also return a new refresh_token. Please use the new refresh_token for the next RefreshAccessToken call
Parameters
- Optionalparams: RefreshAccessTokenRequest
  Request parameters
Returns Promise<RefreshAccessTokenResponse>
Promise resolving to the response
- Defined in src/managers/public.manager.ts:117