@congminh1254/shopee-sdk 0.7.0 → 0.8.0

package/lib/managers/product.manager.d.ts

@@ -1,6 +1,6 @@
 import { BaseManager } from "./base.manager.js";
 import { ShopeeConfig } from "../sdk.js";
-import { GetCommentParams, GetCommentResponse, ReplyCommentParams, ReplyCommentResponse, GetItemListParams, GetItemListResponse, GetItemBaseInfoParams, GetItemBaseInfoResponse } from "../schemas/product.js";
+import { GetCommentParams, GetCommentResponse, ReplyCommentParams, ReplyCommentResponse, GetItemListParams, GetItemListResponse, GetItemBaseInfoParams, GetItemBaseInfoResponse, GetModelListParams, GetModelListResponse } from "../schemas/product.js";
 export declare class ProductManager extends BaseManager {
     constructor(config: ShopeeConfig);
     /**
@@ -111,4 +111,23 @@ export declare class ProductManager extends BaseManager {
      * - error_query_over_itemid_size: Too many item_ids in list
      */
     getItemBaseInfo(params: GetItemBaseInfoParams): Promise<GetItemBaseInfoResponse>;
+    /**
+     * Get model list of an item
+     *
+     * Use this API to get model list of an item.
+     *
+     * @param params - The parameters for getting the model list
+     * @param params.item_id - The ID of the item
+     *
+     * @returns A promise that resolves to the model list response containing:
+     * - tier_variation: Variation config of item with option_list and name
+     * - model: List of model information including price_info, model_id, tier_index, model_sku, model_status, etc.
+     * - standardise_tier_variation: Standardise variation config of item (if available)
+     *
+     * @throws {Error} When the API request fails or returns an error:
+     * - error_item_not_found: Item_id is not found
+     * - error_param_shop_id_not_found: Shop_id is not found
+     * - error_item_not_found: Product not found
+     */
+    getModelList(params: GetModelListParams): Promise<GetModelListResponse>;
 }

package/lib/managers/product.manager.js

@@ -143,5 +143,31 @@ export class ProductManager extends BaseManager {
         });
         return response;
     }
+    /**
+     * Get model list of an item
+     *
+     * Use this API to get model list of an item.
+     *
+     * @param params - The parameters for getting the model list
+     * @param params.item_id - The ID of the item
+     *
+     * @returns A promise that resolves to the model list response containing:
+     * - tier_variation: Variation config of item with option_list and name
+     * - model: List of model information including price_info, model_id, tier_index, model_sku, model_status, etc.
+     * - standardise_tier_variation: Standardise variation config of item (if available)
+     *
+     * @throws {Error} When the API request fails or returns an error:
+     * - error_item_not_found: Item_id is not found
+     * - error_param_shop_id_not_found: Shop_id is not found
+     * - error_item_not_found: Product not found
+     */
+    async getModelList(params) {
+        const response = await ShopeeFetch.fetch(this.config, "/product/get_model_list", {
+            method: "GET",
+            auth: true,
+            params,
+        });
+        return response;
+    }
 }
 //# sourceMappingURL=product.manager.js.map

package/lib/managers/product.manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"product.manager.js","sourceRoot":"","sources":["../../src/managers/product.manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAY1C,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,UAAU,CAAC,MAAwB;QACvC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,sBAAsB,EACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wBAAwB,EACxB;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,WAAW,CAAC,MAAyB;QACzC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wBAAwB,EACxB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,eAAe,CAAC,MAA6B;QACjD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,6BAA6B,EAC7B;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE;gBACN,GAAG,MAAM;gBACT,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;aAC5C;SACF,CACF,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
+{"version":3,"file":"product.manager.js","sourceRoot":"","sources":["../../src/managers/product.manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAc1C,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,UAAU,CAAC,MAAwB;QACvC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,sBAAsB,EACtB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wBAAwB,EACxB;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,WAAW,CAAC,MAAyB;QACzC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wBAAwB,EACxB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,eAAe,CAAC,MAA6B;QACjD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,6BAA6B,EAC7B;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE;gBACN,GAAG,MAAM;gBACT,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;aAC5C;SACF,CACF,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,yBAAyB,EACzB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/lib/schemas/product.d.ts

@@ -602,3 +602,154 @@ export interface GetItemBaseInfoResponse extends BaseResponse {
         tax_info?: TaxInfo;
     };
 }
+/**
+ * Parameters for getting model list of an item
+ */
+export type GetModelListParams = {
+    /** The ID of the item */
+    item_id: number;
+};
+/**
+ * Option information in variation
+ */
+export interface VariationOption {
+    /** Option name */
+    option: string;
+    /** Image information for the option */
+    image?: {
+        /** Id of image */
+        image_id?: string;
+        /** Url of image */
+        image_url?: string;
+    };
+}
+/**
+ * Tier variation information
+ */
+export interface TierVariation {
+    /** List of options for this variation */
+    option_list: VariationOption[];
+    /** Variation name */
+    name: string;
+}
+/**
+ * Model price information
+ */
+export interface ModelPriceInfo {
+    /** Currency for the item price */
+    currency?: string;
+    /** Current price of item */
+    current_price: number;
+    /** Original price of item */
+    original_price: number;
+    /** Original price of item after tax */
+    inflated_price_of_original_price: number;
+    /** Current price of item after tax */
+    inflated_price_of_current_price: number;
+    /** SIP item price. Only returned for SIP primary shop */
+    sip_item_price?: number;
+    /** SIP item price source, could be manual or auto. Only returned for SIP primary shop */
+    sip_item_price_source?: string;
+    /** The currency of sip_item_price. Only returned for SIP primary shop */
+    sip_item_price_currency?: string;
+}
+/**
+ * Pre-order information for the model
+ */
+export interface ModelPreOrder {
+    /** Whether the model is on pre-order */
+    is_pre_order: boolean;
+    /** The days to ship for pre-order */
+    days_to_ship: number;
+}
+/**
+ * Model stock information
+ */
+export interface ModelStockInfoV2 {
+    /** Stock summary info */
+    summary_info?: StockSummaryInfo;
+    /** Seller stock */
+    seller_stock?: SellerStock[];
+    /** Shopee stock */
+    shopee_stock?: ShopeeStock[];
+    /** Advance stock details */
+    advance_stock?: AdvanceStock;
+}
+/**
+ * Model dimension information
+ */
+export interface ModelDimension {
+    /** The height of package for this model, the unit is CM */
+    package_height: number;
+    /** The length of package for this model, the unit is CM */
+    package_length: number;
+    /** The width of package for this model, the unit is CM */
+    package_width: number;
+}
+/**
+ * Individual model information
+ */
+export interface ModelInfo {
+    /** Price information for this model */
+    price_info: ModelPriceInfo[];
+    /** Model ID */
+    model_id?: number;
+    /** Tier index of this model */
+    tier_index?: number[];
+    /** Current promotion ID of this model */
+    promotion_id?: number;
+    /** SKU of this model */
+    model_sku?: string;
+    /** The model status, either MODEL_NORMAL or MODEL_UNAVAILABLE */
+    model_status?: string;
+    /** Pre-order information */
+    pre_order?: ModelPreOrder;
+    /** Stock information v2 */
+    stock_info_v2?: ModelStockInfoV2;
+    /** GTIN code (only available for TW seller and BR local seller) */
+    gtin_code?: string;
+    /** The weight of this model, the unit is KG */
+    weight?: string;
+    /** The dimension of this model */
+    dimension?: ModelDimension;
+    /** Whether model is fulfillment by shopee */
+    is_fulfillment_by_shopee?: boolean;
+}
+/**
+ * Standardized variation option
+ */
+export interface StandardVariationOption {
+    /** Standardize Option ID */
+    variation_option_id?: number;
+    /** Standardize Option Name */
+    variation_option_name?: string;
+    /** ID of image */
+    image_id?: string;
+    /** URL of image */
+    image_url?: string;
+}
+/**
+ * Standardized variation information
+ */
+export interface StandardiseTierVariation {
+    /** Standardize Variation ID */
+    variation_id?: number;
+    /** Standardize Variation Name */
+    variation_name?: string;
+    /** Standardize Variation Group ID */
+    variation_group_id?: number;
+    /** Standardize Variation Option List */
+    variation_option_list?: StandardVariationOption[];
+}
+/**
+ * Response for getting model list
+ */
+export interface GetModelListResponse extends FetchResponse<{
+    /** Variation config of item */
+    tier_variation: TierVariation[];
+    /** Model list */
+    model: ModelInfo[];
+    /** Standardise Variation config of item */
+    standardise_tier_variation?: StandardiseTierVariation[];
+}> {
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@congminh1254/shopee-sdk",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Shopee SDK maintaining by community",
   "type": "module",
   "main": "./lib/sdk.js",