Class GlobalProductManager

Hierarchy (View Summary)

BaseManager
- GlobalProductManager

Constructors

constructor

new GlobalProductManager(config: ShopeeConfig): GlobalProductManager
Parameters
- config: ShopeeConfig
Returns GlobalProductManager
Overrides BaseManager.constructor
- Defined in src/managers/global-product.manager.ts:77

Properties

`Protected`config

config: ShopeeConfig

Methods

addGlobalItem

addGlobalItem(params?: AddGlobalItemRequest): Promise<AddGlobalItemResponse>
Add global item. Only for China mainland sellers using China Seller Centre(CNSC). More details in https://shopee.cn/cooperate/46/53/926.
Parameters
- Optionalparams: AddGlobalItemRequest
  Request parameters
Returns Promise<AddGlobalItemResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:86

addGlobalModel

addGlobalModel(params?: AddGlobalModelRequest): Promise<AddGlobalModelResponse>
Add global model. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: AddGlobalModelRequest
  Request parameters
Returns Promise<AddGlobalModelResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:103

categoryRecommend

categoryRecommend(
params?: CategoryRecommendRequest,
): Promise<CategoryRecommendResponse>
Recommend category by item name. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: CategoryRecommendRequest
  Request parameters
Returns Promise<CategoryRecommendResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:120

createPublishTask

createPublishTask(
params?: CreatePublishTaskRequest,
): Promise<CreatePublishTaskResponse>
Create publish task for global item. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: CreatePublishTaskRequest
  Request parameters
Returns Promise<CreatePublishTaskResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:139

deleteGlobalItem

deleteGlobalItem(
params?: DeleteGlobalItemRequest,
): Promise<DeleteGlobalItemResponse>
Delete global item. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: DeleteGlobalItemRequest
  Request parameters
Returns Promise<DeleteGlobalItemResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:158

deleteGlobalModel

deleteGlobalModel(
params?: DeleteGlobalModelRequest,
): Promise<DeleteGlobalModelResponse>
Delete global model. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: DeleteGlobalModelRequest
  Request parameters
Returns Promise<DeleteGlobalModelResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:177

getAttributeTree

getAttributeTree(
params?: GetAttributeTreeRequest,
): Promise<GetAttributeTreeResponse>
Get the mtsku attribute trees for categories
Parameters
- Optionalparams: GetAttributeTreeRequest
  Request parameters
Returns Promise<GetAttributeTreeResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:196

getBrandList

getBrandList(params?: GetBrandListRequest): Promise<GetBrandListResponse>
Use this call to get a list of brand. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: GetBrandListRequest
  Request parameters
Returns Promise<GetBrandListResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:215

getCategory

getCategory(params?: GetCategoryRequest): Promise<GetCategoryResponse>
Get global category. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: GetCategoryRequest
  Request parameters
Returns Promise<GetCategoryResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:228

getGlobalItemId

getGlobalItemId(
params?: GetGlobalItemIdRequest,
): Promise<GetGlobalItemIdResponse>
Get get_global_item_id by item_id. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: GetGlobalItemIdRequest
  Request parameters
Returns Promise<GetGlobalItemIdResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:241

getGlobalItemInfo

getGlobalItemInfo(
params?: GetGlobalItemInfoRequest,
): Promise<GetGlobalItemInfoResponse>
Get global item info.Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: GetGlobalItemInfoRequest
  Request parameters
Returns Promise<GetGlobalItemInfoResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:258

getGlobalItemLimit

getGlobalItemLimit(
params?: GetGlobalItemLimitRequest,
): Promise<GetGlobalItemLimitResponse>
Get global item upload control.
Parameters
- Optionalparams: GetGlobalItemLimitRequest
  Request parameters
Returns Promise<GetGlobalItemLimitResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:281

getGlobalItemList

getGlobalItemList(
params?: GetGlobalItemListRequest,
): Promise<GetGlobalItemListResponse>
Get global item id list. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: GetGlobalItemListRequest
  Request parameters
Returns Promise<GetGlobalItemListResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:300

getGlobalModelList

getGlobalModelList(
params?: GetGlobalModelListRequest,
): Promise<GetGlobalModelListResponse>
Get global model list. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: GetGlobalModelListRequest
  Request parameters
Returns Promise<GetGlobalModelListResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:324

getLocalAdjustmentRate

getLocalAdjustmentRate(
params?: GetLocalAdjustmentRateRequest,
): Promise<GetLocalAdjustmentRateResponse>
Retrieves the adjustment rate that converts CB stock price into local-warehouse price for a specific shop.
Parameters
- Optionalparams: GetLocalAdjustmentRateRequest
  Request parameters
Returns Promise<GetLocalAdjustmentRateResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:343

getPublishableShop

getPublishableShop(
params?: GetPublishableShopRequest,
): Promise<GetPublishableShopResponse>
Get publishable shop list for global item. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: GetPublishableShopRequest
  Request parameters
Returns Promise<GetPublishableShopResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:381

getPublishedList

getPublishedList(
params?: GetPublishedListRequest,
): Promise<GetPublishedListResponse>
Get published item list of global item. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: GetPublishedListRequest
  Request parameters
Returns Promise<GetPublishedListResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:400

getPublishTaskResult

getPublishTaskResult(
params?: GetPublishTaskResultRequest,
): Promise<GetPublishTaskResultResponse>
Get publish task result for global item. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: GetPublishTaskResultRequest
  Request parameters
Returns Promise<GetPublishTaskResultResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:362

getRecommendAttribute

getRecommendAttribute(
params?: GetRecommendAttributeRequest,
): Promise<GetRecommendAttributeResponse>
Get recommend attributes. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: GetRecommendAttributeRequest
  Request parameters
Returns Promise<GetRecommendAttributeResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:419

getShopPublishableStatus

getShopPublishableStatus(
params?: GetShopPublishableStatusRequest,
): Promise<GetShopPublishableStatusResponse>
Get publishable shop list for global item in pages.
Parameters
- Optionalparams: GetShopPublishableStatusRequest
  Request parameters
Returns Promise<GetShopPublishableStatusResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:438

getSizeChartDetail

getSizeChartDetail(
params?: GetSizeChartDetailRequest,
): Promise<GetSizeChartDetailResponse>
Get new size chart detail
Parameters
- Optionalparams: GetSizeChartDetailRequest
  Request parameters
Returns Promise<GetSizeChartDetailResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:457

getSizeChartList

getSizeChartList(
params?: GetSizeChartListRequest,
): Promise<GetSizeChartListResponse>
Get size chart list
Parameters
- Optionalparams: GetSizeChartListRequest
  Request parameters
Returns Promise<GetSizeChartListResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:476

getVariations

getVariations(params?: GetVariationsRequest): Promise<GetVariationsResponse>
Get the standardized tier variation defined by Shopee, which is currently a three-layer tree structure. The top layer is variations, the second layer is groups, groups are used to divide options, and the third layer is options.
Parameters
- Optionalparams: GetVariationsRequest
  Request parameters
Returns Promise<GetVariationsResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:495

initTierVariation

initTierVariation(
params?: InitTierVariationRequest,
): Promise<InitTierVariationResponse>
Only for China mainland sellers and Korean sellers. If you only define color, it is one tier, if you define color and size, it is two tier. Support two tier structures at most. This API can change no tier to one tier, no tier to two tier, one tier to two tier, two tier to one tier, one tier to no tier, two tier to no tier. Please create variants after an interval of 5 seconds after creating an item, as there may be a delay.
Parameters
- Optionalparams: InitTierVariationRequest
  Request parameters
Returns Promise<InitTierVariationResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:508

searchGlobalAttributeValueList

searchGlobalAttributeValueList(
params?: SearchGlobalAttributeValueListRequest,
): Promise<SearchGlobalAttributeValueListResponse>
this api is for searching attribute value list for attribute with support_search_value flag
Parameters
- Optionalparams: SearchGlobalAttributeValueListRequest
  Request parameters
Returns Promise<SearchGlobalAttributeValueListResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:527

setSyncField

setSyncField(params?: SetSyncFieldRequest): Promise<SetSyncFieldResponse>
Set auto sync field. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: SetSyncFieldRequest
  Request parameters
Returns Promise<SetSyncFieldResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:546

supportSizeChart

supportSizeChart(
params?: SupportSizeChartRequest,
): Promise<SupportSizeChartResponse>
Get category support size chart. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: SupportSizeChartRequest
  Request parameters
Returns Promise<SupportSizeChartResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:559

updateGlobalItem

updateGlobalItem(
params?: UpdateGlobalItemRequest,
): Promise<UpdateGlobalItemResponse>
Update global item. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: UpdateGlobalItemRequest
  Request parameters
Returns Promise<UpdateGlobalItemResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:578

updateGlobalModel

updateGlobalModel(
params?: UpdateGlobalModelRequest,
): Promise<UpdateGlobalModelResponse>
Update global model. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: UpdateGlobalModelRequest
  Request parameters
Returns Promise<UpdateGlobalModelResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:597

updateLocalAdjustmentRate

updateLocalAdjustmentRate(
params?: UpdateLocalAdjustmentRateRequest,
): Promise<UpdateLocalAdjustmentRateResponse>
A multiplier that automatically converts your CB stock price into the local-warehouse price. It ensures your local inventory prices reflect regional costs, currency factors, and margin targets.
Parameters
- Optionalparams: UpdateLocalAdjustmentRateRequest
  Request parameters
Returns Promise<UpdateLocalAdjustmentRateResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:616

updatePrice

updatePrice(params?: UpdatePriceRequest): Promise<UpdatePriceResponse>
Update global price. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: UpdatePriceRequest
  Request parameters
Returns Promise<UpdatePriceResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:635

updateSizeChart

updateSizeChart(
params?: UpdateSizeChartRequest,
): Promise<UpdateSizeChartResponse>
Update size chart for global item. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: UpdateSizeChartRequest
  Request parameters
Returns Promise<UpdateSizeChartResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:648

updateStock

updateStock(params?: UpdateStockRequest): Promise<UpdateStockResponse>
Update global stock. Only for China mainland sellers and Korean sellers.
Parameters
- Optionalparams: UpdateStockRequest
  Request parameters
Returns Promise<UpdateStockResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:665

updateTierVariation

updateTierVariation(
params?: UpdateTierVariationRequest,
): Promise<UpdateTierVariationResponse>
Update global product tier variation. Only for China mainland sellers and Korean sellers.This api can only be used without changing the tier structure, you can add options, delete options, and update the option image by this api.
Parameters
- Optionalparams: UpdateTierVariationRequest
  Request parameters
Returns Promise<UpdateTierVariationResponse>
Promise resolving to the response
- Defined in src/managers/global-product.manager.ts:678

Class GlobalProductManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GlobalProductManager

Properties

Protectedconfig

Methods

addGlobalItem

Parameters

Returns Promise<AddGlobalItemResponse>

addGlobalModel

Parameters

Returns Promise<AddGlobalModelResponse>

categoryRecommend

Parameters

Returns Promise<CategoryRecommendResponse>

createPublishTask

Parameters

Returns Promise<CreatePublishTaskResponse>

deleteGlobalItem

Parameters

Returns Promise<DeleteGlobalItemResponse>

deleteGlobalModel

Parameters

Returns Promise<DeleteGlobalModelResponse>

getAttributeTree

Parameters

Returns Promise<GetAttributeTreeResponse>

getBrandList

Parameters

Returns Promise<GetBrandListResponse>

getCategory

Parameters

Returns Promise<GetCategoryResponse>

getGlobalItemId

Parameters

Returns Promise<GetGlobalItemIdResponse>

getGlobalItemInfo

Parameters

Returns Promise<GetGlobalItemInfoResponse>

getGlobalItemLimit

Parameters

Returns Promise<GetGlobalItemLimitResponse>

getGlobalItemList

Parameters

Returns Promise<GetGlobalItemListResponse>

getGlobalModelList

Parameters

Returns Promise<GetGlobalModelListResponse>

getLocalAdjustmentRate

Parameters

Returns Promise<GetLocalAdjustmentRateResponse>

getPublishableShop

Parameters

Returns Promise<GetPublishableShopResponse>

getPublishedList

Parameters

Returns Promise<GetPublishedListResponse>

getPublishTaskResult

Parameters

Returns Promise<GetPublishTaskResultResponse>

getRecommendAttribute

Parameters

Returns Promise<GetRecommendAttributeResponse>

getShopPublishableStatus

Parameters

Returns Promise<GetShopPublishableStatusResponse>

getSizeChartDetail

Parameters

Returns Promise<GetSizeChartDetailResponse>

getSizeChartList

Parameters

Returns Promise<GetSizeChartListResponse>

getVariations

`Protected`config