@congminh1254/shopee-sdk 1.3.0 → 1.5.2

package/lib/schemas/ams.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ams.js.map

package/lib/schemas/ams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ams.js","sourceRoot":"","sources":["../../src/schemas/ams.ts"],"names":[],"mappings":""}

package/lib/schemas/index.d.ts

@@ -24,3 +24,4 @@ export * from "./top-picks.js";
 export * from "./shop-category.js";
 export * from "./returns.js";
 export * from "./fbs.js";
+export * from "./ams.js";

package/lib/schemas/index.js

@@ -24,6 +24,7 @@ export * from "./top-picks.js";
 export * from "./shop-category.js";
 export * from "./returns.js";
 export * from "./fbs.js";
+export * from "./ams.js";
 // Media and MediaSpace schemas export the same types, so they are not exported from the main index
 // Import them directly from their respective files when needed:
 // import * as Media from "./schemas/media.js";

package/lib/schemas/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,mGAAmG;AACnG,gEAAgE;AAChE,+CAA+C;AAC/C,0DAA0D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,mGAAmG;AACnG,gEAAgE;AAChE,+CAA+C;AAC/C,0DAA0D"}

package/lib/schemas/logistics.d.ts

@@ -1134,3 +1134,70 @@ export type BatchUpdateTPFWarehouseTrackingStatusParams = {
 export interface BatchUpdateTPFWarehouseTrackingStatusResponse extends BaseResponse {
     response?: Record<string, never>;
 }
+/**
+ * Parameters for check polygon update status
+ */
+export type CheckPolygonUpdateStatusParams = {
+    /** ID that needs to be checked. Please pass the task_id returned via the v2.logistics.upload_serviceable_polygon. */
+    task_id: string;
+} & Record<string, string | number | boolean | object | null | undefined>;
+/**
+ * Response for check polygon update status API
+ */
+export interface CheckPolygonUpdateStatusResponse extends BaseResponse {
+    response?: {
+        /** Serviceable polygon file upload status. 0: Task completed, 1: Task in progress, 2: KML file related errors */
+        status?: number;
+        /** Details of the upload status, e.g "task in progress" */
+        message?: string;
+    };
+}
+/**
+ * Parameters for update address
+ */
+export type UpdateAddressParams = {
+    /** Unique identifier for the address. You can get the address_id via v2.logistics.get_address_list. */
+    address_id: number;
+    /** The region of the address. Note: Do not allow to update the region of the address. */
+    region?: string;
+    /** The state of the address. */
+    state?: string;
+    /** The city of the address. */
+    city?: string;
+    /** The district of the address. */
+    district?: string;
+    /** The town of the address. */
+    town?: string;
+    /** The detailed address description of the address. */
+    address?: string;
+    /** The zipcode of the address. */
+    zipcode?: string;
+    /** Recipient's name at this address. */
+    name?: string;
+    /** Contact phone number for the recipient. */
+    phone?: string;
+    /** Geolocation information for the address. Type: JSON string. To clear existing geo info, pass "" or {}. To keep existing geo info, do not include this field. */
+    geo_info?: string;
+} & Record<string, string | number | boolean | object | null | undefined>;
+/**
+ * Response for update address API
+ */
+export interface UpdateAddressResponse extends BaseResponse {
+    response?: Record<string, never>;
+}
+/**
+ * Parameters for upload serviceable polygon
+ */
+export type UploadServiceablePolygonParams = {
+    /** The .kml file to be uploaded to denote the serviceability area of the shops. */
+    file: File | Blob;
+} & Record<string, string | number | boolean | object | null | undefined>;
+/**
+ * Response for upload serviceable polygon API
+ */
+export interface UploadServiceablePolygonResponse extends BaseResponse {
+    response?: {
+        /** Use the task_id to call v2.logistics.check_polygon_update_status to check if the upload job has been completed. */
+        task_id?: string;
+    };
+}

package/lib/schemas/order.d.ts

@@ -50,6 +50,15 @@ export interface OrderItem {
     is_prescription_item: boolean;
     /** Determine if item is B2C shop item */
     is_b2c_owned_item: boolean;
+    /** [Only for PH,TH,VN,MY,BR,TW] True if the item is hot listing */
+    hot_listing_item?: boolean;
+    /** List of promotions applied to this item */
+    promotion_list?: Array<{
+        /** The type of item or package level promotion applied to a product */
+        promotion_type: string;
+        /** The unique identifier of a specific promotion applied to an item */
+        promotion_id: number;
+    }>;
 }
 /**
  * Represents an item in a package with basic information
@@ -258,6 +267,21 @@ export interface Order {
     return_request_due_date?: number;
     /** The invoice data of the order */
     invoice_data?: InvoiceData;
+    /** [Only for BR] List of payment information */
+    payment_info?: Array<{
+        /** Payment method used in the order, such as Credit Card, Debit Card, Pix, etc. */
+        payment_method: string;
+        /** CNPJ of the payment processor handling the transaction */
+        payment_processor_register: string;
+        /** Card brand for credit or debit transactions, such as VISA, MASTER, etc. Empty string for Pix payments */
+        card_brand: string;
+        /** Payment authorization code generated by the bank or payment processor to validate the transaction */
+        transaction_id: string;
+        /** Amount paid by the corresponding payment method */
+        payment_amount: number;
+    }>;
+    /** [Only for PH,TH,VN,MY,BR,TW] True if the order includes hot listing item */
+    hot_listing_order?: boolean;
 }
 /**
  * The kind of time range field for order list query

package/lib/schemas/order.js.map

@@ -1 +1 @@
-{"version":3,"file":"order.js","sourceRoot":"","sources":["../../src/schemas/order.ts"],"names":[],"mappings":"AA4VA,MAAM,CAAC,MAAM,iBAAiB,GAC5B,qbAAqb,CAAC"}
+{"version":3,"file":"order.js","sourceRoot":"","sources":["../../src/schemas/order.ts"],"names":[],"mappings":"AAoXA,MAAM,CAAC,MAAM,iBAAiB,GAC5B,qbAAqb,CAAC"}

package/lib/schemas/product.d.ts

@@ -1912,3 +1912,142 @@ export interface SearchUnpackagedModelListResponse extends FetchResponse<{
     model_list: any[];
 }> {
 }
+/**
+ * Parameters for get mart item mapping by id
+ */
+export type GetMartItemMappingByIdParams = {
+    /** The item ID of the item in the Mart shop */
+    mart_item_id: number;
+    /** A list of outlet shop IDs used to filter the mapping results */
+    outlet_shop_id_list: number[];
+};
+/**
+ * Model mapping information
+ */
+export interface ModelMapping {
+    /** The model ID of the product in the Mart shop */
+    mart_model_id?: number;
+    /** The model ID of the corresponding product in the outlet shop */
+    outlet_model_id?: number;
+}
+/**
+ * Item mapping information
+ */
+export interface ItemMapping {
+    /** The item ID of the item in the Mart shop */
+    mart_item_id?: number;
+    /** The item ID of the corresponding item in the outlet shop */
+    outlet_item_id?: number;
+    /** The mapping relationship between Mart models and outlet models under the mapped items */
+    model_mapping?: ModelMapping[];
+}
+/**
+ * Response for get mart item mapping by id API
+ */
+export interface GetMartItemMappingByIdResponse extends BaseResponse {
+    /** Warning details */
+    warning?: string;
+    response?: {
+        /** A list of item mapping records between the Mart item and its corresponding outlet items */
+        item_mapping_list?: ItemMapping[];
+    };
+}
+/**
+ * Seller stock information for publishing to outlet
+ */
+export interface OutletSellerStock {
+    /** The location ID where the stock is stored */
+    location_id?: string;
+    /** The available stock quantity for the model */
+    stock: number;
+}
+/**
+ * Pre-order configuration for publishing to outlet
+ */
+export interface OutletPreOrder {
+    /** Indicates whether the model is sold as a pre-order item */
+    is_pre_order: boolean;
+    /** The number of days required to ship the item after an order is placed */
+    days_to_ship?: number;
+}
+/**
+ * Model information for publishing
+ */
+export interface PublishModel {
+    /** The model ID in the Mart shop that this outlet model is associated with. model_id=0 for items with only the default model(no variations) */
+    relate_mart_model_id: number;
+    /** The status of model */
+    model_status?: string;
+    /** The original price of the model */
+    original_price?: number;
+    /** Stock information for the model, set in outlet sku level */
+    seller_stock?: OutletSellerStock[];
+    /** Pre-order configuration, set in outlet sku level */
+    pre_order?: OutletPreOrder;
+}
+/**
+ * Logistics channel configuration for outlet
+ */
+export interface OutletLogisticInfo {
+    /** The logistics channel ID used for shipping the item */
+    logistic_id: number;
+    /** Indicates whether the logistics channel is enabled for the item */
+    enabled: boolean;
+    /** The shipping fee charged to the buyer for this logistics channel */
+    shipping_fee?: number;
+    /** The parcel size ID used to calculate shipping fees */
+    size_id?: number;
+    /** Indicates whether free shipping is applied for this logistics channel */
+    is_free?: boolean;
+}
+/**
+ * Maximum purchase limit configuration
+ */
+export interface MaxPurchaseLimit {
+    /** The maximum quantity that a buyer is allowed to purchase per order */
+    purchase_limit: number;
+}
+/**
+ * Purchase limit information
+ */
+export interface PurchaseLimitInfo {
+    /** The minimum quantity that a buyer is allowed to purchase per order */
+    min_purchase_limit: number;
+    /** The maximum purchase quantity configuration for the item */
+    max_purchase_limit: MaxPurchaseLimit;
+}
+/**
+ * Item publishing configuration
+ */
+export interface PublishItemConfig {
+    /** The outlet item ID */
+    outlet_item_id?: number;
+    /** A list of models to be published to the outlet shop, mapped from the corresponding Mart shop models */
+    model?: PublishModel[];
+    /** Logistic channel setting; can set for each outlet shop */
+    logistic_info?: OutletLogisticInfo[];
+    /** Purchase quantity limits applied to the item in the outlet shop */
+    purchase_limit_info?: PurchaseLimitInfo;
+}
+/**
+ * Parameters for publish item to outlet shop
+ */
+export type PublishItemToOutletShopParams = {
+    /** The item ID of the product in the Mart shop to be published to the outlet shop */
+    mart_item_id: number;
+    /** The shop ID of the outlet shop where the product will be published */
+    outlet_shop_id: number;
+    /** Configuration details for publishing the product to the outlet shop, including model mapping, pricing, stock, logistics, and purchase limits */
+    publish_item: PublishItemConfig;
+};
+/**
+ * Response for publish item to outlet shop API
+ */
+export interface PublishItemToOutletShopResponse extends BaseResponse {
+    /** Warning message */
+    warning?: string;
+    response?: {
+        /** The outlet item ID */
+        item_id?: number;
+    };
+}

package/lib/schemas/shop.d.ts

@@ -248,3 +248,101 @@ export type GetAuthorisedResellerBrandResponse = BaseResponse & {
     /** Authorised reseller brand data */
     response: AuthorisedResellerBrandData;
 };
+/**
+ * Parameters for getting BR shop onboarding info
+ */
+export type GetBRShopOnboardingInfoParams = Record<string, never>;
+/**
+ * Billing address information
+ */
+export type BillingAddress = {
+    /** State of the billing address */
+    state?: string;
+    /** City of the billing address */
+    city?: string;
+    /** Specific detail of the billing address */
+    address?: string;
+    /** ZIP code of the billing address */
+    zipcode?: string;
+    /** Neighborhood of the billing address */
+    neighborhood?: string;
+};
+/**
+ * BR shop onboarding information
+ */
+export type BRShopOnboardingInfo = {
+    /** Type of the shop's tax ID. 1: Personal seller (CPF), 2: Company seller (CNPJ) */
+    tax_id_type?: number;
+    /** The shop's tax ID. When tax_id_type = 1 (Personal seller), it is CPF. When tax_id_type = 2 (Company seller), it is CNPJ. */
+    tax_id?: string;
+    /** CPF number of the individual seller. Valid only when tax_id_type = 1. */
+    cpf_id?: string;
+    /** CNPJ number of the company seller. Valid only when tax_id_type = 2. */
+    cnpj_id?: string;
+    /** Full name of the individual seller. Valid only when tax_id_type = 1. */
+    name?: string;
+    /** Legal name of the company seller. Valid only when tax_id_type = 2. */
+    legal_entity_name?: string;
+    /** Birthday of the individual seller (stored as Unix timestamp). Valid only when tax_id_type = 1. */
+    birthday?: number;
+    /** Birthday of the individual seller (formatted as YYYY-MM-DD). Valid only when tax_id_type = 1. */
+    birthday_str?: string;
+    /** State registration number of the shop */
+    state_registration?: string;
+    /** Shop's billing address details */
+    billing_address?: BillingAddress;
+    /** Status of the shop's current KYC onboarding process. 0: None, 1: Regis Processing, 2: Regis Validated, 3: Regis Rejected, 4: KYC Pending, 5: KYC Processing, 6: KYC Processing Manually, 7: KYC Validated, 8: KYC Rejected */
+    onboarding_status?: number;
+    /** Timestamp when the onboarding information was submitted */
+    submission_time?: number;
+    /** Nationality of the individual seller. Valid only when tax_id_type=1. */
+    nationality?: string;
+    /** Main CNAE code */
+    cnae_main?: string;
+    /** Secondary CNAE code */
+    cnae_secondary?: string;
+    /** MEI verification result. 0: No, 1: Yes */
+    mei_check?: string;
+    /** Indicate if the shop has passed KYC verification */
+    onboarding_passed?: boolean;
+};
+/**
+ * Response for getting BR shop onboarding info
+ */
+export type GetBRShopOnboardingInfoResponse = BaseResponse & {
+    /** Onboarding information of the Shop */
+    response?: BRShopOnboardingInfo;
+};
+/**
+ * Parameters for getting shop holiday mode
+ */
+export type GetShopHolidayModeParams = Record<string, never>;
+/**
+ * Response for getting shop holiday mode
+ */
+export type GetShopHolidayModeResponse = BaseResponse & {
+    response?: {
+        /** Indicate whether the shop has enabled holiday mode. true means ON, false means OFF. */
+        holiday_mode_on?: boolean;
+        /** The last time the holiday mode was modified */
+        holiday_mode_mtime?: number;
+        /** Debug message */
+        debug_msg?: string;
+    };
+};
+/**
+ * Parameters for setting shop holiday mode
+ */
+export type SetShopHolidayModeParams = {
+    /** Indicate whether to enable holiday mode for the shop. true means turn ON, false means turn OFF. */
+    holiday_mode_on: boolean;
+};
+/**
+ * Response for setting shop holiday mode
+ */
+export type SetShopHolidayModeResponse = BaseResponse & {
+    response?: {
+        /** Debug message */
+        debug_msg?: string;
+    };
+};