Class ShopeeSDK

constructor

• new ShopeeSDK(config: ShopeeConfig, tokenStorage?: TokenStorage): ShopeeSDK

  Parameters

  • config: ShopeeConfig
  • OptionaltokenStorage: TokenStorage

  Returns ShopeeSDK

ReadonlyaccountHealth

ReadonlyaddOnDeal

Readonlyads

Readonlyams

Readonlyauth

ReadonlybundleDeal

Readonlydiscount

Readonlyfbs

ReadonlyfirstMile

ReadonlyfollowPrize

ReadonlyglobalProduct

Readonlylivestream

Readonlylogistics

Readonlymedia

ReadonlymediaSpace

Readonlymerchant

Readonlyorder

Readonlypayment

Readonlyproduct

Readonlypublic

Readonlypush

Readonlyreturns

Readonlysbs

Readonlyshop

ReadonlyshopCategory

ReadonlyshopFlashSale

ReadonlytopPicks

Readonlyvideo

Readonlyvoucher

authenticateWithCode

• authenticateWithCode(
      code: string,
      shopId?: number,
      mainAccountId?: number,
  ): Promise<AccessToken | null>

  Parameters

  • code: string
  • OptionalshopId: number
  • OptionalmainAccountId: number

  Returns Promise<AccessToken | null>

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

getAuthToken

• getAuthToken(): Promise<AccessToken | null>

  Returns Promise<AccessToken | null>

getConfig

• getConfig(): ShopeeConfig

  Returns ShopeeConfig

refreshToken

• refreshToken(
      shop_id?: number,
      merchant_id?: number,
  ): Promise<AccessToken | null>

  Parameters

  • Optionalshop_id: number
  • Optionalmerchant_id: number

  Returns Promise<AccessToken | null>

setBaseAuthUrl

• setBaseAuthUrl(baseAuthUrl: string): void

  Parameters

  • baseAuthUrl: string

  Returns void

setBaseUrl

• setBaseUrl(baseUrl: string): void

  Parameters

  • baseUrl: string

  Returns void

setFetchAgent

• setFetchAgent(fetchAgent: Agent): void

  Parameters

  • fetchAgent: Agent

  Returns void

setRegion

• setRegion(region: ShopeeRegion): void

  Parameters

  • region: ShopeeRegion

  Returns void