@congminh1254/shopee-sdk 1.6.1 → 1.7.0

package/lib/schemas/ams.d.ts

@@ -274,6 +274,8 @@ export type GetOpenCampaignPerformanceParams = {
     page_no?: number;
     /** Page size */
     page_size?: number;
+    /** Item ID */
+    item_id?: number;
 };
 /**
  * Response for get_open_campaign_performance API
@@ -435,6 +437,14 @@ export type GetTargetedCampaignListParams = {
     campaign_name?: string;
     /** Campaign status to filter */
     campaign_status?: string;
+    /** Period start time */
+    period_start_time?: number;
+    /** Period end time */
+    period_end_time?: number;
+    /** Item ID */
+    item_id?: number;
+    /** Item name */
+    item_name?: string;
 };
 /**
  * Response for get_targeted_campaign_list API
@@ -482,6 +492,8 @@ export type GetTargetedCampaignPerformanceParams = {
     page_no?: number;
     /** Page size */
     page_size?: number;
+    /** Campaign ID */
+    campaign_id?: number;
 };
 /**
  * Response for get_targeted_campaign_performance API
@@ -607,6 +619,12 @@ export type GetAffiliatePerformanceParams = {
     page_no?: number;
     /** Page size */
     page_size?: number;
+    /** Order type filter: 1: all, 2: completed, 3: cancelled, etc. */
+    order_type?: number;
+    /** Traffic channel: custom, livestream, affiliate, etc. */
+    channel?: string;
+    /** Affiliate ID to filter */
+    affiliate_id?: string;
 };
 /**
  * Response for get_affiliate_performance API
@@ -685,6 +703,14 @@ export type GetContentPerformanceParams = {
     page_no?: number;
     /** Page size */
     page_size?: number;
+    /** Order type filter */
+    order_type?: number;
+    /** Traffic channel */
+    channel?: string;
+    /** Affiliate ID */
+    affiliate_id?: string;
+    /** Item ID */
+    item_id?: number;
 };
 /**
  * Response for get_content_performance API
@@ -724,6 +750,46 @@ export type GetConversionReportParams = {
     affiliate_id?: number;
     /** Item ID to filter */
     item_id?: number;
+    /** Item name */
+    item_name?: string;
+    /** L1 category ID */
+    l1_category_id?: number;
+    /** L2 category ID */
+    l2_category_id?: number;
+    /** L3 category ID */
+    l3_category_id?: number;
+    /** Order status */
+    order_status?: number;
+    /** Verified status */
+    verified_status?: number;
+    /** Buyer status */
+    buyer_status?: number;
+    /** Attr campaign ID */
+    attr_campaign_id?: string;
+    /** Campaign partner */
+    campaign_partner?: string;
+    /** Seller campaign type */
+    seller_campaign_type?: string;
+    /** Deduction status */
+    deduction_status?: number;
+    /** Deduction method */
+    deduction_method?: string;
+    /** Place order time start */
+    place_order_time_start?: number;
+    /** Place order time end */
+    place_order_time_end?: number;
+    /** Order completed time start */
+    order_completed_time_start?: number;
+    /** Order completed time end */
+    order_completed_time_end?: number;
+    /** Conversion completed time start */
+    conversion_completed_time_start?: number;
+    /** Conversion completed time end */
+    conversion_completed_time_end?: number;
+    /** AMS deduction time start */
+    ams_deduction_time_start?: number;
+    /** AMS deduction time end */
+    ams_deduction_time_end?: number;
 };
 /**
  * Response for get_conversion_report API
@@ -839,6 +905,12 @@ export type GetProductPerformanceParams = {
     page_no?: number;
     /** Page size */
     page_size?: number;
+    /** Order type filter */
+    order_type?: number;
+    /** Traffic channel */
+    channel?: string;
+    /** Item ID */
+    item_id?: number;
 };
 /**
  * Response for get_product_performance API
@@ -970,6 +1042,26 @@ export type GetValidationReportParams = {
     validation_month?: string;
     /** Campaign source */
     campaign_source?: string;
+    /** Order SN */
+    order_sn?: string;
+    /** L1 category ID */
+    l1_category_id?: number;
+    /** L2 category ID */
+    l2_category_id?: number;
+    /** L3 category ID */
+    l3_category_id?: number;
+    /** Item ID */
+    item_id?: number;
+    /** Item name */
+    item_name?: string;
+    /** Verified status */
+    verified_status?: number;
+    /** Attr campaign ID */
+    attr_campaign_id?: string;
+    /** Place order time start */
+    place_order_time_start?: number;
+    /** Place order time end */
+    place_order_time_end?: number;
 };
 /**
  * Response for get_validation_report API

package/lib/schemas/base.d.ts

@@ -8,4 +8,6 @@ export interface BaseResponse {
     error: string;
     /** Error message if any error occurred */
     message: string;
+    /** Warning message or list of warning messages */
+    warning?: string | string[];
 }

package/lib/schemas/discount.d.ts

@@ -101,6 +101,10 @@ export interface GetDiscountListParams {
     page_no?: number;
     /** Maximum number of entries to retrieve per page. Default 100, max 100 */
     page_size?: number;
+    /** Update time from */
+    update_time_from?: number;
+    /** Update time to */
+    update_time_to?: number;
     [key: string]: string | number | boolean | undefined;
 }
 /**

package/lib/schemas/fetch.d.ts

@@ -5,7 +5,7 @@ export type FetchOptions = Omit<RequestInit, "body"> & {
     auth?: boolean;
 };
 export interface FetchResponse<T> {
-    result: T;
+    result?: T;
     response: T;
     request_id: string;
     error: string;

package/lib/schemas/livestream.d.ts

@@ -81,6 +81,8 @@ export interface UpdateSessionParams {
     description?: string;
     /** The cover image URL of livestream session */
     cover_image_url?: string;
+    /** Indicate whether the livestream session is for testing purpose only */
+    is_test?: boolean;
 }
 /**
  * Response for updating a livestream session
@@ -400,6 +402,8 @@ export interface GetLikeItemListParams extends Record<string, string | number |
     offset: number;
     /** Maximum number of entries per page (1-100) */
     page_size: number;
+    /** Keyword for search */
+    keyword?: string;
 }
 /**
  * Response for getting like item list
@@ -422,6 +426,8 @@ export interface ApplyItemSetParams {
     session_id: number;
     /** The identifier of item set */
     item_set_id: number;
+    /** The list of item set IDs */
+    item_set_ids?: number[];
 }
 /**
  * Response for applying item set
@@ -437,6 +443,8 @@ export interface GetItemSetListParams extends Record<string, string | number | b
     offset: number;
     /** Maximum number of entries per page (1-100) */
     page_size: number;
+    /** Keyword for search */
+    keyword?: string;
 }
 /**
  * Item set information
@@ -555,6 +563,8 @@ export interface PostCommentParams {
     session_id: number;
     /** Comment text */
     comment: string;
+    /** Comment content (field gap requirement) */
+    content?: string;
 }
 /**
  * Response for posting a comment
@@ -609,6 +619,8 @@ export interface BanUserCommentParams {
     session_id: number;
     /** User ID to ban */
     user_id: number;
+    /** Ban user ID (field gap requirement) */
+    ban_user_id?: number;
 }
 /**
  * Response for banning a user from commenting
@@ -624,6 +636,8 @@ export interface UnbanUserCommentParams {
     session_id: number;
     /** User ID to unban */
     user_id: number;
+    /** Unban user ID (field gap requirement) */
+    unban_user_id?: number;
 }
 /**
  * Response for unbanning a user from commenting

package/lib/schemas/media.d.ts

@@ -27,8 +27,8 @@ export interface UploadMediaImageParams {
     business: MediaImageBusiness;
     /** Defines the purpose of the uploaded image under the specified business type */
     scene: MediaImageScene;
-    /** The image files to be uploaded (file path or buffer) */
-    images: string | Buffer | Array<string | Buffer>;
+    /** The image files to be uploaded as buffers */
+    images: Buffer | Array<Buffer>;
 }
 /**
  * Response for v2.media.upload_image
@@ -86,8 +86,8 @@ export interface ImageInfoItem {
  * Parameters for v2.media_space.upload_image
  */
 export interface UploadImageParams {
-    /** The image files to be uploaded (up to 9 images) */
-    image: string | Buffer | Array<string | Buffer>;
+    /** The image files to be uploaded as buffers (up to 9 images) */
+    image: Buffer | Array<Buffer>;
     /** Scene where the picture is used */
     scene?: MediaSpaceImageScene;
     /** Image ratio (only for whitelisted sellers) */
@@ -132,8 +132,8 @@ export interface UploadVideoPartParams {
     part_seq: number;
     /** MD5 of this part */
     content_md5: string;
-    /** The content of this part of file (exactly 4MB except last part) */
-    part_content: string | Buffer;
+    /** The content of this part of file as a buffer (exactly 4MB except last part) */
+    part_content: Buffer;
 }
 /**
  * Response for v2.media_space.upload_video_part
@@ -228,3 +228,110 @@ export interface CancelVideoUploadParams {
  */
 export interface CancelVideoUploadResponse extends BaseResponse {
 }
+/**
+ * Parameters for v2.media.init_video_upload
+ */
+export interface InitMediaVideoUploadParams {
+    /** Defines the business type of the uploaded image. Supported values: 3 = Video */
+    business: number;
+    /** Defines the purpose of the uploaded image under the specified business type. Supported values: If business = 3 (Video): 1 = Shopee Video */
+    scene: number;
+    /** Original video file name */
+    file_name: string;
+    /** Total video file size in bytes. Maximum 1GB. */
+    file_size: number;
+    /** Video duration in seconds. 1s~180s. */
+    duration: number;
+}
+/**
+ * Response for v2.media.init_video_upload
+ */
+export interface InitMediaVideoUploadResponse extends BaseResponse {
+    response: {
+        /** Unique upload session ID */
+        video_upload_id: string;
+        /** The size of each part. When uploading video chunks, the video must be split according to this part size for each upload request. */
+        part_size: number;
+    };
+}
+/**
+ * Parameters for v2.media.upload_video_part
+ */
+export interface UploadMediaVideoPartParams {
+    /** The unique ID of the upload task, returned by v2.media.init_video_upload */
+    video_upload_id: string;
+    /** Sequence number of this part, starting from 0 */
+    part_seq: number;
+    /** The content of this part of file. Part size should be exactly equal to part_size returned in v2.media.init_video_upload, except last part of file. */
+    part_content: string | Buffer;
+    /** MD5 checksum of this part for data integrity validation */
+    part_md5: string;
+}
+/**
+ * Response for v2.media.upload_video_part
+ */
+export interface UploadMediaVideoPartResponse extends BaseResponse {
+}
+/**
+ * Parameters for v2.media.complete_video_upload
+ */
+export interface CompleteMediaVideoUploadParams {
+    /** The unique ID of the upload task, returned by v2.media.init_video_upload */
+    video_upload_id: string;
+}
+/**
+ * Response for v2.media.complete_video_upload
+ */
+export interface CompleteMediaVideoUploadResponse extends BaseResponse {
+}
+/**
+ * Parameters for v2.media.get_video_upload_result
+ */
+export interface GetMediaVideoUploadResultParams extends Record<string, string | number | boolean | null | undefined> {
+    /** The unique ID of the upload task, returned by v2.media.init_video_upload */
+    video_upload_id: string;
+}
+/**
+ * Transcoded video info inside media video upload result
+ */
+export interface MediaVideoUploadResultVideoInfo {
+    /** Video playback url */
+    video_url: string;
+    /** Video thumbnail image url */
+    video_thumbnail_url: string;
+    /** Video thumbnail image width */
+    thumbnail_width: number;
+    /** Video thumbnail image height */
+    thumbnail_height: number;
+    /** Video duration in seconds */
+    duration: number;
+    /** Video resolution, e.g., "960x540" */
+    resolution: string;
+}
+/**
+ * Response for v2.media.get_video_upload_result
+ */
+export interface GetMediaVideoUploadResultResponse extends BaseResponse {
+    response: {
+        /** Current status of the upload task: INITIATED, UPLOADING, UPLOADED, PROCESSING, SUCCEEDED, FAILED, CANCELLED */
+        status: string;
+        /** Detailed fail or cancel reason, will be returned if status is FAILED or CANCELLED */
+        reason?: string;
+        /** The time of video status updates */
+        update_time?: number;
+        /** Transcoded video info, will be returned if status is SUCCEEDED */
+        video_info?: MediaVideoUploadResultVideoInfo;
+    };
+}
+/**
+ * Parameters for v2.media.cancel_video_upload
+ */
+export interface CancelMediaVideoUploadParams {
+    /** The unique ID of the upload task, returned by v2.media.init_video_upload */
+    video_upload_id: string;
+}
+/**
+ * Response for v2.media.cancel_video_upload
+ */
+export interface CancelMediaVideoUploadResponse extends BaseResponse {
+}

package/lib/schemas/merchant.d.ts

@@ -93,6 +93,8 @@ export type GetMerchantPrepaidAccountListResponse = MerchantResponse<{
 export interface GetMerchantWarehouseListParams {
     /** Pagination cursor */
     cursor: DoubleSidedCursor;
+    /** Type of warehouse: 1 = pickup, 2 = return */
+    warehouse_type?: number;
 }
 /**
  * Address information

package/lib/schemas/order.d.ts

@@ -858,6 +858,22 @@ export interface HandlePrescriptionCheckParams {
     operation: "APPROVE" | "REJECT";
     /** The reason for rejection. Required when operation is REJECT */
     reject_reason?: string;
+    /** Shopee's unique identifier for an order */
+    order_sn?: string;
+    /** Indicate whether the prescription is approved or not */
+    is_approved?: boolean;
+    /** Reject reason code */
+    reject_reason_code?: number;
+    /** Prescription check items */
+    items?: Array<{
+        item_id?: number;
+        model_id?: number;
+        prescription_status?: number;
+    }>;
+    /** Name of the pharmacist */
+    pharmacist_name?: string;
+    /** Free text remarks */
+    free_text?: string;
 }
 /**
  * Response for handling prescription check
@@ -890,6 +906,10 @@ export interface UploadInvoiceDocParams {
     order_sn: string;
     /** The invoice document file */
     invoice_file: string;
+    /** File type (PDF, etc) */
+    file_type?: string;
+    /** File content/name */
+    file?: string;
 }
 /**
  * Response for uploading invoice document
@@ -902,6 +922,8 @@ export interface UploadInvoiceDocResponse extends FetchResponse<null> {
 export interface GetBookingDetailParams {
     /** The set of booking_sn. If there are multiple booking_sn, you need to use English comma to connect them. limit [1,50] */
     booking_sn_list: string[];
+    /** Optional fields in response */
+    response_optional_fields?: string;
 }
 /**
  * Booking detail information

package/lib/schemas/payment.d.ts

@@ -652,6 +652,10 @@ export type GenerateIncomeReportParams = {
     end_time: number;
     /** Currency for the report */
     currency?: string;
+    /** Release time from */
+    release_time_from?: number;
+    /** Release time to */
+    release_time_to?: number;
 };
 /**
  * Response for generate income report API
@@ -692,6 +696,12 @@ export type GenerateIncomeStatementParams = {
     start_time: number;
     /** End time for the statement (timestamp) */
     end_time: number;
+    /** Release time from */
+    release_time_from?: number;
+    /** Release time to */
+    release_time_to?: number;
+    /** Statement type */
+    statement_type?: string;
 };
 /**
  * Response for generate income statement API
@@ -824,6 +834,8 @@ export type GetPayoutInfoParams = {
     page_no?: number;
     /** Page size, max 100, default 40 */
     page_size?: number;
+    /** Pagination cursor */
+    cursor?: string;
 };
 /**
  * Payout info item
@@ -853,3 +865,87 @@ export interface GetPayoutInfoResponse extends BaseResponse {
         more: boolean;
     };
 }
+/**
+ * Parameters for v2.payment.get_income_detail
+ */
+export interface GetIncomeDetailParams extends Record<string, string | number | boolean | null | undefined> {
+    /** Start date (YYYY-MM-DD) of the income reference period. This field is only used for Income Status = Released, the other statuses will display all records currently in that status. */
+    date_from: string;
+    /** End date (YYYY-MM-DD) of the income reference period. Must be later than date_from. This field is only used for Income Status = Released, the other statuses will display all records currently in that status. */
+    date_to: string;
+    /** Status of Seller Income payout. Supported values: Local: 1 - Released, 2 - Pending. CB: 0 - To Release, 1 - Released, 2 - Pending. */
+    income_status: number;
+    /** Pagination token for the next set of results. Use an empty string "" for the first request. */
+    cursor?: string;
+    /** Number of income detail records to retrieve per page */
+    page_size: number;
+}
+export interface IncomeDetailNextPage {
+    /** Token to retrieve the next page of results. Returns empty if there is no more data. */
+    cursor: string;
+    /** Number of records returned per page. */
+    page_size: number;
+}
+export interface IncomeDetailListItem {
+    /** Payment channel or method used for the order */
+    payment_method?: string;
+    /** Unique order serial number associated with the income record. */
+    order_sn?: string;
+    /** Type of income or billing item — e.g., Order Income, Adjustment etc */
+    description?: string;
+    /** Status description of the order income or payout. */
+    status?: string;
+    /** Currency in which the income was transacted. */
+    currency?: string;
+    /** Estimated escrow amount pending release for the order. */
+    estimated_escrow_amount?: number;
+    /** Estimated payout time (Unix timestamp). Applicable for Pending/To Release status. */
+    estimated_payout_time?: number;
+    /** Amount that is queued for release to seller (Cross Border only). */
+    to_release_amount?: number;
+    /** Order creation timestamp (Unix format). */
+    creation_date?: number;
+    /** Amount successfully released to the seller. */
+    released_amount?: number;
+    /** Actual payout time (Unix timestamp) when funds were transferred. */
+    actual_payout_time?: number;
+}
+export interface IncomeDetailList {
+    next_page?: IncomeDetailNextPage;
+    list?: IncomeDetailListItem[];
+}
+/**
+ * Response for v2.payment.get_income_detail
+ */
+export interface GetIncomeDetailResponse extends BaseResponse {
+    /** List of income detail records returned for the specified time range and status. */
+    income_detail_list?: IncomeDetailList;
+}
+/**
+ * Parameters for v2.payment.get_income_overview
+ */
+export interface GetIncomeOverviewParams extends Record<string, string | number | boolean | null | undefined> {
+    /** Status of Seller Income payout. Supported values: Local Shop: 1 - Released, 2 - Pending. CB Shop: 0 - To Release, 1 - Released, 2 - Pending. */
+    income_status?: number;
+}
+export interface TotalIncome {
+    /** Total amount pending release (Local: orders before ESCROW_PAID; CB: orders before ESCROW_PAYOUT). */
+    pending_amount?: number;
+    /** Amount queued for release in the next payout cycle (CB only). Not applicable for Local shops. */
+    to_release_amount?: number;
+    /** Total amount successfully released to the seller. */
+    released_amount?: number;
+}
+/**
+ * Response for v2.payment.get_income_overview
+ */
+export interface GetIncomeOverviewResponse extends BaseResponse {
+    response?: {
+        /** The latest payout date for the released income. Format: YYYY-MM-DD. Only for CN shops. */
+        latest_payout_date?: string;
+        /** Object containing total income components. */
+        total_income?: TotalIncome;
+    };
+    /** Object containing total income components (fallback top-level). */
+    total_income?: TotalIncome;
+}