Class ShopManager

Hierarchy (View Summary)

BaseManager
- ShopManager

Index

Constructors

Properties

Methods

getAuthorisedResellerBrand getBrShopOnboardingInfo getProfile getShopHolidayMode getShopInfo getShopNotification getWarehouseDetail setShopHolidayMode updateProfile

Constructors

constructor

new ShopManager(config: ShopeeConfig): ShopManager
Parameters
- config: ShopeeConfig
Returns ShopManager
Overrides BaseManager.constructor
- Defined in src/managers/shop.manager.ts:27

Properties

`Protected`config

config: ShopeeConfig

Methods

getAuthorisedResellerBrand

getAuthorisedResellerBrand(
params?: GetAuthorisedResellerBrandRequest,
): Promise<GetAuthorisedResellerBrandResponse>
Get the authorised reseller brand list for the shop.
Parameters
- Optionalparams: GetAuthorisedResellerBrandRequest
  Request parameters
Returns Promise<GetAuthorisedResellerBrandResponse>
Promise resolving to the response
- Defined in src/managers/shop.manager.ts:36

getBrShopOnboardingInfo

getBrShopOnboardingInfo(
params?: GetBrShopOnboardingInfoRequest,
): Promise<GetBrShopOnboardingInfoResponse>
[For BR Shop Only] Use this API to get shop KYC registration and qualification information.
Parameters
- Optionalparams: GetBrShopOnboardingInfoRequest
  Request parameters
Returns Promise<GetBrShopOnboardingInfoResponse>
Promise resolving to the response
- Defined in src/managers/shop.manager.ts:55

getProfile

getProfile(params?: GetProfileRequest): Promise<GetProfileResponse>
This API support to get information of shop.
Parameters
- Optionalparams: GetProfileRequest
  Request parameters
Returns Promise<GetProfileResponse>
Promise resolving to the response
- Defined in src/managers/shop.manager.ts:74

getShopHolidayMode

getShopHolidayMode(
params?: GetShopHolidayModeRequest,
): Promise<GetShopHolidayModeResponse>
Use this API to check whether a shop has enabled holiday mode and its ongoing and upcoming holiday mode period.
Parameters
- Optionalparams: GetShopHolidayModeRequest
  Request parameters
Returns Promise<GetShopHolidayModeResponse>
Promise resolving to the response
- Defined in src/managers/shop.manager.ts:87

getShopInfo

getShopInfo(params?: GetShopInfoRequest): Promise<GetShopInfoResponse>
Use this call to get information of shop
Parameters
- Optionalparams: GetShopInfoRequest
  Request parameters
Returns Promise<GetShopInfoResponse>
Promise resolving to the response
- Defined in src/managers/shop.manager.ts:111

getShopNotification

getShopNotification(
params?: GetShopNotificationRequest,
): Promise<GetShopNotificationResponse>
get Seller Center notification, the permission is controlled by App type
Parameters
- Optionalparams: GetShopNotificationRequest
  Request parameters
Returns Promise<GetShopNotificationResponse>
Promise resolving to the response
- Defined in src/managers/shop.manager.ts:125

getWarehouseDetail

getWarehouseDetail(
params?: GetWarehouseDetailRequest,
): Promise<GetWarehouseDetailResponse>
For given shop id and region, return warehouse info including warehouse id, address id and location id, return all warehouse with once call.
Parameters
- Optionalparams: GetWarehouseDetailRequest
  Request parameters
Returns Promise<GetWarehouseDetailResponse>
Promise resolving to the response
- Defined in src/managers/shop.manager.ts:144

setShopHolidayMode

setShopHolidayMode(
params?: SetShopHolidayModeRequest,
): Promise<SetShopHolidayModeResponse>
Use this API to set holiday periods in advance for automatic on/off of holiday mode and there are two holiday modes allowing sellers to choose whether to accept new orders during holiday.
Parameters
- Optionalparams: SetShopHolidayModeRequest
  Request parameters
Returns Promise<SetShopHolidayModeResponse>
Promise resolving to the response
- Defined in src/managers/shop.manager.ts:163

updateProfile

updateProfile(params?: UpdateProfileRequest): Promise<UpdateProfileResponse>
This API support to let sellers to update the shop name, shop logo, and shop description.
Parameters
- Optionalparams: UpdateProfileRequest
  Request parameters
Returns Promise<UpdateProfileResponse>
Promise resolving to the response
- Defined in src/managers/shop.manager.ts:183

Class ShopManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ShopManager

Properties

Protectedconfig

Methods

getAuthorisedResellerBrand

Parameters

Returns Promise<GetAuthorisedResellerBrandResponse>

getBrShopOnboardingInfo

Parameters

Returns Promise<GetBrShopOnboardingInfoResponse>

getProfile

Parameters

Returns Promise<GetProfileResponse>

getShopHolidayMode

Parameters

Returns Promise<GetShopHolidayModeResponse>

getShopInfo

Parameters

Returns Promise<GetShopInfoResponse>

getShopNotification

Parameters

Returns Promise<GetShopNotificationResponse>

getWarehouseDetail

Parameters

Returns Promise<GetWarehouseDetailResponse>

setShopHolidayMode

Parameters

Returns Promise<SetShopHolidayModeResponse>

updateProfile

Parameters

Returns Promise<UpdateProfileResponse>

Settings

On This Page

`Protected`config