Shopee SDK API Reference - v2.14.1
    Preparing search index...

    Class ShopeeSDK

    Index
    accountHealth: AccountHealthManager
    addOnDeal: AddOnDealManager
    bundleDeal: BundleDealManager
    businessInsights: BusinessInsightsManager
    discount: DiscountManager
    firstMile: FirstMileManager
    followPrize: FollowPrizeManager
    globalProduct: GlobalProductManager
    installation: InstallationManager
    livestream: LiveStreamManager
    logistics: LogisticsManager
    mediaSpace: MediaSpaceManager
    merchant: MerchantManager
    principal: PrincipalManager
    shopCategory: ShopCategoryManager
    shopFlashSale: ShopFlashSaleManager
    topPicks: TopPicksManager
    • Store a token for a shop or selected user; a single returned user is selected automatically.

      Parameters

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

      Returns Promise<AccessToken | null>

    • Parameters

      • redirect_uri: string
      • Optionaloptions: { auth_type?: "user" | "seller" | "supplier"; state?: string }

      Returns string

    • Refresh the stored token. Concurrent calls with the same arguments share one request; calls with different arguments run one after another, because Shopee refresh tokens are single-use and every refresh rotates the stored refresh_token.

      Parameters

      • Optionalshop_id: number
      • Optionalmerchant_id: number
      • Optionaluser_id: number
      • Optionalprincipal_id: number

      Returns Promise<AccessToken | null>

    • Parameters

      • baseAuthUrl: string

      Returns void

    • Parameters

      • baseUrl: string

      Returns void

    • Parameters

      • fetchAgent: Agent

      Returns void