@congminh1254/shopee-sdk 1.6.2 → 1.8.0

package/lib/schemas/product.d.ts

@@ -1004,6 +1004,49 @@ export type AddItemParams = {
     description_type?: string;
     /** Seller stock list */
     seller_stock?: SellerStockUpdate[];
+    /** GTIN code */
+    gtin_code?: string;
+    /** Category recommendation service ID */
+    ds_cat_rcmd_id?: string;
+    /** Promotion Image */
+    promotion_images?: {
+        image_id_list?: string[];
+    };
+    /** Compatibility information */
+    compatibility_info?: {
+        vehicle_info_list: Array<{
+            brand_id: number;
+            model_id: number;
+            year_id?: number;
+            version_id?: number;
+        }>;
+    };
+    /** Scheduled publish time */
+    scheduled_publish_time?: number;
+    /** ID of authorised reseller brand */
+    authorised_brand_id?: number;
+    /** Size chart information */
+    size_chart_info?: {
+        size_chart?: string;
+        size_chart_id?: number;
+    };
+    /** Certification information */
+    certification_info?: {
+        certification_list?: Array<{
+            certification_no: string;
+            permit_id: number;
+            expiry_date?: number;
+            certification_proofs: Array<{
+                file_name: string;
+                image_id: number;
+                ratio: number;
+            }>;
+        }>;
+    };
+    /** Purchase limit information */
+    purchase_limit_info?: PurchaseLimitInfo;
+    /** Medicine ID */
+    medicine_id?: number;
 };
 /**
  * Response for adding an item
@@ -1065,6 +1108,49 @@ export type UpdateItemParams = {
     description_type?: string;
     /** Seller stock */
     seller_stock?: SellerStockUpdate[];
+    /** GTIN code */
+    gtin_code?: string;
+    /** Category recommendation service ID */
+    ds_cat_rcmd_id?: string;
+    /** Promotion Image */
+    promotion_images?: {
+        image_id_list?: string[];
+    };
+    /** Compatibility information */
+    compatibility_info?: {
+        vehicle_info_list: Array<{
+            brand_id: number;
+            model_id: number;
+            year_id?: number;
+            version_id?: number;
+        }>;
+    };
+    /** Scheduled publish time */
+    scheduled_publish_time?: number;
+    /** ID of authorised reseller brand */
+    authorised_brand_id?: number;
+    /** Size chart information */
+    size_chart_info?: {
+        size_chart?: string;
+        size_chart_id?: number;
+    };
+    /** Certification information */
+    certification_info?: {
+        certification_list?: Array<{
+            certification_no: string;
+            permit_id: number;
+            expiry_date?: number;
+            certification_proofs: Array<{
+                file_name: string;
+                image_id: number;
+                ratio: number;
+            }>;
+        }>;
+    };
+    /** Purchase limit information */
+    purchase_limit_info?: PurchaseLimitInfo;
+    /** Medicine ID */
+    medicine_id?: number;
 };
 /**
  * Response for updating an item
@@ -1152,6 +1238,8 @@ export type UpdateModelParams = {
     item_id: number;
     /** Model list to update */
     model_list: ModelUpdateInput[];
+    /** Model update object */
+    model?: any;
 };
 /**
  * Response for updating models
@@ -1171,6 +1259,8 @@ export type DeleteModelParams = {
     item_id: number;
     /** List of model IDs to delete */
     model_id_list: number[];
+    /** Model ID to delete */
+    model_id?: number;
 };
 /**
  * Response for deleting models
@@ -1190,6 +1280,8 @@ export type InitTierVariationParams = {
     tier_variation: TierVariationInput[];
     /** Model list */
     model: ModelInput[];
+    /** Standardise tier variation configuration */
+    standardise_tier_variation?: any;
 };
 /**
  * Response for initializing tier variations
@@ -1209,6 +1301,10 @@ export type UpdateTierVariationParams = {
     item_id: number;
     /** Tier variation list */
     tier_variation: TierVariationInput[];
+    /** Model list */
+    model_list?: any[];
+    /** Standardise tier variation configuration */
+    standardise_tier_variation?: any;
 };
 /**
  * Response for updating tier variations
@@ -1229,6 +1325,10 @@ export type SearchItemParams = {
     item_name?: string;
     /** Search by item SKU */
     item_sku?: string;
+    /** Attribute status filter */
+    attribute_status?: number[];
+    /** Deboost only filter */
+    deboost_only?: boolean;
 };
 /**
  * Response for searching items
@@ -1314,9 +1414,11 @@ export interface AttributeTreeNode {
  */
 export type GetAttributeTreeParams = {
     /** Category ID */
-    category_id: number;
+    category_id?: number;
     /** Language */
     language?: string;
+    /** Category ID list */
+    category_id_list?: number[];
 };
 /**
  * Response for getting attribute tree
@@ -1349,6 +1451,8 @@ export type GetBrandListParams = {
     page_size: number;
     /** Status filter */
     status?: number;
+    /** Language filter */
+    language?: string;
 };
 /**
  * Response for getting brand list
@@ -1374,6 +1478,26 @@ export type RegisterBrandParams = {
     category_id: number;
     /** Original brand name */
     original_brand_name: string;
+    /** Category list */
+    category_list?: number[];
+    /** Product image ID/URL */
+    product_image?: string;
+    /** App logo image ID */
+    app_logo_image_id?: string;
+    /** Brand website */
+    brand_website?: string;
+    /** Brand description */
+    brand_description?: string;
+    /** Additional information */
+    additional_information?: string;
+    /** PC logo image ID */
+    pc_logo_image_id?: string;
+    /** Brand region list */
+    brand_region?: string[];
+    /** Licenses list */
+    licenses?: any[];
+    /** Brand registration website */
+    brand_registration_website?: string;
 };
 /**
  * Response for registering a brand
@@ -1400,6 +1524,8 @@ export interface RecommendedCategory {
 export type CategoryRecommendParams = {
     /** Item name */
     item_name: string;
+    /** Product cover image */
+    product_cover_image?: string;
 };
 /**
  * Response for category recommendation
@@ -1518,6 +1644,8 @@ export type GetVariationsParams = {
     item_id: number;
     /** Language */
     language?: string;
+    /** Category ID */
+    category_id?: number;
 };
 /**
  * Response for getting variations
@@ -1535,6 +1663,8 @@ export type GetRecommendAttributeParams = {
     category_id: number;
     /** Item name */
     item_name?: string;
+    /** Cover image ID */
+    cover_image_id?: number;
 };
 /**
  * Recommended attribute
@@ -1572,6 +1702,12 @@ export type SearchAttributeValueListParams = {
     search_value: string;
     /** Language */
     language?: string;
+    /** Value name */
+    value_name?: string;
+    /** Cursor */
+    cursor?: number;
+    /** Limit */
+    limit?: number;
 };
 /**
  * Response for searching attribute values
@@ -1600,6 +1736,8 @@ export type GetMainItemListParams = {
     update_time_from?: number;
     /** Time filter to */
     update_time_to?: number;
+    /** Direct item ID */
+    direct_item_id?: number;
 };
 /**
  * Response for getting main item list
@@ -1668,7 +1806,19 @@ export type GetWeightRecommendationParams = {
     /** Category ID */
     category_id: number;
     /** Item name */
-    item_name: string;
+    item_name?: string;
+    /** Cover image ID */
+    cover_image_id?: string;
+    /** Attribute list */
+    attribute_list?: any[];
+    /** Brand ID */
+    brand_id?: number;
+    /** Description type */
+    description_type?: string;
+    /** Description */
+    description?: string;
+    /** Description info */
+    description_info?: DescriptionInfo;
 };
 /**
  * Response for getting weight recommendation
@@ -1686,6 +1836,8 @@ export type GetDirectItemListParams = {
     offset?: number;
     /** Page size */
     page_size?: number;
+    /** Main item ID */
+    main_item_id?: number;
 };
 /**
  * Direct item info
@@ -1752,6 +1904,10 @@ export type GetItemListByContentDiagnosisParams = {
     offset?: number;
     /** Page size */
     page_size?: number;
+    /** Quality level filter */
+    quality_level?: string[];
+    /** Issue type filter */
+    issue_type?: string[];
 };
 /**
  * Response for getting item list by content diagnosis
@@ -1770,16 +1926,31 @@ export interface GetItemListByContentDiagnosisResponse extends FetchResponse<{
 /**
  * Kit item params (simplified - represents a bundled product)
  */
-export type AddKitItemParams = Record<string, any>;
+export type AddKitItemParams = {
+    /** Item settings */
+    item_setting?: any;
+    /** Sync settings */
+    sync_setting?: any;
+};
 export interface AddKitItemResponse extends FetchResponse<{
     item_id: number;
 }> {
 }
-export type UpdateKitItemParams = Record<string, any>;
+export type UpdateKitItemParams = {
+    /** Kit item ID to update */
+    item_id?: number;
+    /** Item settings */
+    item_setting?: any;
+    /** Sync settings */
+    sync_setting?: any;
+};
 export interface UpdateKitItemResponse extends BaseResponse {
 }
 export type GetKitItemInfoParams = {
+    /** List of item IDs to query */
     item_id_list: number[];
+    /** Single item ID to query */
+    item_id?: number;
 };
 export interface GetKitItemInfoResponse extends FetchResponse<{
     item_list: any[];
@@ -1793,7 +1964,10 @@ export interface GetKitItemLimitResponse extends FetchResponse<{
 }> {
 }
 export type GenerateKitImageParams = {
-    image_id_list: string[];
+    /** List of image IDs */
+    image_id_list?: string[];
+    /** List of components */
+    component_list?: any[];
 };
 export interface GenerateKitImageResponse extends FetchResponse<{
     image_info: {
@@ -1805,13 +1979,37 @@ export interface GenerateKitImageResponse extends FetchResponse<{
 /**
  * SSP (Seller-Sponsored Product) params
  */
-export type AddSspItemParams = Record<string, any>;
+export type AddSspItemParams = {
+    ssp_id?: number;
+    original_price?: number;
+    item_status?: string;
+    dimension?: Dimension;
+    logistic_info?: LogisticInfo[];
+    attribute_list?: ItemAttribute[];
+    pre_order?: PreOrder;
+    item_sku?: string;
+    condition?: string;
+    wholesale?: Wholesale[];
+    video_upload_id?: string[];
+    item_dangerous?: number;
+    tax_info?: TaxInfo;
+    seller_stock?: SellerStockUpdate[];
+    size_chart_info?: {
+        size_chart?: string;
+        size_chart_id?: number;
+    };
+    authorised_brand_id?: number;
+    model_list?: any[];
+};
 export interface AddSspItemResponse extends FetchResponse<{
     item_id: number;
 }> {
 }
 export type GetSspInfoParams = {
-    item_id: number;
+    item_id?: number;
+    ssp_id_list?: number[];
+    gtin_list?: string[];
+    oem_list?: string[];
 };
 export interface GetSspInfoResponse extends FetchResponse<{
     ssp_info: any;
@@ -1828,8 +2026,28 @@ export interface GetSspListResponse extends FetchResponse<{
 }> {
 }
 export type LinkSspParams = {
-    item_id: number;
-    ssp_item_id: number;
+    item_id?: number;
+    ssp_item_id?: number;
+    ssp_id?: number;
+    original_price?: number;
+    item_status?: string;
+    dimension?: Dimension;
+    logistic_info?: LogisticInfo[];
+    attribute_list?: ItemAttribute[];
+    pre_order?: PreOrder;
+    item_sku?: string;
+    condition?: string;
+    wholesale?: Wholesale[];
+    video_upload_id?: string[];
+    item_dangerous?: number;
+    tax_info?: TaxInfo;
+    seller_stock?: SellerStockUpdate[];
+    size_chart_info?: {
+        size_chart?: string;
+        size_chart_id?: number;
+    };
+    authorised_brand_id?: number;
+    model_list?: any[];
 };
 export interface LinkSspResponse extends BaseResponse {
 }
@@ -1867,13 +2085,22 @@ export interface GetSizeChartDetailResponse extends FetchResponse<{
 /**
  * Vehicle compatibility params
  */
-export type GetAllVehicleListParams = Record<string, any>;
+export type GetAllVehicleListParams = {
+    page_size?: number;
+    offset?: number;
+    language?: string;
+};
 export interface GetAllVehicleListResponse extends FetchResponse<{
     vehicle_list: any[];
 }> {
 }
 export type GetVehicleListByCompatibilityDetailParams = {
-    item_id: number;
+    item_id?: number;
+    compatibility_details?: any[];
+    brand_id?: number;
+    model_id?: number;
+    year_id?: number;
+    language?: string;
 };
 export interface GetVehicleListByCompatibilityDetailResponse extends FetchResponse<{
     vehicle_list: any[];
@@ -1883,30 +2110,41 @@ export interface GetVehicleListByCompatibilityDetailResponse extends FetchRespon
  * Other specialized params
  */
 export type GetAitemByPitemIdParams = {
-    pitem_id_list: number[];
+    pitem_id_list?: number[];
+    pitem_id?: number;
 };
 export interface GetAitemByPitemIdResponse extends FetchResponse<{
     item_list: any[];
 }> {
 }
 export type GetDirectShopRecommendedPriceParams = {
-    category_id: number;
+    category_id?: number;
     item_name?: string;
+    main_item_id?: number;
+    direct_shop_regions?: string[];
+    model_list?: any[];
+    enabled_channel_id_list?: number[];
 };
 export interface GetDirectShopRecommendedPriceResponse extends FetchResponse<{
     recommended_price: number;
 }> {
 }
 export type GetProductCertificationRuleParams = {
-    category_id: number;
+    category_id?: number;
+    attribute_list?: any[];
 };
 export interface GetProductCertificationRuleResponse extends FetchResponse<{
     certification_list: any[];
 }> {
 }
 export type SearchUnpackagedModelListParams = {
-    item_id: number;
+    item_id?: number;
     search_value?: string;
+    page_size?: number;
+    cursor?: string;
+    item_name?: string;
+    model_id?: number;
+    unpackaged_sku_id?: number;
 };
 export interface SearchUnpackagedModelListResponse extends FetchResponse<{
     model_list: any[];

package/lib/schemas/public.d.ts

@@ -23,3 +23,6 @@ export interface GetShopeeIpRangeResponse extends FetchResponse<{
     ip_list: string[];
 }> {
 }
+export interface GetTokenByResendCodeParams {
+    resend_code: string;
+}

package/lib/schemas/region.d.ts

@@ -7,8 +7,15 @@ export declare enum ShopeeRegion {
 }
 export declare const SHOPEE_BASE_URLS: {
     readonly GLOBAL: "https://partner.shopeemobile.com/api/v2";
-    readonly CHINA: "https://openplatform.shopee.cn/api/v2/public";
+    readonly CHINA: "https://openplatform.shopee.cn/api/v2";
     readonly BRAZIL: "https://openplatform.shopee.com.br/api/v2";
-    readonly TEST_GLOBAL: "https://partner.test-stable.shopeemobile.com/api/v2";
+    readonly TEST_GLOBAL: "https://openplatform.sandbox.test-stable.shopee.sg/api/v2";
     readonly TEST_CHINA: "https://openplatform.test-stable.shopee.cn/api/v2";
 };
+export declare const SHOPEE_AUTH_URLS: {
+    GLOBAL: string;
+    CHINA: string;
+    BRAZIL: string;
+    TEST_GLOBAL: string;
+    TEST_CHINA: string;
+};

package/lib/schemas/region.js

@@ -8,9 +8,16 @@ export var ShopeeRegion;
 })(ShopeeRegion || (ShopeeRegion = {}));
 export const SHOPEE_BASE_URLS = {
     [ShopeeRegion.GLOBAL]: "https://partner.shopeemobile.com/api/v2",
-    [ShopeeRegion.CHINA]: "https://openplatform.shopee.cn/api/v2/public",
+    [ShopeeRegion.CHINA]: "https://openplatform.shopee.cn/api/v2",
     [ShopeeRegion.BRAZIL]: "https://openplatform.shopee.com.br/api/v2",
-    [ShopeeRegion.TEST_GLOBAL]: "https://partner.test-stable.shopeemobile.com/api/v2",
+    [ShopeeRegion.TEST_GLOBAL]: "https://openplatform.sandbox.test-stable.shopee.sg/api/v2",
     [ShopeeRegion.TEST_CHINA]: "https://openplatform.test-stable.shopee.cn/api/v2",
 };
+export const SHOPEE_AUTH_URLS = {
+    [ShopeeRegion.GLOBAL]: "https://open.shopee.com/auth",
+    [ShopeeRegion.CHINA]: "https://open.shopee.cn/auth",
+    [ShopeeRegion.BRAZIL]: "https://open.shopee.com.br/auth",
+    [ShopeeRegion.TEST_GLOBAL]: "https://open.sandbox.test-stable.shopee.com/auth",
+    [ShopeeRegion.TEST_CHINA]: "https://open.sandbox.test-stable.shopee.cn/auth",
+};
 //# sourceMappingURL=region.js.map

package/lib/schemas/region.js.map

@@ -1 +1 @@
-{"version":3,"file":"region.js","sourceRoot":"","sources":["../../src/schemas/region.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,+BAAe,CAAA;IACf,iCAAiB,CAAA;IACjB,2CAA2B,CAAA;IAC3B,yCAAyB,CAAA;AAC3B,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,yCAAyC;IAChE,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,8CAA8C;IACpE,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,2CAA2C;IAClE,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,qDAAqD;IACjF,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,mDAAmD;CACtE,CAAC"}
+{"version":3,"file":"region.js","sourceRoot":"","sources":["../../src/schemas/region.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,+BAAe,CAAA;IACf,iCAAiB,CAAA;IACjB,2CAA2B,CAAA;IAC3B,yCAAyB,CAAA;AAC3B,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,yCAAyC;IAChE,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,uCAAuC;IAC7D,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,2CAA2C;IAClE,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,2DAA2D;IACvF,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,mDAAmD;CACtE,CAAC;AAEX,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,8BAA8B;IACrD,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,6BAA6B;IACnD,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,iCAAiC;IACxD,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,kDAAkD;IAC9E,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,iDAAiD;CAC7E,CAAC"}

package/lib/schemas/returns.d.ts

@@ -370,6 +370,10 @@ export type DisputeParams = {
     dispute_text_reason?: string;
     /** Images for dispute */
     images?: string[];
+    /** Dispute reason ID */
+    dispute_reason_id?: number;
+    /** Image list */
+    image_list?: string[];
 };
 /**
  * Response for dispute API
@@ -390,6 +394,10 @@ export type OfferParams = {
     solution: number;
     /** Refund amount */
     refund_amount?: number;
+    /** Proposed solution */
+    proposed_solution?: string;
+    /** Proposed adjusted refund amount */
+    proposed_adjusted_refund_amount?: number;
 };
 /**
  * Response for offer API
@@ -447,6 +455,8 @@ export interface GetAvailableSolutionsResponse extends BaseResponse {
 export type CancelDisputeParams = {
     /** Return serial number */
     return_sn: string;
+    /** Email for contact */
+    email?: string;
 };
 /**
  * Response for cancel dispute API
@@ -495,6 +505,10 @@ export interface ImageToConvert {
 export type ConvertImageParams = {
     /** Images to convert */
     images: ImageToConvert[];
+    /** Return serial number */
+    return_sn?: string;
+    /** Upload image content */
+    upload_image?: string;
 };
 /**
  * Converted image information
@@ -538,6 +552,15 @@ export interface ProofVideoItem {
 /**
  * Parameters for uploading proof
  */
+/**
+ * Proof photo item
+ */
+export interface ProofPhotoItem {
+    /** Uploaded proof image link */
+    url: string;
+    /** The proof image thumbnail */
+    thumbnail: string;
+}
 export type UploadProofParams = {
     /** Return serial number */
     return_sn: string;
@@ -547,6 +570,10 @@ export type UploadProofParams = {
     proof_image?: ProofImageItem[];
     /** Proof videos */
     proof_video?: ProofVideoItem[];
+    /** Proof photos */
+    photo?: ProofPhotoItem[];
+    /** Proof description */
+    description?: string;
 };
 /**
  * Response for upload proof API
@@ -618,8 +645,18 @@ export type UploadShippingProofParams = {
     carrier_id: number;
     /** Tracking number */
     tracking_number: string;
+    /** Reverse logistics carrier ID */
+    reverse_logistics_carrier_id?: number;
+    /** Reverse logistics carrier name */
+    reverse_logistics_carrier_name?: string;
+    /** Image ID list */
+    image_id_list?: Array<{
+        image_id?: string;
+    }>;
+    /** Remarks */
+    remarks?: string;
     /** Additional fields as key-value pairs */
-    [key: string]: string | number;
+    [key: string]: any;
 };
 /**
  * Response for upload shipping proof API

package/lib/schemas/shop.d.ts

@@ -326,6 +326,14 @@ export type GetShopHolidayModeResponse = BaseResponse & {
         holiday_mode_on?: boolean;
         /** The last time the holiday mode was modified */
         holiday_mode_mtime?: number;
+        /** Holiday type: 0 - Full holiday, 1 - Partial holiday */
+        holiday_mode_type?: number;
+        /** Holiday start time timestamp */
+        holiday_mode_start_time?: number;
+        /** Holiday end time timestamp */
+        holiday_mode_end_time?: number;
+        /** Description of the holiday */
+        holiday_mode_description?: string;
         /** Debug message */
         debug_msg?: string;
     };
@@ -336,6 +344,14 @@ export type GetShopHolidayModeResponse = BaseResponse & {
 export type SetShopHolidayModeParams = {
     /** Indicate whether to enable holiday mode for the shop. true means turn ON, false means turn OFF. */
     holiday_mode_on: boolean;
+    /** Holiday type: 0 - Full holiday, 1 - Partial holiday */
+    holiday_mode_type?: number;
+    /** Holiday start time timestamp */
+    holiday_mode_start_time?: number;
+    /** Holiday end time timestamp */
+    holiday_mode_end_time?: number;
+    /** Description of the holiday */
+    holiday_mode_description?: string;
 };
 /**
  * Response for setting shop holiday mode