@congminh1254/shopee-sdk 0.4.0

package/lib/schemas/logistics.d.ts

@@ -0,0 +1,157 @@
+import { BaseResponse } from './base.js';
+/**
+ * Enum for logistics status
+ */
+export declare enum LogisticsStatus {
+    /** Initial status, order not ready for fulfillment */
+    LOGISTICS_NOT_START = "LOGISTICS_NOT_START",
+    /** 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"
+}
+/**
+ * Enum for tracking logistics status
+ */
+export declare enum TrackingLogisticsStatus {
+    /** Initial state */
+    INITIAL = "INITIAL",
+    /** Order initialization */
+    ORDER_INIT = "ORDER_INIT",
+    /** Order has been submitted */
+    ORDER_SUBMITTED = "ORDER_SUBMITTED",
+    /** Order has been finalized */
+    ORDER_FINALIZED = "ORDER_FINALIZED",
+    /** Order has been created */
+    ORDER_CREATED = "ORDER_CREATED",
+    /** Pickup has been requested */
+    PICKUP_REQUESTED = "PICKUP_REQUESTED",
+    /** Pickup is pending */
+    PICKUP_PENDING = "PICKUP_PENDING",
+    /** Package has been picked up */
+    PICKED_UP = "PICKED_UP",
+    /** Delivery is pending */
+    DELIVERY_PENDING = "DELIVERY_PENDING",
+    /** Package has been delivered */
+    DELIVERED = "DELIVERED",
+    /** Retry pickup attempt */
+    PICKUP_RETRY = "PICKUP_RETRY",
+    /** Operation timed out */
+    TIMEOUT = "TIMEOUT",
+    /** Package is lost */
+    LOST = "LOST",
+    /** Status update */
+    UPDATE = "UPDATE",
+    /** Update has been submitted */
+    UPDATE_SUBMITTED = "UPDATE_SUBMITTED",
+    /** Update has been created */
+    UPDATE_CREATED = "UPDATE_CREATED",
+    /** Return process started */
+    RETURN_STARTED = "RETURN_STARTED",
+    /** Package has been returned */
+    RETURNED = "RETURNED",
+    /** Return is pending */
+    RETURN_PENDING = "RETURN_PENDING",
+    /** Return has been initiated */
+    RETURN_INITIATED = "RETURN_INITIATED",
+    /** Operation has expired */
+    EXPIRED = "EXPIRED",
+    /** Cancellation requested */
+    CANCEL = "CANCEL",
+    /** Cancellation has been created */
+    CANCEL_CREATED = "CANCEL_CREATED",
+    /** Order has been canceled */
+    CANCELED = "CANCELED",
+    /** Failed to initialize order */
+    FAILED_ORDER_INIT = "FAILED_ORDER_INIT",
+    /** Failed to submit order */
+    FAILED_ORDER_SUBMITTED = "FAILED_ORDER_SUBMITTED",
+    /** Failed to create order */
+    FAILED_ORDER_CREATED = "FAILED_ORDER_CREATED",
+    /** Failed to request pickup */
+    FAILED_PICKUP_REQUESTED = "FAILED_PICKUP_REQUESTED",
+    /** Failed to pick up package */
+    FAILED_PICKED_UP = "FAILED_PICKED_UP",
+    /** Failed to deliver package */
+    FAILED_DELIVERED = "FAILED_DELIVERED",
+    /** Failed to submit update */
+    FAILED_UPDATE_SUBMITTED = "FAILED_UPDATE_SUBMITTED",
+    /** Failed to create update */
+    FAILED_UPDATE_CREATED = "FAILED_UPDATE_CREATED",
+    /** Failed to start return */
+    FAILED_RETURN_STARTED = "FAILED_RETURN_STARTED",
+    /** Failed to return package */
+    FAILED_RETURNED = "FAILED_RETURNED",
+    /** Failed to create cancellation */
+    FAILED_CANCEL_CREATED = "FAILED_CANCEL_CREATED",
+    /** Failed to cancel order */
+    FAILED_CANCELED = "FAILED_CANCELED"
+}
+/**
+ * Parameters for getting tracking information
+ */
+export type GetTrackingInfoParams = {
+    /** Shopee's unique identifier for an order */
+    order_sn: string;
+    /**
+     * Shopee's unique identifier for the package under an order.
+     * You shouldn't fill the field with empty string when there isn't a package number.
+     */
+    package_number?: string;
+} & Record<string, string | number | boolean | null | undefined>;
+/**
+ * Tracking information details
+ */
+export interface TrackingInfo {
+    /** The time when logistics info has been updated */
+    update_time: number;
+    /** The description of order logistics tracking info */
+    description: string;
+    /**
+     * The Shopee logistics status for the order.
+     * Applicable values: See Data Definition- TrackingLogisticsStatus
+     */
+    logistics_status: TrackingLogisticsStatus;
+}
+/**
+ * Response for get tracking info API
+ */
+export interface GetTrackingInfoResponse extends BaseResponse {
+    response: {
+        /** Shopee's unique identifier for an order */
+        order_sn: string;
+        /** Shopee's unique identifier for the package under an order */
+        package_number: string;
+        /**
+         * The Shopee logistics status for the order.
+         * Applicable values: See Data Definition- LogisticsStatus
+         */
+        logistics_status: LogisticsStatus;
+        /** The tracking info of the order */
+        tracking_info: TrackingInfo[];
+    };
+}

package/lib/schemas/logistics.js

@@ -0,0 +1,115 @@
+/**
+ * Enum for logistics status
+ */
+export var LogisticsStatus;
+(function (LogisticsStatus) {
+    /** Initial status, order not ready for fulfillment */
+    LogisticsStatus["LOGISTICS_NOT_START"] = "LOGISTICS_NOT_START";
+    /** Order arranged shipment */
+    LogisticsStatus["LOGISTICS_REQUEST_CREATED"] = "LOGISTICS_REQUEST_CREATED";
+    /** Order handed over to 3PL */
+    LogisticsStatus["LOGISTICS_PICKUP_DONE"] = "LOGISTICS_PICKUP_DONE";
+    /** Order pending 3PL retry pickup */
+    LogisticsStatus["LOGISTICS_PICKUP_RETRY"] = "LOGISTICS_PICKUP_RETRY";
+    /** Order cancelled by 3PL due to failed pickup or picked up but not able to proceed with delivery */
+    LogisticsStatus["LOGISTICS_PICKUP_FAILED"] = "LOGISTICS_PICKUP_FAILED";
+    /** Order successfully delivered */
+    LogisticsStatus["LOGISTICS_DELIVERY_DONE"] = "LOGISTICS_DELIVERY_DONE";
+    /** Order cancelled due to 3PL delivery failed */
+    LogisticsStatus["LOGISTICS_DELIVERY_FAILED"] = "LOGISTICS_DELIVERY_FAILED";
+    /** Order cancelled when order at LOGISTICS_REQUEST_CREATED */
+    LogisticsStatus["LOGISTICS_REQUEST_CANCELED"] = "LOGISTICS_REQUEST_CANCELED";
+    /** Integrated logistics COD: Order rejected for COD */
+    LogisticsStatus["LOGISTICS_COD_REJECTED"] = "LOGISTICS_COD_REJECTED";
+    /**
+     * Order ready for fulfilment from payment perspective:
+     * - non-COD: order paid
+     * - COD: order passed COD screening
+     */
+    LogisticsStatus["LOGISTICS_READY"] = "LOGISTICS_READY";
+    /** Order cancelled when order at LOGISTICS_READY */
+    LogisticsStatus["LOGISTICS_INVALID"] = "LOGISTICS_INVALID";
+    /** Order cancelled due to 3PL lost the order */
+    LogisticsStatus["LOGISTICS_LOST"] = "LOGISTICS_LOST";
+    /** Order logistics pending arrangement */
+    LogisticsStatus["LOGISTICS_PENDING_ARRANGE"] = "LOGISTICS_PENDING_ARRANGE";
+})(LogisticsStatus || (LogisticsStatus = {}));
+/**
+ * Enum for tracking logistics status
+ */
+export var TrackingLogisticsStatus;
+(function (TrackingLogisticsStatus) {
+    /** Initial state */
+    TrackingLogisticsStatus["INITIAL"] = "INITIAL";
+    /** Order initialization */
+    TrackingLogisticsStatus["ORDER_INIT"] = "ORDER_INIT";
+    /** Order has been submitted */
+    TrackingLogisticsStatus["ORDER_SUBMITTED"] = "ORDER_SUBMITTED";
+    /** Order has been finalized */
+    TrackingLogisticsStatus["ORDER_FINALIZED"] = "ORDER_FINALIZED";
+    /** Order has been created */
+    TrackingLogisticsStatus["ORDER_CREATED"] = "ORDER_CREATED";
+    /** Pickup has been requested */
+    TrackingLogisticsStatus["PICKUP_REQUESTED"] = "PICKUP_REQUESTED";
+    /** Pickup is pending */
+    TrackingLogisticsStatus["PICKUP_PENDING"] = "PICKUP_PENDING";
+    /** Package has been picked up */
+    TrackingLogisticsStatus["PICKED_UP"] = "PICKED_UP";
+    /** Delivery is pending */
+    TrackingLogisticsStatus["DELIVERY_PENDING"] = "DELIVERY_PENDING";
+    /** Package has been delivered */
+    TrackingLogisticsStatus["DELIVERED"] = "DELIVERED";
+    /** Retry pickup attempt */
+    TrackingLogisticsStatus["PICKUP_RETRY"] = "PICKUP_RETRY";
+    /** Operation timed out */
+    TrackingLogisticsStatus["TIMEOUT"] = "TIMEOUT";
+    /** Package is lost */
+    TrackingLogisticsStatus["LOST"] = "LOST";
+    /** Status update */
+    TrackingLogisticsStatus["UPDATE"] = "UPDATE";
+    /** Update has been submitted */
+    TrackingLogisticsStatus["UPDATE_SUBMITTED"] = "UPDATE_SUBMITTED";
+    /** Update has been created */
+    TrackingLogisticsStatus["UPDATE_CREATED"] = "UPDATE_CREATED";
+    /** Return process started */
+    TrackingLogisticsStatus["RETURN_STARTED"] = "RETURN_STARTED";
+    /** Package has been returned */
+    TrackingLogisticsStatus["RETURNED"] = "RETURNED";
+    /** Return is pending */
+    TrackingLogisticsStatus["RETURN_PENDING"] = "RETURN_PENDING";
+    /** Return has been initiated */
+    TrackingLogisticsStatus["RETURN_INITIATED"] = "RETURN_INITIATED";
+    /** Operation has expired */
+    TrackingLogisticsStatus["EXPIRED"] = "EXPIRED";
+    /** Cancellation requested */
+    TrackingLogisticsStatus["CANCEL"] = "CANCEL";
+    /** Cancellation has been created */
+    TrackingLogisticsStatus["CANCEL_CREATED"] = "CANCEL_CREATED";
+    /** Order has been canceled */
+    TrackingLogisticsStatus["CANCELED"] = "CANCELED";
+    /** Failed to initialize order */
+    TrackingLogisticsStatus["FAILED_ORDER_INIT"] = "FAILED_ORDER_INIT";
+    /** Failed to submit order */
+    TrackingLogisticsStatus["FAILED_ORDER_SUBMITTED"] = "FAILED_ORDER_SUBMITTED";
+    /** Failed to create order */
+    TrackingLogisticsStatus["FAILED_ORDER_CREATED"] = "FAILED_ORDER_CREATED";
+    /** Failed to request pickup */
+    TrackingLogisticsStatus["FAILED_PICKUP_REQUESTED"] = "FAILED_PICKUP_REQUESTED";
+    /** Failed to pick up package */
+    TrackingLogisticsStatus["FAILED_PICKED_UP"] = "FAILED_PICKED_UP";
+    /** Failed to deliver package */
+    TrackingLogisticsStatus["FAILED_DELIVERED"] = "FAILED_DELIVERED";
+    /** Failed to submit update */
+    TrackingLogisticsStatus["FAILED_UPDATE_SUBMITTED"] = "FAILED_UPDATE_SUBMITTED";
+    /** Failed to create update */
+    TrackingLogisticsStatus["FAILED_UPDATE_CREATED"] = "FAILED_UPDATE_CREATED";
+    /** Failed to start return */
+    TrackingLogisticsStatus["FAILED_RETURN_STARTED"] = "FAILED_RETURN_STARTED";
+    /** Failed to return package */
+    TrackingLogisticsStatus["FAILED_RETURNED"] = "FAILED_RETURNED";
+    /** Failed to create cancellation */
+    TrackingLogisticsStatus["FAILED_CANCEL_CREATED"] = "FAILED_CANCEL_CREATED";
+    /** Failed to cancel order */
+    TrackingLogisticsStatus["FAILED_CANCELED"] = "FAILED_CANCELED";
+})(TrackingLogisticsStatus || (TrackingLogisticsStatus = {}));
+//# sourceMappingURL=logistics.js.map

package/lib/schemas/logistics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logistics.js","sourceRoot":"","sources":["../../src/schemas/logistics.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,eA+BX;AA/BD,WAAY,eAAe;IACzB,sDAAsD;IACtD,8DAA2C,CAAA;IAC3C,8BAA8B;IAC9B,0EAAuD,CAAA;IACvD,+BAA+B;IAC/B,kEAA+C,CAAA;IAC/C,qCAAqC;IACrC,oEAAiD,CAAA;IACjD,qGAAqG;IACrG,sEAAmD,CAAA;IACnD,mCAAmC;IACnC,sEAAmD,CAAA;IACnD,iDAAiD;IACjD,0EAAuD,CAAA;IACvD,8DAA8D;IAC9D,4EAAyD,CAAA;IACzD,uDAAuD;IACvD,oEAAiD,CAAA;IACjD;;;;OAIG;IACH,sDAAmC,CAAA;IACnC,oDAAoD;IACpD,0DAAuC,CAAA;IACvC,gDAAgD;IAChD,oDAAiC,CAAA;IACjC,0CAA0C;IAC1C,0EAAuD,CAAA;AACzD,CAAC,EA/BW,eAAe,KAAf,eAAe,QA+B1B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,uBAyEX;AAzED,WAAY,uBAAuB;IACjC,oBAAoB;IACpB,8CAAmB,CAAA;IACnB,2BAA2B;IAC3B,oDAAyB,CAAA;IACzB,+BAA+B;IAC/B,8DAAmC,CAAA;IACnC,+BAA+B;IAC/B,8DAAmC,CAAA;IACnC,6BAA6B;IAC7B,0DAA+B,CAAA;IAC/B,gCAAgC;IAChC,gEAAqC,CAAA;IACrC,wBAAwB;IACxB,4DAAiC,CAAA;IACjC,iCAAiC;IACjC,kDAAuB,CAAA;IACvB,0BAA0B;IAC1B,gEAAqC,CAAA;IACrC,iCAAiC;IACjC,kDAAuB,CAAA;IACvB,2BAA2B;IAC3B,wDAA6B,CAAA;IAC7B,0BAA0B;IAC1B,8CAAmB,CAAA;IACnB,sBAAsB;IACtB,wCAAa,CAAA;IACb,oBAAoB;IACpB,4CAAiB,CAAA;IACjB,gCAAgC;IAChC,gEAAqC,CAAA;IACrC,8BAA8B;IAC9B,4DAAiC,CAAA;IACjC,6BAA6B;IAC7B,4DAAiC,CAAA;IACjC,gCAAgC;IAChC,gDAAqB,CAAA;IACrB,wBAAwB;IACxB,4DAAiC,CAAA;IACjC,gCAAgC;IAChC,gEAAqC,CAAA;IACrC,4BAA4B;IAC5B,8CAAmB,CAAA;IACnB,6BAA6B;IAC7B,4CAAiB,CAAA;IACjB,oCAAoC;IACpC,4DAAiC,CAAA;IACjC,8BAA8B;IAC9B,gDAAqB,CAAA;IACrB,iCAAiC;IACjC,kEAAuC,CAAA;IACvC,6BAA6B;IAC7B,4EAAiD,CAAA;IACjD,6BAA6B;IAC7B,wEAA6C,CAAA;IAC7C,+BAA+B;IAC/B,8EAAmD,CAAA;IACnD,gCAAgC;IAChC,gEAAqC,CAAA;IACrC,gCAAgC;IAChC,gEAAqC,CAAA;IACrC,8BAA8B;IAC9B,8EAAmD,CAAA;IACnD,8BAA8B;IAC9B,0EAA+C,CAAA;IAC/C,6BAA6B;IAC7B,0EAA+C,CAAA;IAC/C,+BAA+B;IAC/B,8DAAmC,CAAA;IACnC,oCAAoC;IACpC,0EAA+C,CAAA;IAC/C,6BAA6B;IAC7B,8DAAmC,CAAA;AACrC,CAAC,EAzEW,uBAAuB,KAAvB,uBAAuB,QAyElC"}