@congminh1254/shopee-sdk 0.10.0 → 1.0.0

package/lib/schemas/bundle-deal.d.ts

@@ -0,0 +1,300 @@
+import { BaseResponse } from "./base.js";
+/**
+ * Bundle deal rule types
+ */
+export declare enum BundleDealRuleType {
+    /** Fixed price for the bundle */
+    FIX_PRICE = 1,
+    /** Discount percentage */
+    DISCOUNT_PERCENTAGE = 2,
+    /** Discount value */
+    DISCOUNT_VALUE = 3
+}
+/**
+ * Bundle deal time status for filtering
+ */
+export declare enum BundleDealTimeStatus {
+    /** All bundle deals regardless of status */
+    ALL = 1,
+    /** Bundle deals that have not started yet */
+    UPCOMING = 2,
+    /** Currently active bundle deals */
+    ONGOING = 3,
+    /** Bundle deals that have ended */
+    EXPIRED = 4
+}
+/**
+ * Additional tier for multi-tier bundle deals
+ */
+export interface BundleDealAdditionalTier {
+    /** The quantity of items that the buyers need to purchase for additional tier */
+    min_amount: number;
+    /** The bundle price when the buyers purchase a bundle deal for additional tiers */
+    fix_price?: number;
+    /** The bundle deal discount amount the buyer can save when purchasing a bundle deal */
+    discount_value?: number;
+    /** The bundle deal discount% that the buyer can get when buying a bundle deal for additional tiers */
+    discount_percentage?: number;
+}
+/**
+ * Bundle deal rule information
+ */
+export interface BundleDealRule {
+    /** The bundle deal rule type */
+    rule_type: BundleDealRuleType;
+    /** The deducted price when buying a bundle deal */
+    discount_value?: number;
+    /** The amount of the buyer needs to spend to purchase a bundle deal */
+    fix_price?: number;
+    /** The discount that the buyer can get when buying a bundle deal */
+    discount_percentage?: number;
+    /** The quantity of items that need buyer to combine purchased */
+    min_amount: number;
+    /** Additional tiers for tiered bundle deals (max 2 additional tiers) */
+    additional_tiers?: BundleDealAdditionalTier[];
+}
+/**
+ * Bundle deal item in list
+ */
+export interface BundleDealItem {
+    /** Shopee's unique identifier for an item */
+    item_id: number;
+}
+/**
+ * Bundle deal information
+ */
+export interface BundleDealInfo {
+    /** Shopee's unique identifier for a bundle deal activity */
+    bundle_deal_id: number;
+    /** Title of the bundle deal */
+    name: string;
+    /** The time when bundle deal activity start */
+    start_time: number;
+    /** The time when bundle deal activity end */
+    end_time: number;
+    /** Bundle deal rule configuration */
+    bundle_deal_rule: BundleDealRule;
+    /** Maximum number of bundle deals that can be bought by a buyer */
+    purchase_limit: number;
+}
+/**
+ * Failed item in batch operations
+ */
+export interface BundleDealFailedItem {
+    /** Shopee's unique identifier for an item */
+    item_id: number;
+    /** Error code */
+    fail_error: string;
+    /** Error message */
+    fail_message: string;
+}
+/**
+ * Parameters for adding a new bundle deal
+ */
+export interface AddBundleDealParams {
+    /** The bundle deal rule type */
+    rule_type: BundleDealRuleType;
+    /** The deducted price when buying a bundle deal (required when rule_type is DISCOUNT_VALUE) */
+    discount_value?: number;
+    /** The amount of the buyer needs to spend to purchase a bundle deal (required when rule_type is FIX_PRICE) */
+    fix_price?: number;
+    /** The discount that the buyer can get when buying a bundle deal (required when rule_type is DISCOUNT_PERCENTAGE) */
+    discount_percentage?: number;
+    /** The quantity of items that need buyer to combine purchased */
+    min_amount: number;
+    /** The time when bundle deal activity start */
+    start_time: number;
+    /** The time when bundle deal activity end */
+    end_time: number;
+    /** Title of the bundle deal */
+    name: string;
+    /** Maximum number of bundle deals that can be bought by a buyer */
+    purchase_limit: number;
+    /** Additional tiers for tiered bundle deals (max 2 additional tiers) */
+    additional_tiers?: BundleDealAdditionalTier[];
+}
+/**
+ * Parameters for adding items to a bundle deal
+ */
+export interface AddBundleDealItemParams {
+    /** Shopee's unique identifier for a bundle deal activity */
+    bundle_deal_id: number;
+    /** List of items to add to the bundle deal */
+    item_list: BundleDealItem[];
+}
+/**
+ * Parameters for deleting a bundle deal
+ */
+export interface DeleteBundleDealParams {
+    /** Shopee's unique identifier for a bundle deal activity */
+    bundle_deal_id: number;
+}
+/**
+ * Parameters for deleting items from a bundle deal
+ */
+export interface DeleteBundleDealItemParams {
+    /** Shopee's unique identifier for a bundle deal activity */
+    bundle_deal_id: number;
+    /** List of items to delete from the bundle deal */
+    item_list: BundleDealItem[];
+}
+/**
+ * Parameters for ending a bundle deal immediately
+ */
+export interface EndBundleDealParams {
+    /** Shopee's unique identifier for a bundle deal activity */
+    bundle_deal_id: number;
+}
+/**
+ * Parameters for getting bundle deal details
+ */
+export interface GetBundleDealParams {
+    /** Shopee's unique identifier for a bundle deal activity */
+    bundle_deal_id: number;
+}
+/**
+ * Parameters for getting bundle deal items
+ */
+export interface GetBundleDealItemParams {
+    /** Shopee's unique identifier for a bundle deal activity */
+    bundle_deal_id: number;
+}
+/**
+ * Parameters for getting a list of bundle deals
+ */
+export interface GetBundleDealListParams {
+    /** Data paging, representing the data size of each page (max: 1000, default: 20) */
+    page_size?: number;
+    /** The Status of bundle deal */
+    time_status?: BundleDealTimeStatus;
+    /** Data paging, represents the page number, starting from 1 (default: 1) */
+    page_no?: number;
+}
+/**
+ * Parameters for updating a bundle deal
+ */
+export interface UpdateBundleDealParams {
+    /** Shopee's unique identifier for a bundle deal activity */
+    bundle_deal_id: number;
+    /** The bundle deal rule type */
+    rule_type?: BundleDealRuleType;
+    /** The deducted price when buying a bundle deal */
+    discount_value?: number;
+    /** The amount of the buyer needs to spend to purchase a bundle deal */
+    fix_price?: number;
+    /** The discount that the buyer can get when buying a bundle deal */
+    discount_percentage?: number;
+    /** The quantity of items that need buyer to combine purchased */
+    min_amount?: number;
+    /** The time when bundle deal activity start */
+    start_time?: number;
+    /** The time when bundle deal activity end */
+    end_time?: number;
+    /** Title of the bundle deal */
+    name?: string;
+    /** Maximum number of bundle deals that can be bought by a buyer */
+    purchase_limit?: number;
+    /** Additional tiers for tiered bundle deals */
+    additional_tiers?: BundleDealAdditionalTier[];
+}
+/**
+ * Parameters for updating bundle deal items
+ */
+export interface UpdateBundleDealItemParams {
+    /** Shopee's unique identifier for a bundle deal activity */
+    bundle_deal_id: number;
+    /** List of items to update in the bundle deal */
+    item_list: BundleDealItem[];
+}
+/**
+ * Response for the add bundle deal API
+ */
+export interface AddBundleDealResponse extends BaseResponse {
+    response: {
+        /** Shopee's unique identifier for a bundle deal activity */
+        bundle_deal_id: number;
+    };
+}
+/**
+ * Response for the add bundle deal item API
+ */
+export interface AddBundleDealItemResponse extends BaseResponse {
+    response: {
+        /** List of items that failed to be added */
+        failed_list: BundleDealFailedItem[];
+        /** List of successfully added item IDs */
+        success_list: number[];
+    };
+}
+/**
+ * Response for the delete bundle deal API
+ */
+export interface DeleteBundleDealResponse extends BaseResponse {
+    response: {
+        /** Shopee's unique identifier for a bundle deal activity */
+        bundle_deal_id: number;
+    };
+}
+/**
+ * Response for the delete bundle deal item API
+ */
+export interface DeleteBundleDealItemResponse extends BaseResponse {
+    response: {
+        /** List of items that failed to be deleted */
+        failed_list: BundleDealFailedItem[];
+        /** List of successfully deleted item IDs */
+        success_list: number[];
+    };
+}
+/**
+ * Response for the end bundle deal API
+ */
+export interface EndBundleDealResponse extends BaseResponse {
+    response: {
+        /** Shopee's unique identifier for a bundle deal activity */
+        bundle_deal_id: number;
+    };
+}
+/**
+ * Response for the get bundle deal API
+ */
+export interface GetBundleDealResponse extends BaseResponse {
+    response: BundleDealInfo;
+}
+/**
+ * Response for the get bundle deal item API
+ */
+export interface GetBundleDealItemResponse extends BaseResponse {
+    response: {
+        /** List of items in the bundle deal */
+        item_list: number[];
+    };
+}
+/**
+ * Response for the get bundle deal list API
+ */
+export interface GetBundleDealListResponse extends BaseResponse {
+    response: {
+        /** The list of bundle deals */
+        bundle_deal_list: BundleDealInfo[];
+        /** Indicates whether there are more pages of bundle deals to retrieve */
+        more: boolean;
+    };
+}
+/**
+ * Response for the update bundle deal API
+ */
+export interface UpdateBundleDealResponse extends BaseResponse {
+    response: BundleDealInfo;
+}
+/**
+ * Response for the update bundle deal item API
+ */
+export interface UpdateBundleDealItemResponse extends BaseResponse {
+    response: {
+        /** List of items that failed to be updated */
+        failed_list: BundleDealFailedItem[];
+        /** List of successfully updated item IDs */
+        success_list: number[];
+    };
+}

package/lib/schemas/bundle-deal.js

@@ -0,0 +1,27 @@
+/**
+ * Bundle deal rule types
+ */
+export var BundleDealRuleType;
+(function (BundleDealRuleType) {
+    /** Fixed price for the bundle */
+    BundleDealRuleType[BundleDealRuleType["FIX_PRICE"] = 1] = "FIX_PRICE";
+    /** Discount percentage */
+    BundleDealRuleType[BundleDealRuleType["DISCOUNT_PERCENTAGE"] = 2] = "DISCOUNT_PERCENTAGE";
+    /** Discount value */
+    BundleDealRuleType[BundleDealRuleType["DISCOUNT_VALUE"] = 3] = "DISCOUNT_VALUE";
+})(BundleDealRuleType || (BundleDealRuleType = {}));
+/**
+ * Bundle deal time status for filtering
+ */
+export var BundleDealTimeStatus;
+(function (BundleDealTimeStatus) {
+    /** All bundle deals regardless of status */
+    BundleDealTimeStatus[BundleDealTimeStatus["ALL"] = 1] = "ALL";
+    /** Bundle deals that have not started yet */
+    BundleDealTimeStatus[BundleDealTimeStatus["UPCOMING"] = 2] = "UPCOMING";
+    /** Currently active bundle deals */
+    BundleDealTimeStatus[BundleDealTimeStatus["ONGOING"] = 3] = "ONGOING";
+    /** Bundle deals that have ended */
+    BundleDealTimeStatus[BundleDealTimeStatus["EXPIRED"] = 4] = "EXPIRED";
+})(BundleDealTimeStatus || (BundleDealTimeStatus = {}));
+//# sourceMappingURL=bundle-deal.js.map

package/lib/schemas/bundle-deal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bundle-deal.js","sourceRoot":"","sources":["../../src/schemas/bundle-deal.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,iCAAiC;IACjC,qEAAa,CAAA;IACb,0BAA0B;IAC1B,yFAAuB,CAAA;IACvB,qBAAqB;IACrB,+EAAkB,CAAA;AACpB,CAAC,EAPW,kBAAkB,KAAlB,kBAAkB,QAO7B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,oBASX;AATD,WAAY,oBAAoB;IAC9B,4CAA4C;IAC5C,6DAAO,CAAA;IACP,6CAA6C;IAC7C,uEAAY,CAAA;IACZ,oCAAoC;IACpC,qEAAW,CAAA;IACX,mCAAmC;IACnC,qEAAW,CAAA;AACb,CAAC,EATW,oBAAoB,KAApB,oBAAoB,QAS/B"}

package/lib/schemas/discount.d.ts

@@ -0,0 +1,334 @@
+import { BaseResponse } from "./base.js";
+/**
+ * Status of discounts for filtering in discount list query
+ */
+export declare enum DiscountStatus {
+    /** All discounts regardless of status */
+    ALL = "all",
+    /** Discounts that have not started yet */
+    UPCOMING = "upcoming",
+    /** Currently active discounts */
+    ONGOING = "ongoing",
+    /** Discounts that have ended */
+    EXPIRED = "expired"
+}
+/**
+ * Model information for discount items with variations
+ */
+export interface DiscountModel {
+    /** Shopee's unique identifier for a variation of an item */
+    model_id: number;
+    /** The discount price of the variation */
+    model_promotion_price: number;
+}
+/**
+ * Discount item information
+ */
+export interface DiscountItem {
+    /** Shopee's unique identifier for an item */
+    item_id: number;
+    /** The max number of this product in the promotion price */
+    purchase_limit?: number;
+    /** The discount price of the item. If there is variation, this field is not needed */
+    item_promotion_price?: number;
+    /** The list of variations for this item */
+    model_list?: DiscountModel[];
+}
+/**
+ * Parameters for adding a new discount
+ */
+export interface AddDiscountParams {
+    /** Title of the discount */
+    discount_name: string;
+    /** The time when discount activity start. Must be 1 hour later than current time */
+    start_time: number;
+    /** The time when discount activity end. Must be 1 hour later than start time, and the discount period must be less than 180 days */
+    end_time: number;
+}
+/**
+ * Parameters for adding items to a discount
+ */
+export interface AddDiscountItemParams {
+    /** Shopee's unique identifier for a discount activity */
+    discount_id: number;
+    /** The items added in this discount promotion */
+    item_list: DiscountItem[];
+}
+/**
+ * Parameters for deleting a discount
+ */
+export interface DeleteDiscountParams {
+    /** Shopee's unique identifier for a discount activity */
+    discount_id: number;
+}
+/**
+ * Parameters for deleting an item from a discount
+ */
+export interface DeleteDiscountItemParams {
+    /** Shopee's unique identifier for a discount activity */
+    discount_id: number;
+    /** Shopee's unique identifier for an item */
+    item_id: number;
+    /** Shopee's unique identifier for a variation of an item. If item has no variation, set to 0 */
+    model_id?: number;
+}
+/**
+ * Parameters for ending a discount immediately
+ */
+export interface EndDiscountParams {
+    /** Shopee's unique identifier for a discount activity */
+    discount_id: number;
+}
+/**
+ * Parameters for getting discount details
+ */
+export interface GetDiscountParams {
+    /** Shopee's unique identifier for a discount activity */
+    discount_id: number;
+    /** Specifies the page number of data to return. Starting from 1 */
+    page_no: number;
+    /** Maximum number of entries to retrieve per page */
+    page_size: number;
+    [key: string]: string | number | boolean | undefined;
+}
+/**
+ * Parameters for getting a list of discounts
+ */
+export interface GetDiscountListParams {
+    /** The status of discount promotion */
+    discount_status: DiscountStatus;
+    /** Specifies the page number of data to return. Default 1 */
+    page_no?: number;
+    /** Maximum number of entries to retrieve per page. Default 100, max 100 */
+    page_size?: number;
+    [key: string]: string | number | boolean | undefined;
+}
+/**
+ * Parameters for updating a discount
+ */
+export interface UpdateDiscountParams {
+    /** Shopee's unique identifier for a discount activity */
+    discount_id: number;
+    /** Title of the discount */
+    discount_name?: string;
+    /** The time when discount activity start */
+    start_time?: number;
+    /** The time when discount activity end */
+    end_time?: number;
+}
+/**
+ * Parameters for updating discount items
+ */
+export interface UpdateDiscountItemParams {
+    /** Shopee's unique identifier for a discount activity */
+    discount_id: number;
+    /** The items to update in this discount promotion */
+    item_list: DiscountItem[];
+}
+/**
+ * Error information for failed item operations
+ */
+export interface DiscountItemError {
+    /** The item ID that failed */
+    item_id?: number;
+    /** The model ID that failed */
+    model_id?: number;
+    /** The error message */
+    fail_message?: string;
+    /** The error code */
+    fail_error?: string;
+}
+/**
+ * Model information in get discount response
+ */
+export interface DiscountModelInfo {
+    /** Shopee's unique identifier for a variation of an item */
+    model_id: number;
+    /** Name of the variation that belongs to the same item */
+    model_name: string;
+    /** The current stock quantity of the variation */
+    model_normal_stock: number;
+    /** The reserved stock of the model */
+    model_promotion_stock: number;
+    /** The original price before discount of the variation */
+    model_original_price: number;
+    /** The discount price of the variation */
+    model_promotion_price: number;
+    /** The original price after tax of model (Only for taxable Shop) */
+    model_inflated_price_of_original_price?: number;
+    /** The discount price after tax of model (Only for taxable Shop) */
+    model_inflated_price_of_promotion_price?: number;
+    /** The local price of model */
+    model_local_price?: number;
+    /** The local discount price of model */
+    model_local_promotion_price?: number;
+    /** The local price after tax of model (Only for taxable Shop) */
+    model_local_price_inflated?: number;
+    /** The local discount price after tax of model (Only for taxable Shop) */
+    model_local_promotion_price_inflated?: number;
+}
+/**
+ * Item information in get discount response
+ */
+export interface DiscountItemInfo {
+    /** Shopee's unique identifier for an item */
+    item_id: number;
+    /** Name of the item in local language */
+    item_name: string;
+    /** The current stock quantity of the item */
+    normal_stock: number;
+    /** The reserved stock of the item */
+    item_promotion_stock: number;
+    /** The original price before discount of the item */
+    item_original_price: number;
+    /** The discount price of the item */
+    item_promotion_price: number;
+    /** The original price after tax of item (Only for taxable Shop) */
+    item_inflated_price_of_original_price?: number;
+    /** The discount price after tax of item (Only for taxable Shop) */
+    item_inflated_price_of_promotion_price?: number;
+    /** The local price of item */
+    item_local_price?: number;
+    /** The local discount price of item */
+    item_local_promotion_price?: number;
+    /** The local price after tax of item (Only for taxable Shop) */
+    item_local_price_inflated?: number;
+    /** The local discount price after tax of item (Only for taxable Shop) */
+    item_local_promotion_price_inflated?: number;
+    /** The list of variations for this item */
+    model_list: DiscountModelInfo[];
+    /** The max number of this product in the promotion price */
+    purchase_limit: number;
+}
+/**
+ * Discount information in list response
+ */
+export interface DiscountInfo {
+    /** The status of discount promotion */
+    status: string;
+    /** Title of the discount */
+    discount_name: string;
+    /** The time when discount activity start */
+    start_time: number;
+    /** Shopee's unique identifier for a discount activity */
+    discount_id: number;
+    /** The source of the discount. 0: seller created, 1: Shopee created */
+    source?: number;
+    /** The time when discount activity end */
+    end_time: number;
+}
+/**
+ * Response for the add discount API
+ */
+export interface AddDiscountResponse extends BaseResponse {
+    response: {
+        /** Shopee's unique identifier for a discount activity */
+        discount_id: number;
+    };
+}
+/**
+ * Response for the add discount item API
+ */
+export interface AddDiscountItemResponse extends BaseResponse {
+    response: {
+        /** Shopee's unique identifier for a discount activity */
+        discount_id: number;
+        /** The number of items successfully added */
+        count: number;
+        /** List of items that failed to be added */
+        error_list: DiscountItemError[];
+        /** Warning message if any */
+        warning?: string;
+    };
+}
+/**
+ * Response for the delete discount API
+ */
+export interface DeleteDiscountResponse extends BaseResponse {
+    response: {
+        /** Shopee's unique identifier for a discount activity */
+        discount_id: number;
+        /** The time when the discount was modified */
+        modify_time: number;
+    };
+}
+/**
+ * Response for the delete discount item API
+ */
+export interface DeleteDiscountItemResponse extends BaseResponse {
+    response: {
+        /** Shopee's unique identifier for a discount activity */
+        discount_id: number;
+        /** List of items that failed to be deleted */
+        error_list: DiscountItemError[];
+    };
+}
+/**
+ * Response for the end discount API
+ */
+export interface EndDiscountResponse extends BaseResponse {
+    response: {
+        /** Shopee's unique identifier for a discount activity */
+        discount_id: number;
+        /** The time when the discount was modified */
+        modify_time: number;
+    };
+}
+/**
+ * Response for the get discount API
+ */
+export interface GetDiscountResponse extends BaseResponse {
+    response: {
+        /** The status of discount promotion */
+        status: string;
+        /** Title of the discount */
+        discount_name: string;
+        /** The items selected in this discount */
+        item_list: DiscountItemInfo[];
+        /** The time when discount activity start */
+        start_time: number;
+        /** Shopee's unique identifier for a discount activity */
+        discount_id: number;
+        /** The time when discount activity end */
+        end_time: number;
+        /** This is to indicate whether the item list is more than one page */
+        more: boolean;
+    };
+}
+/**
+ * Response for the get discount list API
+ */
+export interface GetDiscountListResponse extends BaseResponse {
+    response: {
+        /** The list of discounts matching the query parameters */
+        discount_list: DiscountInfo[];
+        /** Indicates whether there are more pages of discounts to retrieve */
+        more: boolean;
+    };
+}
+/**
+ * Response for the update discount API
+ */
+export interface UpdateDiscountResponse extends BaseResponse {
+    response: {
+        /** Shopee's unique identifier for a discount activity */
+        discount_id: number;
+        /** The time when the discount was modified */
+        modify_time: number;
+    };
+}
+/**
+ * Response for the update discount item API
+ */
+export interface UpdateDiscountItemResponse extends BaseResponse {
+    response: {
+        /** Shopee's unique identifier for a discount activity */
+        discount_id: number;
+        /** The number of items successfully updated */
+        count: number;
+        /** List of items that failed to be updated */
+        error_list: DiscountItemError[];
+    };
+    /** Warning message if any */
+    warning?: string;
+}

package/lib/schemas/discount.js

@@ -0,0 +1,15 @@
+/**
+ * Status of discounts for filtering in discount list query
+ */
+export var DiscountStatus;
+(function (DiscountStatus) {
+    /** All discounts regardless of status */
+    DiscountStatus["ALL"] = "all";
+    /** Discounts that have not started yet */
+    DiscountStatus["UPCOMING"] = "upcoming";
+    /** Currently active discounts */
+    DiscountStatus["ONGOING"] = "ongoing";
+    /** Discounts that have ended */
+    DiscountStatus["EXPIRED"] = "expired";
+})(DiscountStatus || (DiscountStatus = {}));
+//# sourceMappingURL=discount.js.map

package/lib/schemas/discount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"discount.js","sourceRoot":"","sources":["../../src/schemas/discount.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,cASX;AATD,WAAY,cAAc;IACxB,yCAAyC;IACzC,6BAAW,CAAA;IACX,0CAA0C;IAC1C,uCAAqB,CAAA;IACrB,iCAAiC;IACjC,qCAAmB,CAAA;IACnB,gCAAgC;IAChC,qCAAmB,CAAA;AACrB,CAAC,EATW,cAAc,KAAd,cAAc,QASzB"}