Class ShopeeSDK

Constructors

constructor

new ShopeeSDK(config: ShopeeConfig, tokenStorage?: TokenStorage): ShopeeSDK
Parameters
- config: ShopeeConfig
- OptionaltokenStorage: TokenStorage
Returns ShopeeSDK
- Defined in src/sdk.ts:84

Properties

`Readonly`accountHealth

accountHealth: AccountHealthManager

`Readonly`addOnDeal

addOnDeal: AddOnDealManager

`Readonly`ads

ads: AdsManager

`Readonly`ams

ams: AmsManager

`Readonly`auth

auth: AuthManager

`Readonly`bundleDeal

bundleDeal: BundleDealManager

`Readonly`businessInsights

businessInsights: BusinessInsightsManager

`Readonly`buybox

buybox: BuyboxManager

`Readonly`discount

discount: DiscountManager

`Readonly`fbs

fbs: FbsManager

`Readonly`firstMile

firstMile: FirstMileManager

`Readonly`followPrize

followPrize: FollowPrizeManager

`Readonly`globalProduct

globalProduct: GlobalProductManager

`Readonly`livestream

livestream: LiveStreamManager

`Readonly`logistics

logistics: LogisticsManager

`Readonly`media

media: MediaManager

`Readonly`mediaSpace

mediaSpace: MediaSpaceManager

`Readonly`merchant

merchant: MerchantManager

`Readonly`order

order: OrderManager

`Readonly`payment

payment: PaymentManager

`Readonly`principal

principal: PrincipalManager

`Readonly`product

product: ProductManager

`Readonly`public

public: PublicManager

`Readonly`push

push: PushManager

`Readonly`returns

returns: ReturnsManager

`Readonly`sbs

sbs: SbsManager

`Readonly`shop

shop: ShopManager

`Readonly`shopCategory

shopCategory: ShopCategoryManager

`Readonly`shopFlashSale

shopFlashSale: ShopFlashSaleManager

`Readonly`topPicks

topPicks: TopPicksManager

`Readonly`video

video: VideoManager

`Readonly`voucher

voucher: VoucherManager

Methods

authenticateWithCode

authenticateWithCode(
    code: string,
    shopId?: number,
    mainAccountId?: number,
): Promise<AccessToken | null>
Parameters
- code: string
- OptionalshopId: number
- OptionalmainAccountId: number
Returns Promise<AccessToken | null>
- Defined in src/sdk.ts:172

getAuthorizationUrl

getAuthorizationUrl(
redirect_uri: string,
options?: { auth_type?: "seller" | "supplier" | "user"; state?: string },
): string
Parameters
- redirect_uri: string
- Optionaloptions: { auth_type?: "seller" | "supplier" | "user"; state?: string }
Returns string
- Defined in src/sdk.ts:151

getAuthToken

getAuthToken(): Promise<AccessToken | null>
Returns Promise<AccessToken | null>
- Defined in src/sdk.ts:181

getConfig

getConfig(): ShopeeConfig
Returns ShopeeConfig
- Defined in src/sdk.ts:132

refreshToken

refreshToken(
shop_id?: number,
merchant_id?: number,
): Promise<AccessToken | null>
Parameters
- Optionalshop_id: number
- Optionalmerchant_id: number
Returns Promise<AccessToken | null>
- Defined in src/sdk.ts:184

setBaseAuthUrl

setBaseAuthUrl(baseAuthUrl: string): void
Parameters
- baseAuthUrl: string
Returns void
- Defined in src/sdk.ts:144

setBaseUrl

setBaseUrl(baseUrl: string): void
Parameters
- baseUrl: string
Returns void
- Defined in src/sdk.ts:140

setFetchAgent

setFetchAgent(fetchAgent: Agent): void
Parameters
- fetchAgent: Agent
Returns void
- Defined in src/sdk.ts:148

setRegion

setRegion(region: ShopeeRegion): void
Parameters
- region: ShopeeRegion
Returns void
- Defined in src/sdk.ts:135