@congminh1254/shopee-sdk 0.4.0 → 0.6.0

package/lib/schemas/ads.d.ts

@@ -60,3 +60,459 @@ export interface GetRecommendedKeywordListResponse extends BaseResponse {
     /** Optional warning message if some data cannot be responded normally */
     warning?: string;
 }
+/**
+ * Response for the get recommended item list API
+ */
+export interface GetRecommendedItemListResponse extends BaseResponse {
+    response: Array<{
+        /** Recommended SKU's item id */
+        item_id: number;
+        /** This is param to indicate the status of items, so sellers can know whether an item is eligible for ads or not */
+        item_status_list: string[];
+        /** The corresponding tag (or tags) that belong to item_id, sequences follow as best selling>best ROI>top search */
+        sku_tag_list: string[];
+        /** Current status of the ad on this item. For example- no ongoing promotion, search ads, discovery ads, boost ads */
+        ongoing_ad_type_list: string[];
+    }>;
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get all CPC ads hourly performance API
+ */
+export type GetAllCpcAdsHourlyPerformanceParams = {
+    /** Single date on which to check the hourly performance (DD-MM-YYYY format) */
+    performance_date: string;
+};
+/**
+ * Response for the get all CPC ads hourly performance API
+ */
+export interface GetAllCpcAdsHourlyPerformanceResponse extends BaseResponse {
+    response: Array<{
+        /** Hour the performance record belongs to */
+        hour: number;
+        /** Date the performance record belongs to (DD-MM-YYYY format) */
+        date: string;
+        /** Number of times buyers see ads */
+        impression: number;
+        /** Total number of clicks on the Ad */
+        clicks: number;
+        /** Click-through rate (Clicks / Impressions) */
+        ctr: number;
+        /** Direct conversions - buyer placed an order within 7 days after clicking on the ads (item gets purchased from the clicked ads) */
+        direct_order: number;
+        /** Broad conversions - buyer placed an order within 7 days after clicking on the ads (any item from the same shop) */
+        broad_order: number;
+        /** Direct conversion rate (Ad orders / total clicks) - item gets purchased from the clicked ads */
+        direct_conversions: number;
+        /** Broad conversion rate (Ad orders / total clicks) - any item from the same shop gets purchased */
+        broad_conversions: number;
+        /** Items sold within 7 days after clicking on the ads (item gets purchased from the clicked ads) */
+        direct_item_sold: number;
+        /** Items sold within 7 days after clicking on the ads (any item from the same shop) */
+        broad_item_sold: number;
+        /** Total direct sales generated from ads over a 7-day window (item gets purchased from the clicked ads) */
+        direct_gmv: number;
+        /** Total broad sales generated from ads over a 7-day window (any item from the same shop) */
+        broad_gmv: number;
+        /** Ad expenditure */
+        expense: number;
+        /** Cost per conversion - ad's average cost per sales conversion */
+        cost_per_conversion: number;
+        /** Direct ROAS - Ad GMV/Ad Expenditure (item gets purchased from the clicked ads) */
+        direct_roas: number;
+        /** Broad ROAS - Ad GMV/Ad Expenditure (any item from the same shop gets purchased) */
+        broad_roas: number;
+    }>;
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get all CPC ads daily performance API
+ */
+export type GetAllCpcAdsDailyPerformanceParams = {
+    /** Start date of the performance data range (DD-MM-YYYY format) */
+    start_date: string;
+    /** End date of the performance data range (DD-MM-YYYY format) */
+    end_date: string;
+};
+/**
+ * Response for the get all CPC ads daily performance API
+ */
+export interface GetAllCpcAdsDailyPerformanceResponse extends BaseResponse {
+    response: Array<{
+        /** Date the performance record belongs to (DD-MM-YYYY format) */
+        date: string;
+        /** Number of times buyers see ads */
+        impression: number;
+        /** Total number of clicks on the Ad */
+        clicks: number;
+        /** Click-through rate (Clicks / Impressions) */
+        ctr: number;
+        /** Direct conversions - buyer placed an order within 7 days after clicking on the ads (item gets purchased from the clicked ads) */
+        direct_order: number;
+        /** Broad conversions - buyer placed an order within 7 days after clicking on the ads (any item from the same shop) */
+        broad_order: number;
+        /** Direct conversion rate (Ad orders / total clicks) - item gets purchased from the clicked ads */
+        direct_conversions: number;
+        /** Broad conversion rate (Ad orders / total clicks) - any item from the same shop gets purchased */
+        broad_conversions: number;
+        /** Items sold within 7 days after clicking on the ads (item gets purchased from the clicked ads) */
+        direct_item_sold: number;
+        /** Items sold within 7 days after clicking on the ads (any item from the same shop) */
+        broad_item_sold: number;
+        /** Total direct sales generated from ads over a 7-day window (item gets purchased from the clicked ads) */
+        direct_gmv: number;
+        /** Total broad sales generated from ads over a 7-day window (any item from the same shop) */
+        broad_gmv: number;
+        /** Ad expenditure */
+        expense: number;
+        /** Cost per conversion - ad's average cost per sales conversion */
+        cost_per_conversion: number;
+        /** Direct ROAS - Ad GMV/Ad Expenditure (item gets purchased from the clicked ads) */
+        direct_roas: number;
+        /** Broad ROAS - Ad GMV/Ad Expenditure (any item from the same shop gets purchased) */
+        broad_roas: number;
+    }>;
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get product campaign daily performance API
+ */
+export type GetProductCampaignDailyPerformanceParams = {
+    /** Start date of the performance data range (DD-MM-YYYY format) */
+    start_date: string;
+    /** End date of the performance data range (DD-MM-YYYY format) */
+    end_date: string;
+    /** Comma-separated list of campaign IDs to fetch performance for (max 100) */
+    campaign_id_list: string;
+};
+/**
+ * Response for the get product campaign daily performance API
+ */
+export interface GetProductCampaignDailyPerformanceResponse extends BaseResponse {
+    response: Array<{
+        /** The unique ID for the shop */
+        shop_id: number;
+        /** The region where the shop is located */
+        region: string;
+        /** List of campaigns and their performance data */
+        campaign_list: Array<{
+            /** The unique ID for the campaign */
+            campaign_id: number;
+            /** The ad type (auto or manual) */
+            ad_type: string;
+            /** The campaign placement (search, discovery, or all) */
+            campaign_placement: string;
+            /** The name of the ad */
+            ad_name: string;
+            /** List of daily performance metrics for the campaign */
+            metrics_list: Array<{
+                /** Date of the performance record (DD-MM-YYYY format) */
+                date: string;
+                /** Number of times shoppers see the ad */
+                impression: number;
+                /** Number of times shoppers click on the ad */
+                clicks: number;
+                /** Click-through rate (clicks ÷ impressions × 100%) */
+                ctr: number;
+                /** Amount spent on the ad */
+                expense: number;
+                /** Sales revenue generated from any product purchase within 7 days of ad click */
+                broad_gmv: number;
+                /** Number of orders placed within 7 days of ad click */
+                broad_order: number;
+                /** Total quantity of products purchased within 7 days of ad click */
+                broad_order_amount: number;
+                /** Broad return on ad spend (broad_gmv ÷ expense) */
+                broad_roi: number;
+                /** Broad advertising cost of sales (expense ÷ broad_gmv × 100%) */
+                broad_cir: number;
+                /** Conversion rate (conversions ÷ clicks × 100%) */
+                cr: number;
+                /** Cost per conversion (expense ÷ conversions) */
+                cpc: number;
+                /** Number of orders for the advertised product within 7 days of ad click */
+                direct_order: number;
+                /** Total quantity of the advertised product purchased within 7 days of ad click */
+                direct_order_amount: number;
+                /** Sales revenue generated from the advertised product within 7 days of ad click */
+                direct_gmv: number;
+                /** Direct return on ad spend (direct_gmv ÷ expense) */
+                direct_roi: number;
+                /** Direct advertising cost of sales (expense ÷ direct_gmv × 100%) */
+                direct_cir: number;
+                /** Direct conversion rate (direct conversions ÷ clicks × 100%) */
+                direct_cr: number;
+                /** Cost per direct conversion (expense ÷ direct conversions) */
+                cpdc: number;
+            }>;
+        }>;
+    }>;
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get product campaign hourly performance API
+ */
+export type GetProductCampaignHourlyPerformanceParams = {
+    /** Single date for the hourly performance data (DD-MM-YYYY format) */
+    performance_date: string;
+    /** Comma-separated list of campaign IDs to fetch performance for (max 100) */
+    campaign_id_list: string;
+};
+/**
+ * Response for the get product campaign hourly performance API
+ */
+export interface GetProductCampaignHourlyPerformanceResponse extends BaseResponse {
+    response: Array<{
+        /** The unique ID for the shop */
+        shop_id: number;
+        /** The region where the shop is located */
+        region: string;
+        /** List of campaigns and their performance data */
+        campaign_list: Array<{
+            /** The unique ID for the campaign */
+            campaign_id: number;
+            /** The ad type (auto or manual) */
+            ad_type: string;
+            /** The campaign placement (search, discovery, or all) */
+            campaign_placement: string;
+            /** The name of the ad */
+            ad_name: string;
+            /** List of hourly performance metrics for the campaign */
+            metrics_list: Array<{
+                /** Hour the performance record belongs to */
+                hour: number;
+                /** Date of the performance record (DD-MM-YYYY format) */
+                date: string;
+                /** Number of times shoppers see the ad */
+                impression: number;
+                /** Number of times shoppers click on the ad */
+                clicks: number;
+                /** Click-through rate (clicks ÷ impressions × 100%) */
+                ctr: number;
+                /** Amount spent on the ad */
+                expense: number;
+                /** Sales revenue generated from any product purchase within 7 days of ad click */
+                broad_gmv: number;
+                /** Number of orders placed within 7 days of ad click */
+                broad_order: number;
+                /** Total quantity of products purchased within 7 days of ad click */
+                broad_order_amount: number;
+                /** Broad return on ad spend (broad_gmv ÷ expense) */
+                broad_roi: number;
+                /** Broad advertising cost of sales (expense ÷ broad_gmv × 100%) */
+                broad_cir: number;
+                /** Conversion rate (conversions ÷ clicks × 100%) */
+                cr: number;
+                /** Cost per conversion (expense ÷ conversions) */
+                cpc: number;
+                /** Number of orders for the advertised product within 7 days of ad click */
+                direct_order: number;
+                /** Total quantity of the advertised product purchased within 7 days of ad click */
+                direct_order_amount: number;
+                /** Sales revenue generated from the advertised product within 7 days of ad click */
+                direct_gmv: number;
+                /** Direct return on ad spend (direct_gmv ÷ expense) */
+                direct_roi: number;
+                /** Direct advertising cost of sales (expense ÷ direct_gmv × 100%) */
+                direct_cir: number;
+                /** Direct conversion rate (direct conversions ÷ clicks × 100%) */
+                direct_cr: number;
+                /** Cost per direct conversion (expense ÷ direct conversions) */
+                cpdc: number;
+            }>;
+        }>;
+    }>;
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get product level campaign ID list API
+ */
+export type GetProductLevelCampaignIdListParams = {
+    /**
+     * Filter campaigns by ad type
+     * Can be any of ["", "all", "auto", "manual"]
+     */
+    ad_type?: string;
+    /** Pagination offset */
+    offset?: number;
+    /** Page size limit (number of results to return) */
+    limit?: number;
+};
+/**
+ * Response for the get product level campaign ID list API
+ */
+export interface GetProductLevelCampaignIdListResponse extends BaseResponse {
+    response: {
+        /** The unique ID for the shop */
+        shop_id: number;
+        /** The region where the shop is located */
+        region: string;
+        /** Indicates if there are more campaigns on the next page */
+        has_next_page: boolean;
+        /** List of campaigns */
+        campaign_list: Array<{
+            /** The ad type (auto or manual) */
+            ad_type: string;
+            /** The unique ID for the campaign */
+            campaign_id: number;
+        }>;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get product level campaign setting info API
+ */
+export type GetProductLevelCampaignSettingInfoParams = {
+    /**
+     * Info types to retrieve, comma-separated
+     * 1: Common Info
+     * 2: Manual Bidding Info
+     * 3: Auto Bidding Info
+     * 4: Auto Product Ads Info
+     */
+    info_type_list: string;
+    /** Comma-separated list of campaign IDs to fetch settings for (max 100) */
+    campaign_id_list: string;
+};
+/**
+ * Response for the get product level campaign setting info API
+ */
+export interface GetProductLevelCampaignSettingInfoResponse extends BaseResponse {
+    response: {
+        /** The unique ID for the shop */
+        shop_id: number;
+        /** The region where the shop is located */
+        region: string;
+        /** List of campaigns with their settings */
+        campaign_list: Array<{
+            /** The unique ID for the campaign */
+            campaign_id: number;
+            /** Common campaign information (returned if info_type_list includes 1) */
+            common_info?: {
+                /** The ad type (auto or manual) */
+                ad_type: string;
+                /** The name of the ad */
+                ad_name: string;
+                /** Campaign status (ongoing, scheduled, ended, paused, deleted, closed) */
+                campaign_status: string;
+                /** Bidding method (auto or manual) */
+                bidding_method: string;
+                /** Campaign placement (search, discovery, or all) */
+                campaign_placement: string;
+                /** The budget per campaign (0 means unlimited budget) */
+                campaign_budget: number;
+                /** Campaign duration */
+                campaign_duration: {
+                    /** Campaign start time (Unix timestamp) */
+                    start_time: number;
+                    /** Campaign end time (Unix timestamp, 0 means no end date) */
+                    end_time: number;
+                };
+                /** List of item IDs in the campaign */
+                item_id_list: number[];
+            };
+            /** Manual bidding information (returned if info_type_list includes 2) */
+            manual_bidding_info?: {
+                /** Whether Enhanced CPC functionality is enabled */
+                enhanced_cpc: boolean;
+                /** Selected keywords for search campaigns */
+                selected_keywords: Array<{
+                    /** Bid keyword */
+                    keyword: string;
+                    /** Keyword status (deleted, normal, reserved, blacklist) */
+                    status: string;
+                    /** Match type (exact or broad) */
+                    match_type: string;
+                    /** Bid price per click */
+                    bid_price_per_click: number;
+                }>;
+                /** Discovery ads placement settings */
+                discovery_ads_locations: Array<{
+                    /** Location (daily_discover, you_may_also_like) */
+                    location: string;
+                    /** Status (active or inactive) */
+                    status: string;
+                    /** Bid price */
+                    bid_price: number;
+                }>;
+            };
+            /** Auto bidding information (returned if info_type_list includes 3) */
+            auto_bidding_info?: {
+                /** ROAS target for campaigns with auto bidding */
+                roas_target: number;
+            };
+            /** Auto product ads information (returned if info_type_list includes 4) */
+            auto_product_ads_info?: Array<{
+                /** Product name */
+                product_name: string;
+                /** Product status (learning, ongoing, paused, ended, unavailable) */
+                status: string;
+                /** Unique identifier for the product */
+                item_id: number;
+            }>;
+        }>;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get product recommended ROI target API
+ */
+export type GetProductRecommendedRoiTargetParams = {
+    /**
+     * A random string used to prevent duplicate ads.
+     * If an ads is created successfully, subsequent requests using the same reference id will fail.
+     * Use the same string for calling suggestion/recommendation API before the actual request to create an ads.
+     */
+    reference_id: string;
+    /** Unique identifier for a product */
+    item_id: number;
+};
+/**
+ * Response for the get product recommended ROI target API
+ */
+export interface GetProductRecommendedRoiTargetResponse extends BaseResponse {
+    response: {
+        /**
+         * Lower bound recommendation.
+         * e.g., value=3.5 and percentile=80 mean that setting an ROI target of 3.5
+         * makes the ads more competitive than 80% of similar ads.
+         */
+        lower_bound: {
+            /** The ROI target value */
+            value: number;
+            /** Competitiveness over similar ads */
+            percentile: number;
+        };
+        /**
+         * Mid-level recommendation.
+         * e.g., value=5.9 and percentile=50 mean that setting an ROI target of 5.9
+         * makes the ads more competitive than 50% of similar ads.
+         */
+        exact: {
+            /** The ROI target value */
+            value: number;
+            /** Competitiveness over similar ads */
+            percentile: number;
+        };
+        /**
+         * Higher bound recommendation.
+         * e.g., value=10.8 and percentile=20 mean that setting an ROI target of 10.8
+         * makes the ads more competitive than 20% of similar ads.
+         */
+        upper_bound: {
+            /** The ROI target value */
+            value: number;
+            /** Competitiveness over similar ads */
+            percentile: number;
+        };
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}

package/lib/schemas/attribute.d.ts

@@ -1,7 +1,7 @@
-export type InputValidationType = 'INT_TYPE' | 'STRING_TYPE' | 'ENUM_TYPE' | 'FLOAT_TYPE' | 'DATE_TYPE' | 'TIMESTAMP_TYPE';
-export type FormatType = 'NORMAL' | 'QUANTITATIVE';
-export type DateFormatType = 'YEAR_MONTH_DATE' | 'YEAR_MONTH';
-export type InputType = 'DROP_DOWN' | 'MULTIPLE_SELECT' | 'TEXT_FILED' | 'COMBO_BOX' | 'MULTIPLE_SELECT_COMBO_BOX';
+export type InputValidationType = "INT_TYPE" | "STRING_TYPE" | "ENUM_TYPE" | "FLOAT_TYPE" | "DATE_TYPE" | "TIMESTAMP_TYPE";
+export type FormatType = "NORMAL" | "QUANTITATIVE";
+export type DateFormatType = "YEAR_MONTH_DATE" | "YEAR_MONTH";
+export type InputType = "DROP_DOWN" | "MULTIPLE_SELECT" | "TEXT_FILED" | "COMBO_BOX" | "MULTIPLE_SELECT_COMBO_BOX";
 export interface AttributeValue {
     value_id: number;
     original_value_name: string;

package/lib/schemas/fetch.d.ts

@@ -1,5 +1,5 @@
-import { RequestInit } from 'node-fetch';
-export type FetchOptions = Omit<RequestInit, 'body'> & {
+import { RequestInit } from "node-fetch";
+export type FetchOptions = Omit<RequestInit, "body"> & {
     params?: Record<string, string | number | boolean | undefined | null | (string | number | boolean)[]>;
     body?: unknown;
     auth?: boolean;

package/lib/schemas/index.d.ts

@@ -1,11 +1,12 @@
-export * from './access-token.js';
-export * from './attribute.js';
-export * from './authed-merchant.js';
-export * from './authed-shop.js';
-export * from './category.js';
-export * from './fetch.js';
-export * from './order.js';
-export * from './product.js';
-export * from './public.js';
-export * from './push.js';
-export * from './region.js';
+export * from "./access-token.js";
+export * from "./attribute.js";
+export * from "./authed-merchant.js";
+export * from "./authed-shop.js";
+export * from "./category.js";
+export * from "./fetch.js";
+export * from "./order.js";
+export * from "./product.js";
+export * from "./public.js";
+export * from "./push.js";
+export * from "./region.js";
+export * from "./ads.js";

package/lib/schemas/index.js

@@ -1,12 +1,13 @@
-export * from './access-token.js';
-export * from './attribute.js';
-export * from './authed-merchant.js';
-export * from './authed-shop.js';
-export * from './category.js';
-export * from './fetch.js';
-export * from './order.js';
-export * from './product.js';
-export * from './public.js';
-export * from './push.js';
-export * from './region.js';
+export * from "./access-token.js";
+export * from "./attribute.js";
+export * from "./authed-merchant.js";
+export * from "./authed-shop.js";
+export * from "./category.js";
+export * from "./fetch.js";
+export * from "./order.js";
+export * from "./product.js";
+export * from "./public.js";
+export * from "./push.js";
+export * from "./region.js";
+export * from "./ads.js";
 //# sourceMappingURL=index.js.map

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"}
+{"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"}

package/lib/schemas/logistics.d.ts

@@ -1,4 +1,4 @@
-import { BaseResponse } from './base.js';
+import { BaseResponse } from "./base.js";
 /**
  * Enum for logistics status
  */

package/lib/schemas/order.d.ts

@@ -1,4 +1,4 @@
-import { FetchResponse } from './fetch.js';
+import { FetchResponse } from "./fetch.js";
 /**
  * Represents an item in an order with detailed product information
  */
@@ -73,31 +73,31 @@ export interface PackageItem {
  */
 export type LogisticsStatus = 
 /** Initial status, order not ready for fulfillment */
-'LOGISTICS_NOT_STARTED'
+"LOGISTICS_NOT_STARTED"
 /** order arranged shipment */
- | 'LOGISTICS_REQUEST_CREATED'
+ | "LOGISTICS_REQUEST_CREATED"
 /** order handed over to 3PL */
- | 'LOGISTICS_PICKUP_DONE'
+ | "LOGISTICS_PICKUP_DONE"
 /** order pending 3PL retry pickup */
- | 'LOGISTICS_PICKUP_RETRY'
+ | "LOGISTICS_PICKUP_RETRY"
 /** order cancelled by 3PL due to failed pickup or picked up but not able to proceed with delivery */
- | 'LOGISTICS_PICKUP_FAILED'
+ | "LOGISTICS_PICKUP_FAILED"
 /** order successfully delivered */
- | 'LOGISTICS_DELIVERY_DONE'
+ | "LOGISTICS_DELIVERY_DONE"
 /** order cancelled due to 3PL delivery failed */
- | 'LOGISTICS_DELIVERY_FAILED'
+ | "LOGISTICS_DELIVERY_FAILED"
 /** order cancelled when order at LOGISTICS_REQUEST_CREATED */
- | 'LOGISTICS_REQUEST_CANCELED'
+ | "LOGISTICS_REQUEST_CANCELED"
 /** Integrated logistics COD: Order rejected for COD */
- | 'LOGISTICS_COD_REJECTED'
+ | "LOGISTICS_COD_REJECTED"
 /** order ready for fulfilment from payment perspective: non-COD: order paid, COD: order passed COD screening */
- | 'LOGISTICS_READY'
+ | "LOGISTICS_READY"
 /** order cancelled when order at LOGISTICS_READY */
- | 'LOGISTICS_INVALID'
+ | "LOGISTICS_INVALID"
 /** order cancelled due to 3PL lost the order */
- | 'LOGISTICS_LOST'
+ | "LOGISTICS_LOST"
 /** order logistics pending arrangement */
- | 'LOGISTICS_PENDING_ARRANGE';
+ | "LOGISTICS_PENDING_ARRANGE";
 /**
  * Represents a package in an order with shipping information
  */
@@ -262,31 +262,31 @@ export interface Order {
 /**
  * The kind of time range field for order list query
  */
-export type TimeRangeField = 'create_time' | 'update_time';
+export type TimeRangeField = "create_time" | "update_time";
 /**
  * The status of an order
  */
 export type OrderStatus = 
 /** Order is created, buyer has not paid yet */
-'UNPAID'
+"UNPAID"
 /** Seller can arrange shipment */
- | 'READY_TO_SHIP'
+ | "READY_TO_SHIP"
 /** Seller has arranged shipment online and got tracking number from 3PL */
- | 'PROCESSED'
+ | "PROCESSED"
 /** 3PL pickup parcel fail. Need to re arrange shipment */
- | 'RETRY_SHIP'
+ | "RETRY_SHIP"
 /** The parcel has been drop to 3PL or picked up by 3PL */
- | 'SHIPPED'
+ | "SHIPPED"
 /** The order has been received by buyer */
- | 'TO_CONFIRM_RECEIVE'
+ | "TO_CONFIRM_RECEIVE"
 /** The order's cancelation is under processing */
- | 'IN_CANCEL'
+ | "IN_CANCEL"
 /** The order has been canceled */
- | 'CANCELLED'
+ | "CANCELLED"
 /** The buyer requested to return the order and order's return is processing */
- | 'TO_RETURN'
+ | "TO_RETURN"
 /** The order has been completed */
- | 'COMPLETED';
+ | "COMPLETED";
 /**
  * Represents a single order in the order list response
  */
@@ -334,7 +334,7 @@ export interface GetOrderListResponse extends FetchResponse<{
 }> {
 }
 export declare const allOptionalFields = "buyer_user_id,buyer_username,estimated_shipping_fee,recipient_address,actual_shipping_fee,goods_to_declare,note,note_update_time,item_list,pay_time,dropshipper,dropshipper_phone,split_up,buyer_cancel_reason,cancel_by,cancel_reason,actual_shipping_fee_confirmed,buyer_cpf_id,fulfillment_flag,pickup_done_time,package_list,shipping_carrier,payment_method,total_amount,invoice_data,order_chargeable_weight_gram,return_request_due_date,edt";
-export type OrderDetailOptionalFields = 'buyer_user_id' | 'buyer_username' | 'estimated_shipping_fee' | 'recipient_address' | 'actual_shipping_fee' | 'goods_to_declare' | 'note' | 'note_update_time' | 'item_list' | 'pay_time' | 'dropshipper' | 'dropshipper_phone' | 'split_up' | 'buyer_cancel_reason' | 'cancel_by' | 'cancel_reason' | 'actual_shipping_fee_confirmed' | 'buyer_cpf_id' | 'fulfillment_flag' | 'pickup_done_time' | 'package_list' | 'shipping_carrier' | 'payment_method' | 'total_amount' | 'invoice_data' | 'order_chargeable_weight_gram' | 'return_request_due_date' | 'edt';
+export type OrderDetailOptionalFields = "buyer_user_id" | "buyer_username" | "estimated_shipping_fee" | "recipient_address" | "actual_shipping_fee" | "goods_to_declare" | "note" | "note_update_time" | "item_list" | "pay_time" | "dropshipper" | "dropshipper_phone" | "split_up" | "buyer_cancel_reason" | "cancel_by" | "cancel_reason" | "actual_shipping_fee_confirmed" | "buyer_cpf_id" | "fulfillment_flag" | "pickup_done_time" | "package_list" | "shipping_carrier" | "payment_method" | "total_amount" | "invoice_data" | "order_chargeable_weight_gram" | "return_request_due_date" | "edt";
 /**
  * Parameters for getting order details
  */

package/lib/schemas/order.js

@@ -1,2 +1,2 @@
-export const allOptionalFields = 'buyer_user_id,buyer_username,estimated_shipping_fee,recipient_address,actual_shipping_fee,goods_to_declare,note,note_update_time,item_list,pay_time,dropshipper,dropshipper_phone,split_up,buyer_cancel_reason,cancel_by,cancel_reason,actual_shipping_fee_confirmed,buyer_cpf_id,fulfillment_flag,pickup_done_time,package_list,shipping_carrier,payment_method,total_amount,invoice_data,order_chargeable_weight_gram,return_request_due_date,edt';
+export const allOptionalFields = "buyer_user_id,buyer_username,estimated_shipping_fee,recipient_address,actual_shipping_fee,goods_to_declare,note,note_update_time,item_list,pay_time,dropshipper,dropshipper_phone,split_up,buyer_cancel_reason,cancel_by,cancel_reason,actual_shipping_fee_confirmed,buyer_cpf_id,fulfillment_flag,pickup_done_time,package_list,shipping_carrier,payment_method,total_amount,invoice_data,order_chargeable_weight_gram,return_request_due_date,edt";
 //# sourceMappingURL=order.js.map

package/lib/schemas/payment.d.ts

@@ -1,4 +1,4 @@
-import { BaseResponse } from '../schemas/base.js';
+import { BaseResponse } from "../schemas/base.js";
 /**
  * Parameters for getting escrow detail
  */