@wix/ecom 1.0.506 → 1.0.508

package/build/cjs/src/ecom-v1-order.universal.d.ts

@@ -102,6 +102,11 @@ export interface Order {
     checkoutId?: string | null;
     /** Custom fields. */
     customFields?: CustomField[];
+    /**
+     * Order balance summary.
+     * @readonly
+     */
+    balanceSummary?: BalanceSummary;
     /** Additional fees applied to the order. */
     additionalFees?: AdditionalFee[];
     /**
@@ -156,6 +161,11 @@ export interface OrderLineItem {
      * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://www.wix.com/velo/reference/wix-ecom-backend/orderfulfillments/listfulfillmentsforsingleorder).
      */
     fulfillerId?: string | null;
+    /**
+     * Number of items that was already refunded
+     * @readonly
+     */
+    refundQuantity?: number | null;
     /**
      * quantity of inventory requested to be returned. Whether to restock or ignore the request is up the vertical.
      * @readonly
@@ -197,6 +207,8 @@ export interface OrderLineItem {
      * @readonly
      */
     depositAmount?: Price;
+    /** Total price **after** catalog-defined discount and line item discounts. */
+    lineItemPrice?: Price;
 }
 export interface ProductName {
     /**
@@ -378,6 +390,8 @@ export interface SubscriptionInfo {
 export interface SubscriptionSettings {
     /** Frequency of recurring payment. */
     frequency?: SubscriptionFrequency;
+    /** Interval of recurring payment */
+    interval?: number | null;
     /** Whether subscription is renewed automatically at the end of each period. */
     autoRenewal?: boolean;
     /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
@@ -653,6 +667,39 @@ export interface TaxSummary {
      */
     totalTax?: Price;
 }
+export interface OrderTaxInfo {
+    /** Calculated tax, added from line items. */
+    totalTax?: Price;
+    /** The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate. */
+    taxBreakdown?: OrderTaxBreakdown[];
+}
+/**
+ * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
+ * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
+ */
+export interface OrderTaxBreakdown {
+    /** The name of the tax against which this tax amount was calculated. */
+    taxName?: string;
+    /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */
+    taxType?: string;
+    /** The name of the jurisdiction in which this tax detail applies. */
+    jurisdiction?: string;
+    /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
+    jurisdictionType?: JurisdictionType;
+    /** The rate at which this tax detail was calculated. */
+    rate?: string;
+    /** The sum of all the tax from line items that calculated by the tax identifiers. */
+    aggregatedTaxAmount?: Price;
+}
+/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
+export declare enum JurisdictionType {
+    UNDEFINED = "UNDEFINED",
+    COUNTRY = "COUNTRY",
+    STATE = "STATE",
+    COUNTY = "COUNTY",
+    CITY = "CITY",
+    SPECIAL = "SPECIAL"
+}
 export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
     /** Applied coupon info. */
     coupon?: Coupon;
@@ -1014,6 +1061,17 @@ export interface BalanceSummary {
      * @readonly
      */
     balance?: Balance;
+    /**
+     * Sum of all historically approved (succeeded) payments
+     * including those which had been subsequently refunded or partially refunded
+     * @readonly
+     */
+    paid?: Price;
+    /**
+     * Sum of all refunded payments ( with status success )
+     * @readonly
+     */
+    refunded?: Price;
 }
 /**
  * Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
@@ -2430,7 +2488,7 @@ export interface UpdateOrderResponse {
 }
 export interface BulkUpdateOrderRequest {
     /** Orders to be updated. */
-    orders: MaskedOrder[];
+    orders?: MaskedOrder[];
     /** Set to `true` if you wish to receive back the updated orders in the response */
     returnEntity?: boolean;
 }
@@ -2439,7 +2497,9 @@ export interface MaskedOrder {
     order?: Order;
 }
 export interface BulkUpdateOrderResponse {
+    /** Bulk action results. */
     results?: BulkOrderResult[];
+    /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface CommitDeltasRequest {
@@ -2553,6 +2613,8 @@ export interface OrderLineItemChangedDetails {
     taxDetails?: ItemTaxFullDetails;
     /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
     priceDescription?: PriceDescription;
+    /** Total price **after** catalog-defined discount and line item discounts. */
+    lineItemPrice?: Price;
     /** Total price after all discounts excluding tax. */
     totalPriceBeforeTax?: Price;
 }
@@ -3238,6 +3300,21 @@ export interface RestockItem {
     /** Line item quantity being restocked. */
     quantity?: number;
 }
+export interface BulkUpdateOrderTagsRequest {
+    /** IDs of orders to update tags for. */
+    orderIds?: string[];
+    /** Tags to be added to orders */
+    assignTags?: Tags;
+    /** Tags to be removed from orders */
+    unassignTags?: Tags;
+}
+export interface BulkUpdateOrderTagsResponse {
+    results?: BulkUpdateOrderTagsResult[];
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkUpdateOrderTagsResult {
+    itemMetadata?: ItemMetadata;
+}
 /** Triggered when the the order status changes to approved */
 export interface OrderApproved {
     /** The order that was updated */
@@ -3725,6 +3802,10 @@ export interface GetOrderResponseNonNullableFields {
                 amount: string;
                 formattedAmount: string;
             };
+            lineItemPrice?: {
+                amount: string;
+                formattedAmount: string;
+            };
         }[];
         buyerInfo?: {
             visitorId: string;
@@ -3881,6 +3962,20 @@ export interface GetOrderResponseNonNullableFields {
         customFields: {
             title: string;
         }[];
+        balanceSummary?: {
+            balance?: {
+                amount: string;
+                formattedAmount: string;
+            };
+            paid?: {
+                amount: string;
+                formattedAmount: string;
+            };
+            refunded?: {
+                amount: string;
+                formattedAmount: string;
+            };
+        };
         additionalFees: {
             name: string;
             price?: {
@@ -4002,6 +4097,10 @@ export interface SearchOrdersResponseNonNullableFields {
                 amount: string;
                 formattedAmount: string;
             };
+            lineItemPrice?: {
+                amount: string;
+                formattedAmount: string;
+            };
         }[];
         buyerInfo?: {
             visitorId: string;
@@ -4158,6 +4257,20 @@ export interface SearchOrdersResponseNonNullableFields {
         customFields: {
             title: string;
         }[];
+        balanceSummary?: {
+            balance?: {
+                amount: string;
+                formattedAmount: string;
+            };
+            paid?: {
+                amount: string;
+                formattedAmount: string;
+            };
+            refunded?: {
+                amount: string;
+                formattedAmount: string;
+            };
+        };
         additionalFees: {
             name: string;
             price?: {
@@ -4279,6 +4392,10 @@ export interface CreateOrderResponseNonNullableFields {
                 amount: string;
                 formattedAmount: string;
             };
+            lineItemPrice?: {
+                amount: string;
+                formattedAmount: string;
+            };
         }[];
         buyerInfo?: {
             visitorId: string;
@@ -4435,6 +4552,20 @@ export interface CreateOrderResponseNonNullableFields {
         customFields: {
             title: string;
         }[];
+        balanceSummary?: {
+            balance?: {
+                amount: string;
+                formattedAmount: string;
+            };
+            paid?: {
+                amount: string;
+                formattedAmount: string;
+            };
+            refunded?: {
+                amount: string;
+                formattedAmount: string;
+            };
+        };
         additionalFees: {
             name: string;
             price?: {
@@ -4556,6 +4687,10 @@ export interface UpdateOrderResponseNonNullableFields {
                 amount: string;
                 formattedAmount: string;
             };
+            lineItemPrice?: {
+                amount: string;
+                formattedAmount: string;
+            };
         }[];
         buyerInfo?: {
             visitorId: string;
@@ -4712,6 +4847,20 @@ export interface UpdateOrderResponseNonNullableFields {
         customFields: {
             title: string;
         }[];
+        balanceSummary?: {
+            balance?: {
+                amount: string;
+                formattedAmount: string;
+            };
+            paid?: {
+                amount: string;
+                formattedAmount: string;
+            };
+            refunded?: {
+                amount: string;
+                formattedAmount: string;
+            };
+        };
         additionalFees: {
             name: string;
             price?: {
@@ -4754,298 +4903,6 @@ export interface UpdateOrderResponseNonNullableFields {
         };
     };
 }
-export interface BulkUpdateOrderResponseNonNullableFields {
-    results: {
-        itemMetadata?: {
-            originalIndex: number;
-            success: boolean;
-            error?: {
-                code: string;
-                description: string;
-            };
-        };
-        item?: {
-            number: string;
-            lineItems: {
-                _id: string;
-                productName?: {
-                    original: string;
-                };
-                catalogReference?: {
-                    catalogItemId: string;
-                    appId: string;
-                };
-                quantity: number;
-                totalDiscount?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-                descriptionLines: {
-                    plainText?: {
-                        original: string;
-                    };
-                    colorInfo?: {
-                        original: string;
-                    };
-                    name?: {
-                        original: string;
-                    };
-                }[];
-                image: string;
-                physicalProperties?: {
-                    shippable: boolean;
-                };
-                itemType?: {
-                    preset: ItemTypeItemType;
-                    custom: string;
-                };
-                price?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-                priceBeforeDiscounts?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-                totalPriceBeforeTax?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-                totalPriceAfterTax?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-                paymentOption: PaymentOptionType;
-                taxDetails?: {
-                    taxableAmount?: {
-                        amount: string;
-                        formattedAmount: string;
-                    };
-                    taxRate: string;
-                    totalTax?: {
-                        amount: string;
-                        formattedAmount: string;
-                    };
-                };
-                subscriptionInfo?: {
-                    cycleNumber: number;
-                    subscriptionOptionTitle: string;
-                    subscriptionSettings?: {
-                        frequency: SubscriptionFrequency;
-                        autoRenewal: boolean;
-                    };
-                };
-                priceDescription?: {
-                    original: string;
-                };
-                depositAmount?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-            }[];
-            buyerInfo?: {
-                visitorId: string;
-                memberId: string;
-            };
-            paymentStatus: PaymentStatus;
-            fulfillmentStatus: FulfillmentStatus;
-            weightUnit: WeightUnit;
-            taxIncludedInPrices: boolean;
-            priceSummary?: {
-                subtotal?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-                shipping?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-                tax?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-                discount?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-                total?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-                totalAdditionalFees?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-            };
-            billingInfo?: {
-                contactDetails?: {
-                    vatId?: {
-                        _id: string;
-                        type: VatType;
-                    };
-                };
-            };
-            shippingInfo?: {
-                title: string;
-                logistics?: {
-                    shippingDestination?: {
-                        contactDetails?: {
-                            vatId?: {
-                                _id: string;
-                                type: VatType;
-                            };
-                        };
-                    };
-                    pickupDetails?: {
-                        pickupMethod: PickupMethod;
-                    };
-                };
-                cost?: {
-                    price?: {
-                        amount: string;
-                        formattedAmount: string;
-                    };
-                    totalPriceBeforeTax?: {
-                        amount: string;
-                        formattedAmount: string;
-                    };
-                    totalPriceAfterTax?: {
-                        amount: string;
-                        formattedAmount: string;
-                    };
-                    taxDetails?: {
-                        taxableAmount?: {
-                            amount: string;
-                            formattedAmount: string;
-                        };
-                        taxRate: string;
-                        totalTax?: {
-                            amount: string;
-                            formattedAmount: string;
-                        };
-                    };
-                    discount?: {
-                        amount: string;
-                        formattedAmount: string;
-                    };
-                };
-            };
-            status: OrderStatus;
-            taxSummary?: {
-                totalTax?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-            };
-            appliedDiscounts: {
-                coupon?: {
-                    _id: string;
-                    code: string;
-                    name: string;
-                    amount?: {
-                        amount: string;
-                        formattedAmount: string;
-                    };
-                };
-                merchantDiscount?: {
-                    discountReason: DiscountReason;
-                    amount?: {
-                        amount: string;
-                        formattedAmount: string;
-                    };
-                };
-                discountRule?: {
-                    _id: string;
-                    name?: {
-                        original: string;
-                    };
-                    amount?: {
-                        amount: string;
-                        formattedAmount: string;
-                    };
-                };
-                discountType: DiscountType;
-                lineItemIds: string[];
-            }[];
-            activities: {
-                customActivity?: {
-                    appId: string;
-                    type: string;
-                };
-                merchantComment?: {
-                    message: string;
-                };
-                orderRefunded?: {
-                    manual: boolean;
-                    amount?: {
-                        amount: string;
-                        formattedAmount: string;
-                    };
-                    reason: string;
-                };
-                type: ActivityType;
-            }[];
-            attributionSource: AttributionSource;
-            createdBy?: {
-                userId: string;
-                memberId: string;
-                visitorId: string;
-                appId: string;
-            };
-            channelInfo?: {
-                type: ChannelType;
-            };
-            customFields: {
-                title: string;
-            }[];
-            additionalFees: {
-                name: string;
-                price?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-                taxDetails?: {
-                    taxableAmount?: {
-                        amount: string;
-                        formattedAmount: string;
-                    };
-                    taxRate: string;
-                    totalTax?: {
-                        amount: string;
-                        formattedAmount: string;
-                    };
-                };
-                priceBeforeTax?: {
-                    amount: string;
-                    formattedAmount: string;
-                };
-                _id: string;
-                lineItemIds: string[];
-            }[];
-            recipientInfo?: {
-                contactDetails?: {
-                    vatId?: {
-                        _id: string;
-                        type: VatType;
-                    };
-                };
-            };
-            tags?: {
-                privateTags?: {
-                    tagIds: string[];
-                };
-                tags?: {
-                    tagIds: string[];
-                };
-            };
-        };
-    }[];
-    bulkActionMetadata?: {
-        totalSuccesses: number;
-        totalFailures: number;
-        undetailedFailures: number;
-    };
-}
 export interface CancelOrderResponseNonNullableFields {
     order?: {
         number: string;
@@ -5125,6 +4982,10 @@ export interface CancelOrderResponseNonNullableFields {
                 amount: string;
                 formattedAmount: string;
             };
+            lineItemPrice?: {
+                amount: string;
+                formattedAmount: string;
+            };
         }[];
         buyerInfo?: {
             visitorId: string;
@@ -5281,6 +5142,20 @@ export interface CancelOrderResponseNonNullableFields {
         customFields: {
             title: string;
         }[];
+        balanceSummary?: {
+            balance?: {
+                amount: string;
+                formattedAmount: string;
+            };
+            paid?: {
+                amount: string;
+                formattedAmount: string;
+            };
+            refunded?: {
+                amount: string;
+                formattedAmount: string;
+            };
+        };
         additionalFees: {
             name: string;
             price?: {
@@ -5406,6 +5281,7 @@ export interface SearchOrdersOptions {
  * @requiredField order.lineItems.price
  * @requiredField order.lineItems.productName
  * @requiredField order.lineItems.productName.original
+ * @requiredField order.lineItems.subscriptionInfo.subscriptionSettings.interval
  * @requiredField order.lineItems.taxDetails
  * @requiredField order.priceSummary
  * @permissionScope Manage Stores - all permissions
@@ -5553,6 +5429,11 @@ export interface UpdateOrder {
     checkoutId?: string | null;
     /** Custom fields. */
     customFields?: CustomField[];
+    /**
+     * Order balance summary.
+     * @readonly
+     */
+    balanceSummary?: BalanceSummary;
     /** Additional fees applied to the order. */
     additionalFees?: AdditionalFee[];
     /**
@@ -5574,25 +5455,6 @@ export interface UpdateOrder {
     /** Tag ids collections associated with current entity. private_tags requires separate permissions to be accessible and modifiable. */
     tags?: Tags;
 }
-/** @param orders - Orders to be updated.
- * @public
- * @documentationMaturity preview
- * @requiredField orders
- * @requiredField orders.order
- * @requiredField orders.order._id
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- */
-export declare function bulkUpdateOrder(orders: MaskedOrder[], options?: BulkUpdateOrderOptions): Promise<BulkUpdateOrderResponse & BulkUpdateOrderResponseNonNullableFields>;
-export interface BulkUpdateOrderOptions {
-    /** Set to `true` if you wish to receive back the updated orders in the response */
-    returnEntity?: boolean;
-}
 /**
  * Cancels an order.
  *