Class SbsManager

Hierarchy (View Summary)

BaseManager
- SbsManager

Index

Constructors

constructor

new SbsManager(config: ShopeeConfig): SbsManager
Parameters
- config: ShopeeConfig
Returns SbsManager
Overrides BaseManager.constructor
- Defined in src/managers/sbs.manager.ts:18

Properties

`Protected`config

config: ShopeeConfig

Methods

getBoundWhsInfo

getBoundWhsInfo(
params?: GetBoundWhsInfoParams,
): Promise<GetBoundWhsInfoResponse>
Get bound warehouse by shop id.
Parameters
- params: GetBoundWhsInfoParams = {}
  Parameters for getting bound warehouse info (empty object)
Returns Promise<GetBoundWhsInfoResponse>
A promise that resolves to the bound warehouse info response containing:
- list: List of shops with bound warehouses
Throws
When the API request fails or returns an error
- Defined in src/managers/sbs.manager.ts:32

getCurrentInventory

getCurrentInventory(
params: GetCurrentInventoryParams,
): Promise<GetCurrentInventoryResponse>
Get Seller Center Current Inventory Page Data. This API provides detailed inventory information including sellable, reserved, and unsellable quantities across different warehouses.
Parameters
- params: GetCurrentInventoryParams
  Parameters for getting current inventory
  
  Parameters for getting current inventory
  - Optionalcategory_id?: number
    Category id (first-tier)
  - Optionalinbound_pending_approval?: number
    Inbound pending approval: Blank=All; 0=No; 1=Yes
  - Optionalkeyword?: string
    Bind value and search_type
  - Optionalnot_moving_tag?: number
    Not moving tag: Blank=All; 0=No; 1=Yes
  - Optionalpage_no?: number
    Page number (default: 1)
  - Optionalpage_size?: number
    Page size, 1-100 (default: 10)
  - Optionalproducts_with_inventory?: number
    Products with inventory: Blank=All; 0=No; 1=Yes
  - Optionalsearch_type?: number
    Search type: 0=All data; 1=Product Name; 2=SKU ID; 3=Variations; 4=Item ID
  - Optionalstock_levels?: string
    Stock levels: 1=Low Stock & No Sellable stock; 2=Low Stock & To replenish; 3=Low Stock & Replenished; 4=Excess
  - Optionalwhs_ids?: string
    Whs ID list, comma-separated
  - whs_region: string
    Warehouse region (required): BR, CN, ID, MY, MX, TH, TW, PH, VN, SG
Returns Promise<GetCurrentInventoryResponse>
A promise that resolves to the current inventory response containing:
- cursor: Pagination cursor
- item_list: List of items with inventory details
Throws
When the API request fails or returns an error
- Defined in src/managers/sbs.manager.ts:69

getExpiryReport

getExpiryReport(params: GetExpiryReportParams): Promise<GetExpiryReportResponse>
Get Seller Center Expiry Report page data. This API provides information about expiring, expired, and damaged stocks.
Parameters
- params: GetExpiryReportParams
  Parameters for getting expiry report
  
  Parameters for getting expiry report
  - Optionalcategory_id_l1?: number
    Only Level 1 Category can be filtered
  - Optionalexpiry_status?: string
    Expiry status: 0=Expired, 2=Expiring, 4=expiry_blocked, 5=damaged, 6=normal (comma-separated)
  - Optionalitem_id?: string
    Item ID
  - Optionalitem_name?: string
    Item name
  - Optionalpage_no?: number
    Page number (default: 1)
  - Optionalpage_size?: number
    Page size, 1-40 (default: 10)
  - Optionalsku_id?: string
    SKU ID
  - Optionalvariation?: string
    Variation
  - Optionalwhs_ids?: string
    Whs IDs, comma-separated
  - whs_region: string
    Warehouse region (required): BR, CN, ID, MY, MX, TH, TW, PH, VN, SG
Returns Promise<GetExpiryReportResponse>
A promise that resolves to the expiry report response containing:
- item_list: List of items with expiry information
Throws
When the API request fails or returns an error
- Defined in src/managers/sbs.manager.ts:108

getStockAging

getStockAging(params: GetStockAgingParams): Promise<GetStockAgingResponse>
Get Seller Center Stock Aging page data. This API provides stock aging information showing how long items have been in stock.
Parameters
- params: GetStockAgingParams
  Parameters for getting stock aging
  
  Parameters for getting stock aging
  - Optionalaging_storage_tag?: number
    Aging storage tag: 0=false; 1=true
  - Optionalcategory_id?: number
    L1-level product category ID
  - Optionalexcess_storage_tag?: number
    Excess storage tag: 0=false; 1=true
  - Optionalkeyword?: string
    Bound with search_type
  - Optionalpage_no?: number
    Page number (default: 1)
  - Optionalpage_size?: number
    Page size, 1-100 (default: 10)
  - Optionalsearch_type?: number
    Search type: 1=Product Name; 2=SKU ID; 3=Variations; 4=Item ID
  - Optionalwhs_ids?: string
    Whs IDs, comma-separated
  - whs_region: string
    Warehouse region (required): BR, CN, ID, MY, MX, TH, TW, PH, VN, SG
Returns Promise<GetStockAgingResponse>
A promise that resolves to the stock aging response containing:
- item_list: List of items with stock aging details
Throws
When the API request fails or returns an error
- Defined in src/managers/sbs.manager.ts:144

getStockMovement

getStockMovement(
params: GetStockMovementParams,
): Promise<GetStockMovementResponse>
Get Seller Center Stock Movement page data. This API provides stock movement information including inbound, outbound, and adjustments.
Parameters
- params: GetStockMovementParams
  Parameters for getting stock movement
  
  Parameters for getting stock movement
  - Optionalcategory_id_l1?: number
    L1-level category_id
  - end_time: string
    End date in YYYY-MM-DD format (required)
  - Optionalitem_id?: string
    Item ID
  - Optionalitem_name?: string
    Item name
  - Optionalpage_no?: number
    Page number (default: 1)
  - Optionalpage_size?: number
    Page size, 1-20 (default: 10)
  - Optionalsku_id?: string
    SKU ID
  - start_time: string
    Start date in YYYY-MM-DD format (required)
  - Optionalvariation?: string
    Variation
  - Optionalwhs_ids?: string
    Whs IDs, comma-separated
  - whs_region: string
    Warehouse region (required): BR, CN, ID, MY, MX, TH, TW, PH, VN, SG
Returns Promise<GetStockMovementResponse>
A promise that resolves to the stock movement response containing:
- total: Total number of items
- start_time: Start time
- end_time: End time
- query_end_time: Query end time
- item_list: List of items with stock movement details
Throws
When the API request fails or returns an error
- Defined in src/managers/sbs.manager.ts:186

Class SbsManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SbsManager

Properties

Protectedconfig

Methods

getBoundWhsInfo

Parameters

Returns Promise<GetBoundWhsInfoResponse>

Throws

getCurrentInventory

Parameters

Optionalcategory_id?: number

Optionalinbound_pending_approval?: number

Optionalkeyword?: string

Optionalnot_moving_tag?: number

Optionalpage_no?: number

Optionalpage_size?: number

Optionalproducts_with_inventory?: number

Optionalsearch_type?: number

Optionalstock_levels?: string

Optionalwhs_ids?: string

whs_region: string

Returns Promise<GetCurrentInventoryResponse>

Throws

getExpiryReport

Parameters

Optionalcategory_id_l1?: number

Optionalexpiry_status?: string

Optionalitem_id?: string

Optionalitem_name?: string

Optionalpage_no?: number

Optionalpage_size?: number

Optionalsku_id?: string

Optionalvariation?: string

Optionalwhs_ids?: string

whs_region: string

Returns Promise<GetExpiryReportResponse>

Throws

getStockAging

Parameters

Optionalaging_storage_tag?: number

Optionalcategory_id?: number

Optionalexcess_storage_tag?: number

Optionalkeyword?: string

Optionalpage_no?: number

Optionalpage_size?: number

Optionalsearch_type?: number

Optionalwhs_ids?: string

whs_region: string

Returns Promise<GetStockAgingResponse>

Throws

getStockMovement

Parameters

Optionalcategory_id_l1?: number

end_time: string

Optionalitem_id?: string

Optionalitem_name?: string

Optionalpage_no?: number

Optionalpage_size?: number

Optionalsku_id?: string

start_time: string

Optionalvariation?: string

Optionalwhs_ids?: string

whs_region: string

Returns Promise<GetStockMovementResponse>

Throws

Settings

On This Page

`Protected`config

`Optional`category_id?: number

`Optional`inbound_pending_approval?: number

`Optional`keyword?: string

`Optional`not_moving_tag?: number

`Optional`page_no?: number

`Optional`page_size?: number

`Optional`products_with_inventory?: number

`Optional`search_type?: number

`Optional`stock_levels?: string

`Optional`whs_ids?: string

`Optional`category_id_l1?: number

`Optional`expiry_status?: string

`Optional`item_id?: string

`Optional`item_name?: string

`Optional`page_no?: number

`Optional`page_size?: number

`Optional`sku_id?: string

`Optional`variation?: string

`Optional`whs_ids?: string

`Optional`aging_storage_tag?: number

`Optional`category_id?: number

`Optional`excess_storage_tag?: number

`Optional`keyword?: string

`Optional`page_no?: number

`Optional`page_size?: number

`Optional`search_type?: number

`Optional`whs_ids?: string

`Optional`category_id_l1?: number

`Optional`item_id?: string

`Optional`item_name?: string

`Optional`page_no?: number

`Optional`page_size?: number

`Optional`sku_id?: string

`Optional`variation?: string

`Optional`whs_ids?: string