@wix/auto_sdk_ecom_draft-orders 1.0.21 → 1.0.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +3 -2
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js +3 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +40 -25
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js +153 -26
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +3 -0
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +20 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +82 -52
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js +16 -10
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +290 -102
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js +23 -9
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +475 -169
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +581 -92
- package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +3 -2
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js +2 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +40 -25
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js +151 -25
- package/build/es/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +3 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js +18 -0
- package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +82 -52
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js +14 -9
- package/build/es/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +290 -102
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js +23 -9
- package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +475 -169
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +578 -91
- package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +3 -2
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js +3 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +40 -25
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js +153 -26
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +3 -0
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +20 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +82 -52
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js +16 -10
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts +290 -102
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js +23 -9
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +370 -339
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +581 -92
- package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +3 -2
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js +2 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +40 -25
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js +151 -25
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +3 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js +18 -0
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +82 -52
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js +14 -9
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.d.ts +290 -102
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js +23 -9
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +1 -1
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +370 -339
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +578 -91
- package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -27,14 +27,14 @@ export interface DraftOrder {
|
|
|
27
27
|
/**
|
|
28
28
|
* Buyer information.
|
|
29
29
|
* @deprecated Buyer information.
|
|
30
|
-
* @replacedBy
|
|
30
|
+
* @replacedBy buyer_details
|
|
31
31
|
* @targetRemovalDate 2024-08-30
|
|
32
32
|
*/
|
|
33
33
|
buyerInfo?: BuyerInfo;
|
|
34
34
|
/**
|
|
35
35
|
* Billing address and contact details.
|
|
36
36
|
* @deprecated Billing address and contact details.
|
|
37
|
-
* @replacedBy
|
|
37
|
+
* @replacedBy billing_details
|
|
38
38
|
* @targetRemovalDate 2024-08-30
|
|
39
39
|
*/
|
|
40
40
|
billingInfo?: AddressWithContact;
|
|
@@ -111,12 +111,31 @@ export interface DraftOrder {
|
|
|
111
111
|
* @format GUID
|
|
112
112
|
*/
|
|
113
113
|
purchaseFlowId?: string | null;
|
|
114
|
+
/**
|
|
115
|
+
* Order recipient address and contact details.
|
|
116
|
+
*
|
|
117
|
+
* This field may differ from the address in `shippingInfo.logistics` when:
|
|
118
|
+
* + The chosen shipping option is pickup point or store pickup.
|
|
119
|
+
* + No shipping option is selected.
|
|
120
|
+
*/
|
|
114
121
|
recipientInfo?: RecipientInfoDetails;
|
|
122
|
+
/** Tax information. */
|
|
123
|
+
taxInfo?: OrderTaxInfo;
|
|
115
124
|
/**
|
|
116
125
|
* Custom field data for the draft order object.
|
|
117
126
|
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
|
|
118
127
|
*/
|
|
119
128
|
extendedFields?: ExtendedFields;
|
|
129
|
+
/**
|
|
130
|
+
* Buyer information.
|
|
131
|
+
* Includes details about changes when relevant.
|
|
132
|
+
*/
|
|
133
|
+
buyerDetails?: BuyerDetails;
|
|
134
|
+
/**
|
|
135
|
+
* Billing address and contact details.
|
|
136
|
+
* Includes details about changes when relevant.
|
|
137
|
+
*/
|
|
138
|
+
billingDetails?: BillingDetails;
|
|
120
139
|
/**
|
|
121
140
|
* Order business location
|
|
122
141
|
* Includes details about changes when relevant.
|
|
@@ -280,6 +299,8 @@ export interface OrderLineItem {
|
|
|
280
299
|
* @maxSize 5
|
|
281
300
|
*/
|
|
282
301
|
locations?: LocationAndQuantity[];
|
|
302
|
+
/** Address used for tax calculation. */
|
|
303
|
+
taxableAddress?: TaxableAddress;
|
|
283
304
|
/**
|
|
284
305
|
* Custom extended fields for the line item object.
|
|
285
306
|
*
|
|
@@ -1064,6 +1085,7 @@ export interface AdditionalFeeDetails {
|
|
|
1064
1085
|
*
|
|
1065
1086
|
* Supported values:
|
|
1066
1087
|
* + `ORIGINAL_ORDER`: This additional fee is part of the original order.
|
|
1088
|
+
* + `AUTOMATIC`: User added a catalog item which is configured to have an additional fee.
|
|
1067
1089
|
* + `CUSTOM`: This additional fee was created by the [Create Custom Additional Fees](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/draft-orders/create-custom-additional-fees) API.
|
|
1068
1090
|
*/
|
|
1069
1091
|
source?: SourceType;
|
|
@@ -1119,11 +1141,11 @@ export interface TaxDetails {
|
|
|
1119
1141
|
taxGroupId?: string | null;
|
|
1120
1142
|
}
|
|
1121
1143
|
export declare enum SourceType {
|
|
1122
|
-
/** Part of the original order */
|
|
1144
|
+
/** Part of the original order. */
|
|
1123
1145
|
ORIGINAL_ORDER = "ORIGINAL_ORDER",
|
|
1124
|
-
/** Added by
|
|
1146
|
+
/** Added automatically, as the result of recalculation caused by changes in draft order. */
|
|
1125
1147
|
AUTOMATIC = "AUTOMATIC",
|
|
1126
|
-
/** Added manually to
|
|
1148
|
+
/** Added manually to draft order. */
|
|
1127
1149
|
CUSTOM = "CUSTOM"
|
|
1128
1150
|
}
|
|
1129
1151
|
export interface DiscountDetails {
|
|
@@ -1289,9 +1311,9 @@ export interface CreatedByStringOneOf {
|
|
|
1289
1311
|
appId?: string;
|
|
1290
1312
|
}
|
|
1291
1313
|
export declare enum EditingStatus {
|
|
1292
|
-
/**
|
|
1314
|
+
/** Draft order can be modified and committed. */
|
|
1293
1315
|
DRAFT = "DRAFT",
|
|
1294
|
-
/**
|
|
1316
|
+
/** Draft order is already committed. No further modifications allowed. */
|
|
1295
1317
|
COMMITTED = "COMMITTED"
|
|
1296
1318
|
}
|
|
1297
1319
|
export declare enum WeightUnit {
|
|
@@ -1329,6 +1351,18 @@ export interface BalanceSummary {
|
|
|
1329
1351
|
* @readonly
|
|
1330
1352
|
*/
|
|
1331
1353
|
balance?: Balance;
|
|
1354
|
+
/**
|
|
1355
|
+
* Sum of all approved and successful payments.
|
|
1356
|
+
*
|
|
1357
|
+
* The value includes payments that have subsequently been fully or partially refunded.
|
|
1358
|
+
* @readonly
|
|
1359
|
+
*/
|
|
1360
|
+
paid?: Price;
|
|
1361
|
+
/**
|
|
1362
|
+
* Sum of all successfully refunded payments.
|
|
1363
|
+
* @readonly
|
|
1364
|
+
*/
|
|
1365
|
+
refunded?: Price;
|
|
1332
1366
|
/**
|
|
1333
1367
|
* Sum of all authorized payments.
|
|
1334
1368
|
* @readonly
|
|
@@ -1468,18 +1502,50 @@ export interface OrderTaxBreakdown {
|
|
|
1468
1502
|
aggregatedTaxAmount?: Price;
|
|
1469
1503
|
}
|
|
1470
1504
|
export interface BuyerDetails extends BuyerDetailsChangeTypeOneOf {
|
|
1505
|
+
/** Indicates that buyer information was added during draft. */
|
|
1506
|
+
added?: boolean;
|
|
1507
|
+
/** Indicates that buyer information was changed. Contains billing information before draft. */
|
|
1508
|
+
changedDetails?: BuyerChangedDetails;
|
|
1509
|
+
/** Indicates that buyer information was removed during draft. */
|
|
1510
|
+
removed?: boolean;
|
|
1511
|
+
/** Buyer information. */
|
|
1512
|
+
buyerInfo?: BuyerInfo;
|
|
1471
1513
|
}
|
|
1472
1514
|
/** @oneof */
|
|
1473
1515
|
export interface BuyerDetailsChangeTypeOneOf {
|
|
1516
|
+
/** Indicates that buyer information was added during draft. */
|
|
1517
|
+
added?: boolean;
|
|
1518
|
+
/** Indicates that buyer information was changed. Contains billing information before draft. */
|
|
1519
|
+
changedDetails?: BuyerChangedDetails;
|
|
1520
|
+
/** Indicates that buyer information was removed during draft. */
|
|
1521
|
+
removed?: boolean;
|
|
1474
1522
|
}
|
|
1475
1523
|
export interface BuyerChangedDetails {
|
|
1524
|
+
/** Buyer information before draft. */
|
|
1525
|
+
buyerInfoBeforeChange?: BuyerInfo;
|
|
1476
1526
|
}
|
|
1477
1527
|
export interface BillingDetails extends BillingDetailsChangeTypeOneOf {
|
|
1528
|
+
/** Indicates that billing information was added during draft. */
|
|
1529
|
+
added?: boolean;
|
|
1530
|
+
/** Indicates that billing information was changed. Contains billing information before draft. */
|
|
1531
|
+
changedDetails?: BillingChangedDetails;
|
|
1532
|
+
/** Indicates that billing information was removed during draft. */
|
|
1533
|
+
removed?: boolean;
|
|
1534
|
+
/** Billing address and contact details. */
|
|
1535
|
+
billingInfo?: AddressWithContact;
|
|
1478
1536
|
}
|
|
1479
1537
|
/** @oneof */
|
|
1480
1538
|
export interface BillingDetailsChangeTypeOneOf {
|
|
1539
|
+
/** Indicates that billing information was added during draft. */
|
|
1540
|
+
added?: boolean;
|
|
1541
|
+
/** Indicates that billing information was changed. Contains billing information before draft. */
|
|
1542
|
+
changedDetails?: BillingChangedDetails;
|
|
1543
|
+
/** Indicates that billing information was removed during draft. */
|
|
1544
|
+
removed?: boolean;
|
|
1481
1545
|
}
|
|
1482
1546
|
export interface BillingChangedDetails {
|
|
1547
|
+
/** Billing address and contact details before draft. */
|
|
1548
|
+
billingInfoBeforeChange?: AddressWithContact;
|
|
1483
1549
|
}
|
|
1484
1550
|
export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
|
|
1485
1551
|
/** Indicates that business location was added during draft. */
|
|
@@ -1521,22 +1587,24 @@ export interface BusinessLocationChangedDetails {
|
|
|
1521
1587
|
}
|
|
1522
1588
|
export interface CreateDraftOrderRequest {
|
|
1523
1589
|
/**
|
|
1524
|
-
*
|
|
1590
|
+
* Existing order ID to create draft from.
|
|
1525
1591
|
* @format GUID
|
|
1526
1592
|
*/
|
|
1527
1593
|
orderId: string | null;
|
|
1528
1594
|
}
|
|
1529
1595
|
export interface CreateDraftOrderResponse {
|
|
1530
|
-
/**
|
|
1596
|
+
/** Draft order details calculated with latest content. */
|
|
1531
1597
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1532
|
-
}
|
|
1533
|
-
export interface CalculatedDraftOrder {
|
|
1534
1598
|
/**
|
|
1535
|
-
*
|
|
1536
|
-
*
|
|
1599
|
+
* Flag indicating whether response contains draft order that existed before request.
|
|
1600
|
+
* `False` - new draft order was created.
|
|
1537
1601
|
*/
|
|
1602
|
+
preexistingDraftOrder?: boolean | null;
|
|
1603
|
+
}
|
|
1604
|
+
export interface CalculatedDraftOrder {
|
|
1605
|
+
/** Draft order full details with calculations based on it's content. */
|
|
1538
1606
|
draftOrder?: DraftOrder;
|
|
1539
|
-
/**
|
|
1607
|
+
/** Order shipping options. */
|
|
1540
1608
|
shippingOptions?: ShippingOption[];
|
|
1541
1609
|
/** Errors that occurred during calculation. */
|
|
1542
1610
|
calculationErrors?: CalculationErrors;
|
|
@@ -1569,18 +1637,14 @@ export interface DeliveryLogistics {
|
|
|
1569
1637
|
export interface PickupDetails {
|
|
1570
1638
|
/** Pickup address */
|
|
1571
1639
|
address?: Address;
|
|
1572
|
-
/**
|
|
1573
|
-
* Pickup method.
|
|
1574
|
-
*
|
|
1575
|
-
* Supported values:
|
|
1576
|
-
* + `"STORE_PICKUP"`
|
|
1577
|
-
* + `"PICKUP_POINT"`
|
|
1578
|
-
*/
|
|
1640
|
+
/** Pickup method. */
|
|
1579
1641
|
pickupMethod?: PickupMethod;
|
|
1580
1642
|
}
|
|
1581
1643
|
export declare enum PickupMethod {
|
|
1582
1644
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1645
|
+
/** Pickup is from the merchant's brick and mortar store. */
|
|
1583
1646
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1647
|
+
/** Item is shipped to a specified pickup point. */
|
|
1584
1648
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1585
1649
|
}
|
|
1586
1650
|
export interface DeliveryTimeSlot {
|
|
@@ -1722,12 +1786,12 @@ export interface CarrierError {
|
|
|
1722
1786
|
export interface CreateEmptyDraftOrderRequest {
|
|
1723
1787
|
}
|
|
1724
1788
|
export interface CreateEmptyDraftOrderResponse {
|
|
1725
|
-
/**
|
|
1789
|
+
/** Draft order details calculated with latest content. */
|
|
1726
1790
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1727
1791
|
}
|
|
1728
1792
|
export interface AddLineItemsToDraftOrderRequest {
|
|
1729
1793
|
/**
|
|
1730
|
-
*
|
|
1794
|
+
* Draft order ID.
|
|
1731
1795
|
* @format GUID
|
|
1732
1796
|
*/
|
|
1733
1797
|
draftOrderId: string;
|
|
@@ -1743,7 +1807,10 @@ export interface AddLineItemsToDraftOrderRequest {
|
|
|
1743
1807
|
customLineItems?: CustomLineItem[];
|
|
1744
1808
|
}
|
|
1745
1809
|
export interface CatalogReferenceLineItem {
|
|
1746
|
-
/**
|
|
1810
|
+
/**
|
|
1811
|
+
* Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.
|
|
1812
|
+
* Optional for custom line items, which don't trigger the Catalog service plugin.
|
|
1813
|
+
*/
|
|
1747
1814
|
catalogReference?: CatalogReference;
|
|
1748
1815
|
/**
|
|
1749
1816
|
* Item quantity.
|
|
@@ -1753,6 +1820,12 @@ export interface CatalogReferenceLineItem {
|
|
|
1753
1820
|
quantity?: number;
|
|
1754
1821
|
/** Item price override. */
|
|
1755
1822
|
price?: Price;
|
|
1823
|
+
/**
|
|
1824
|
+
* Whether the price is not yet defined, and will be updated after the order is created.
|
|
1825
|
+
*
|
|
1826
|
+
* Default: `false`
|
|
1827
|
+
*/
|
|
1828
|
+
priceUndetermined?: boolean;
|
|
1756
1829
|
/**
|
|
1757
1830
|
* Line item locations.
|
|
1758
1831
|
*
|
|
@@ -1776,7 +1849,10 @@ export interface CustomLineItem {
|
|
|
1776
1849
|
* @max 100000
|
|
1777
1850
|
*/
|
|
1778
1851
|
quantity?: number;
|
|
1779
|
-
/**
|
|
1852
|
+
/**
|
|
1853
|
+
* Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.
|
|
1854
|
+
* Optional for custom line items, which don't trigger the Catalog service plugin.
|
|
1855
|
+
*/
|
|
1780
1856
|
catalogReference?: CatalogReference;
|
|
1781
1857
|
/**
|
|
1782
1858
|
* Item name.
|
|
@@ -1843,35 +1919,35 @@ export declare enum FileType {
|
|
|
1843
1919
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
1844
1920
|
}
|
|
1845
1921
|
export interface AddLineItemsToDraftOrderResponse {
|
|
1846
|
-
/**
|
|
1922
|
+
/** Draft order details calculated with latest content. */
|
|
1847
1923
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1848
1924
|
}
|
|
1849
1925
|
export interface UpdateLineItemsRequest {
|
|
1850
1926
|
/**
|
|
1851
|
-
*
|
|
1927
|
+
* Draft order ID.
|
|
1852
1928
|
* @format GUID
|
|
1853
1929
|
*/
|
|
1854
1930
|
draftOrderId: string;
|
|
1855
1931
|
/**
|
|
1856
|
-
* Details of changes to apply per line item
|
|
1932
|
+
* Details of changes to apply per line item.
|
|
1857
1933
|
* @minSize 1
|
|
1858
1934
|
* @maxSize 300
|
|
1859
1935
|
*/
|
|
1860
|
-
lineItemChanges
|
|
1936
|
+
lineItemChanges: LineItemChangeDetails[];
|
|
1861
1937
|
}
|
|
1862
1938
|
export interface LineItemChangeDetails {
|
|
1863
1939
|
/**
|
|
1864
|
-
*
|
|
1940
|
+
* Line item ID.
|
|
1865
1941
|
* @format GUID
|
|
1866
1942
|
*/
|
|
1867
1943
|
lineItemId?: string;
|
|
1868
1944
|
/**
|
|
1869
|
-
* The new quantity for the line item.
|
|
1945
|
+
* The new quantity for the line item. Quantity zero removes the line item.
|
|
1870
1946
|
* @max 1000000
|
|
1871
1947
|
*/
|
|
1872
1948
|
newQuantity?: number | null;
|
|
1873
1949
|
/**
|
|
1874
|
-
* The new price for 1 unit of the line item
|
|
1950
|
+
* The new price for 1 unit of the line item.
|
|
1875
1951
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
1876
1952
|
*/
|
|
1877
1953
|
newPrice?: string | null;
|
|
@@ -1879,51 +1955,59 @@ export interface LineItemChangeDetails {
|
|
|
1879
1955
|
newPriceDescription?: PriceDescription;
|
|
1880
1956
|
}
|
|
1881
1957
|
export interface UpdateLineItemsResponse {
|
|
1882
|
-
/**
|
|
1958
|
+
/** Draft order details calculated with latest content. */
|
|
1883
1959
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1884
1960
|
}
|
|
1885
1961
|
export interface SetDiscountsRequest {
|
|
1886
1962
|
/**
|
|
1887
|
-
*
|
|
1963
|
+
* Draft order ID.
|
|
1888
1964
|
* @format GUID
|
|
1889
1965
|
*/
|
|
1890
1966
|
draftOrderId: string;
|
|
1891
1967
|
/**
|
|
1892
|
-
*
|
|
1968
|
+
* Discount IDs to apply/unapply.
|
|
1969
|
+
* Existing discounts, not mentioned in request, will keep their current state.
|
|
1893
1970
|
* @minSize 1
|
|
1971
|
+
* @maxSize 320
|
|
1894
1972
|
*/
|
|
1895
1973
|
discounts: IdAndApplied[];
|
|
1896
1974
|
}
|
|
1897
1975
|
export interface IdAndApplied {
|
|
1898
|
-
/**
|
|
1976
|
+
/**
|
|
1977
|
+
* Entity ID. Depending on context, it's either discount or additional fee ID.
|
|
1978
|
+
* @format GUID
|
|
1979
|
+
*/
|
|
1899
1980
|
_id?: string;
|
|
1900
|
-
/**
|
|
1981
|
+
/** Flag indicating whether entity (discount/additional fee) should be applied to a draft order. */
|
|
1901
1982
|
applied?: boolean;
|
|
1902
1983
|
}
|
|
1903
1984
|
export interface SetDiscountsResponse {
|
|
1904
|
-
/**
|
|
1985
|
+
/** Draft order details calculated with latest content. */
|
|
1905
1986
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1906
1987
|
}
|
|
1907
1988
|
export interface CreateCustomDiscountsRequest {
|
|
1908
1989
|
/**
|
|
1909
|
-
*
|
|
1990
|
+
* Draft order ID.
|
|
1910
1991
|
* @format GUID
|
|
1911
1992
|
*/
|
|
1912
1993
|
draftOrderId: string;
|
|
1913
1994
|
/**
|
|
1914
|
-
*
|
|
1995
|
+
* Discounts to create. Created discounts are unapplied by default.
|
|
1915
1996
|
* @minSize 1
|
|
1916
1997
|
* @maxSize 100
|
|
1917
1998
|
*/
|
|
1918
1999
|
discounts?: DiscountOption[];
|
|
1919
2000
|
}
|
|
1920
2001
|
export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
2002
|
+
/** Discount price amount. */
|
|
2003
|
+
priceAmount?: Price;
|
|
1921
2004
|
/**
|
|
1922
|
-
* Discount
|
|
1923
|
-
*
|
|
1924
|
-
*
|
|
1925
|
-
* * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
|
|
2005
|
+
* Discount percentage amount.
|
|
2006
|
+
* @format DECIMAL_VALUE
|
|
2007
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1926
2008
|
*/
|
|
2009
|
+
percentage?: string | null;
|
|
2010
|
+
/** Discount type. */
|
|
1927
2011
|
discountType?: DiscountType;
|
|
1928
2012
|
/**
|
|
1929
2013
|
* ID of line item discount applies to.
|
|
@@ -1947,31 +2031,47 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
1947
2031
|
description?: string | null;
|
|
1948
2032
|
/**
|
|
1949
2033
|
* Should opt-in the added discount. default = false.
|
|
1950
|
-
* if not set or false, then to opt-in them, please call SetDiscounts with the added discounts
|
|
2034
|
+
* if not set or false, then to opt-in them, please call SetDiscounts with the added discounts IDs.
|
|
1951
2035
|
*/
|
|
1952
2036
|
applyToDraftOrder?: boolean | null;
|
|
2037
|
+
/**
|
|
2038
|
+
* Line items the discount applies to.
|
|
2039
|
+
* @maxSize 1
|
|
2040
|
+
*/
|
|
2041
|
+
lineItemDiscounts?: LineItemDiscount[];
|
|
1953
2042
|
}
|
|
1954
2043
|
/** @oneof */
|
|
1955
2044
|
export interface DiscountOptionDiscountAmountOneOf {
|
|
2045
|
+
/** Discount price amount. */
|
|
2046
|
+
priceAmount?: Price;
|
|
2047
|
+
/**
|
|
2048
|
+
* Discount percentage amount.
|
|
2049
|
+
* @format DECIMAL_VALUE
|
|
2050
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
2051
|
+
*/
|
|
2052
|
+
percentage?: string | null;
|
|
1956
2053
|
}
|
|
1957
2054
|
export declare enum DiscountType {
|
|
1958
2055
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
2056
|
+
/** Discount applies to entire order. */
|
|
1959
2057
|
GLOBAL = "GLOBAL",
|
|
2058
|
+
/** Discount applies to specific items. */
|
|
1960
2059
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
2060
|
+
/** Discount applies to shipping. For example, free shipping. */
|
|
1961
2061
|
SHIPPING = "SHIPPING"
|
|
1962
2062
|
}
|
|
1963
2063
|
export interface CreateCustomDiscountsResponse {
|
|
1964
|
-
/**
|
|
2064
|
+
/** Draft order details calculated with latest content. */
|
|
1965
2065
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1966
2066
|
}
|
|
1967
2067
|
export interface DeleteCustomDiscountsRequest {
|
|
1968
2068
|
/**
|
|
1969
|
-
*
|
|
2069
|
+
* Draft order ID.
|
|
1970
2070
|
* @format GUID
|
|
1971
2071
|
*/
|
|
1972
2072
|
draftOrderId: string;
|
|
1973
2073
|
/**
|
|
1974
|
-
*
|
|
2074
|
+
* Ids of discounts to remove.
|
|
1975
2075
|
* @format GUID
|
|
1976
2076
|
* @minSize 1
|
|
1977
2077
|
* @maxSize 100
|
|
@@ -1979,34 +2079,35 @@ export interface DeleteCustomDiscountsRequest {
|
|
|
1979
2079
|
discountIds: string[];
|
|
1980
2080
|
}
|
|
1981
2081
|
export interface DeleteCustomDiscountsResponse {
|
|
1982
|
-
/**
|
|
2082
|
+
/** Draft order details calculated with latest content. */
|
|
1983
2083
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1984
2084
|
}
|
|
1985
2085
|
export interface SetAdditionalFeesRequest {
|
|
1986
2086
|
/**
|
|
1987
|
-
*
|
|
2087
|
+
* Draft order ID.
|
|
1988
2088
|
* @format GUID
|
|
1989
2089
|
*/
|
|
1990
2090
|
draftOrderId: string;
|
|
1991
2091
|
/**
|
|
1992
|
-
*
|
|
2092
|
+
* Additional fee IDs to apply/unapply.
|
|
2093
|
+
* Existing additional fees, not mentioned in this list, will keep their current state.
|
|
1993
2094
|
* @minSize 1
|
|
1994
2095
|
* @maxSize 100
|
|
1995
2096
|
*/
|
|
1996
2097
|
additionalFees: IdAndApplied[];
|
|
1997
2098
|
}
|
|
1998
2099
|
export interface SetAdditionalFeesResponse {
|
|
1999
|
-
/**
|
|
2100
|
+
/** Draft order details calculated with latest content. */
|
|
2000
2101
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2001
2102
|
}
|
|
2002
2103
|
export interface CreateCustomAdditionalFeesRequest {
|
|
2003
2104
|
/**
|
|
2004
|
-
*
|
|
2105
|
+
* Draft order ID.
|
|
2005
2106
|
* @format GUID
|
|
2006
2107
|
*/
|
|
2007
2108
|
draftOrderId: string;
|
|
2008
2109
|
/**
|
|
2009
|
-
* The additional fees to
|
|
2110
|
+
* The additional fees to create. Created fees are unapplied by default.
|
|
2010
2111
|
* @minSize 1
|
|
2011
2112
|
* @maxSize 100
|
|
2012
2113
|
*/
|
|
@@ -2025,7 +2126,7 @@ export interface AdditionalFeeOption {
|
|
|
2025
2126
|
taxDetails?: TaxDetails;
|
|
2026
2127
|
/**
|
|
2027
2128
|
* Should apply the additional fee. default = false.
|
|
2028
|
-
* if not set or false, then to apply them, please call ApplyAdditionalFees with the added additional fee
|
|
2129
|
+
* if not set or false, then to apply them, please call ApplyAdditionalFees with the added additional fee IDs.
|
|
2029
2130
|
*/
|
|
2030
2131
|
applyToDraftOrder?: boolean | null;
|
|
2031
2132
|
/**
|
|
@@ -2034,19 +2135,26 @@ export interface AdditionalFeeOption {
|
|
|
2034
2135
|
* @maxLength 100
|
|
2035
2136
|
*/
|
|
2036
2137
|
code?: string | null;
|
|
2138
|
+
/**
|
|
2139
|
+
* Optional - Line items associated with this additional fee.
|
|
2140
|
+
* If no `lineItemIds` are provided, the fee will be associated with the whole order.
|
|
2141
|
+
* @format GUID
|
|
2142
|
+
* @maxSize 300
|
|
2143
|
+
*/
|
|
2144
|
+
lineItemIds?: string[];
|
|
2037
2145
|
}
|
|
2038
2146
|
export interface CreateCustomAdditionalFeesResponse {
|
|
2039
|
-
/**
|
|
2147
|
+
/** Draft order details calculated with latest content. */
|
|
2040
2148
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2041
2149
|
}
|
|
2042
2150
|
export interface DeleteCustomAdditionalFeesRequest {
|
|
2043
2151
|
/**
|
|
2044
|
-
*
|
|
2152
|
+
* Draft order ID.
|
|
2045
2153
|
* @format GUID
|
|
2046
2154
|
*/
|
|
2047
2155
|
draftOrderId: string;
|
|
2048
2156
|
/**
|
|
2049
|
-
*
|
|
2157
|
+
* Ids of additional fees to remove.
|
|
2050
2158
|
* @format GUID
|
|
2051
2159
|
* @minSize 1
|
|
2052
2160
|
* @maxSize 100
|
|
@@ -2054,93 +2162,138 @@ export interface DeleteCustomAdditionalFeesRequest {
|
|
|
2054
2162
|
customAdditionalFees: string[];
|
|
2055
2163
|
}
|
|
2056
2164
|
export interface DeleteCustomAdditionalFeesResponse {
|
|
2057
|
-
/**
|
|
2165
|
+
/** Draft order details calculated with latest content. */
|
|
2058
2166
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2059
2167
|
}
|
|
2060
2168
|
export interface SetShippingInfoRequest {
|
|
2169
|
+
/**
|
|
2170
|
+
* Draft order ID.
|
|
2171
|
+
* @format GUID
|
|
2172
|
+
*/
|
|
2173
|
+
draftOrderId: string;
|
|
2174
|
+
/** Shipping information. Empty value removes shipping information from draft. */
|
|
2175
|
+
shippingInfo?: V1ShippingInformation;
|
|
2061
2176
|
}
|
|
2062
2177
|
export interface SetShippingInfoResponse {
|
|
2178
|
+
/** Draft order details calculated with latest content. */
|
|
2179
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2063
2180
|
}
|
|
2064
2181
|
export interface SetBuyerInfoRequest {
|
|
2182
|
+
/**
|
|
2183
|
+
* Draft order ID.
|
|
2184
|
+
* @format GUID
|
|
2185
|
+
*/
|
|
2186
|
+
draftOrderId: string;
|
|
2187
|
+
/** Buyer information. Empty value removes buyer information from draft. */
|
|
2188
|
+
buyerInfo?: BuyerInfo;
|
|
2065
2189
|
}
|
|
2066
2190
|
export interface SetBuyerInfoResponse {
|
|
2191
|
+
/** Draft order details calculated with latest content. */
|
|
2192
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2067
2193
|
}
|
|
2068
2194
|
export interface SetRecipientInfoRequest {
|
|
2195
|
+
/**
|
|
2196
|
+
* Draft order ID.
|
|
2197
|
+
* @format GUID
|
|
2198
|
+
*/
|
|
2199
|
+
draftOrderId: string;
|
|
2200
|
+
/** Order recipient address and contact details. Empty value removes recipient information from draft. */
|
|
2201
|
+
recipientInfo?: AddressWithContact;
|
|
2069
2202
|
}
|
|
2070
2203
|
export interface SetRecipientInfoResponse {
|
|
2204
|
+
/** Draft order details calculated with latest content. */
|
|
2205
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2071
2206
|
}
|
|
2072
2207
|
export interface SetBillingInfoRequest {
|
|
2208
|
+
/**
|
|
2209
|
+
* Draft order ID.
|
|
2210
|
+
* @format GUID
|
|
2211
|
+
*/
|
|
2212
|
+
draftOrderId: string;
|
|
2213
|
+
/** Billing address and contact details. Empty value removes billing information from draft. */
|
|
2214
|
+
billingInfo?: AddressWithContact;
|
|
2073
2215
|
}
|
|
2074
2216
|
export interface SetBillingInfoResponse {
|
|
2217
|
+
/** Draft order details calculated with latest content. */
|
|
2218
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2075
2219
|
}
|
|
2220
|
+
/** Deprecated */
|
|
2076
2221
|
export interface UpdateShippingInfoRequest {
|
|
2077
2222
|
/**
|
|
2078
|
-
*
|
|
2223
|
+
* Draft order ID.
|
|
2079
2224
|
* @format GUID
|
|
2080
2225
|
*/
|
|
2081
2226
|
draftOrderId?: string;
|
|
2082
|
-
/**
|
|
2227
|
+
/** Update the shipping option on the order. If not set then the selected shipping is removed. */
|
|
2083
2228
|
shippingOption?: ShippingOption;
|
|
2084
2229
|
}
|
|
2230
|
+
/** Deprecated */
|
|
2085
2231
|
export interface UpdateShippingInfoResponse {
|
|
2086
|
-
/**
|
|
2232
|
+
/** Draft order details calculated with latest content. */
|
|
2087
2233
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2088
2234
|
}
|
|
2089
2235
|
export interface GetDraftOrderRequest {
|
|
2090
2236
|
/**
|
|
2091
|
-
*
|
|
2237
|
+
* Draft order ID.
|
|
2092
2238
|
* @format GUID
|
|
2093
2239
|
*/
|
|
2094
2240
|
draftOrderId: string;
|
|
2095
2241
|
}
|
|
2096
2242
|
export interface GetDraftOrderResponse {
|
|
2097
|
-
/**
|
|
2243
|
+
/** Draft order details calculated with latest content. */
|
|
2098
2244
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2099
2245
|
}
|
|
2100
2246
|
export interface GetOrderDraftabilityStatusRequest {
|
|
2101
2247
|
/**
|
|
2102
|
-
* Order
|
|
2103
|
-
* @
|
|
2104
|
-
* @maxLength 100
|
|
2248
|
+
* Order Id.
|
|
2249
|
+
* @format GUID
|
|
2105
2250
|
*/
|
|
2106
2251
|
orderId: string;
|
|
2107
2252
|
}
|
|
2108
2253
|
export interface GetOrderDraftabilityStatusResponse {
|
|
2109
2254
|
/**
|
|
2110
|
-
* Order
|
|
2111
|
-
* @
|
|
2112
|
-
* @maxLength 100
|
|
2255
|
+
* Order Id.
|
|
2256
|
+
* @format GUID
|
|
2113
2257
|
*/
|
|
2114
2258
|
orderId?: string;
|
|
2115
|
-
/**
|
|
2259
|
+
/** Flag, indicating whether a draft can be created from this order. */
|
|
2116
2260
|
orderDraftable?: boolean;
|
|
2117
2261
|
/**
|
|
2118
|
-
* Reasons why the order is not draftable
|
|
2262
|
+
* Reasons why the order is not draftable.
|
|
2119
2263
|
* @maxSize 5
|
|
2120
2264
|
*/
|
|
2121
2265
|
nonDraftableReasons?: NonDraftableReason[];
|
|
2122
2266
|
}
|
|
2123
2267
|
export declare enum NonDraftableReason {
|
|
2124
2268
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2269
|
+
/** Modifications of refunded orders are not supported. */
|
|
2125
2270
|
PARTIALLY_OR_FULLY_REFUNDED = "PARTIALLY_OR_FULLY_REFUNDED",
|
|
2271
|
+
/**
|
|
2272
|
+
* Original order must be created via one of the following channel types:
|
|
2273
|
+
* + WEB
|
|
2274
|
+
* + POS
|
|
2275
|
+
* + BACKOFFICE_MERCHANT
|
|
2276
|
+
* + WIX_APP_STORE
|
|
2277
|
+
*/
|
|
2126
2278
|
UNSUPPORTED_CHANNEL_TYPE = "UNSUPPORTED_CHANNEL_TYPE",
|
|
2279
|
+
/** Order status is not APPROVED. */
|
|
2127
2280
|
ORDER_STATUS_IS_NOT_SUPPORTED = "ORDER_STATUS_IS_NOT_SUPPORTED",
|
|
2281
|
+
/** Site and order currencies are different. */
|
|
2128
2282
|
ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT = "ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT",
|
|
2283
|
+
/** Site and order weight units are different. */
|
|
2129
2284
|
ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT = "ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT",
|
|
2130
|
-
|
|
2131
|
-
/** remove - this is not a reason, it's an error */
|
|
2285
|
+
/** Order not found. */
|
|
2132
2286
|
ORDER_NOT_FOUND = "ORDER_NOT_FOUND",
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
TAXABLE_EXISTING_ADDITIONAL_FEE = "TAXABLE_EXISTING_ADDITIONAL_FEE"
|
|
2287
|
+
/** Modifications of orders with subscription items are not supported. */
|
|
2288
|
+
SUBSCRIPTION_LINE_ITEM_EXISTS = "SUBSCRIPTION_LINE_ITEM_EXISTS"
|
|
2136
2289
|
}
|
|
2137
2290
|
export interface CommitDraftOrderRequest {
|
|
2138
2291
|
/**
|
|
2139
|
-
*
|
|
2292
|
+
* Draft order ID.
|
|
2140
2293
|
* @format GUID
|
|
2141
2294
|
*/
|
|
2142
2295
|
draftOrderId: string;
|
|
2143
|
-
/** Optional side effects to trigger */
|
|
2296
|
+
/** Optional side effects to trigger. */
|
|
2144
2297
|
commitSettings?: DraftOrderCommitSettings;
|
|
2145
2298
|
/**
|
|
2146
2299
|
* Reason for edit, given by user (optional).
|
|
@@ -2149,9 +2302,9 @@ export interface CommitDraftOrderRequest {
|
|
|
2149
2302
|
reason?: string | null;
|
|
2150
2303
|
}
|
|
2151
2304
|
export interface CommitDraftOrderResponse {
|
|
2152
|
-
/**
|
|
2305
|
+
/** Draft order after commit. */
|
|
2153
2306
|
committedDraftOrder?: DraftOrder;
|
|
2154
|
-
/**
|
|
2307
|
+
/** Updated order after commit. */
|
|
2155
2308
|
orderAfterCommit?: Order;
|
|
2156
2309
|
}
|
|
2157
2310
|
export interface Order {
|
|
@@ -3206,16 +3359,48 @@ export interface TagList {
|
|
|
3206
3359
|
tagIds?: string[];
|
|
3207
3360
|
}
|
|
3208
3361
|
export interface CreateOrderFromDraftRequest {
|
|
3362
|
+
/**
|
|
3363
|
+
* Draft order ID.
|
|
3364
|
+
* @format GUID
|
|
3365
|
+
*/
|
|
3366
|
+
draftOrderId: string;
|
|
3367
|
+
/** Optional side effects to trigger. */
|
|
3368
|
+
createSettings?: OrderCreateSettings;
|
|
3369
|
+
/**
|
|
3370
|
+
* Reason for order creation, given by user (optional).
|
|
3371
|
+
* @maxLength 200
|
|
3372
|
+
*/
|
|
3373
|
+
reason?: string | null;
|
|
3374
|
+
/** Information about the sales channel that submitted this order. */
|
|
3375
|
+
channelInfo?: ChannelInfo;
|
|
3209
3376
|
}
|
|
3210
3377
|
export interface OrderCreateSettings {
|
|
3378
|
+
/** Notification settings to be applied on order creation */
|
|
3379
|
+
notifications?: OrderCreateNotifications;
|
|
3211
3380
|
}
|
|
3212
3381
|
export interface OrderCreateNotifications {
|
|
3382
|
+
/**
|
|
3383
|
+
* Whether to send notification to the buyer.
|
|
3384
|
+
*
|
|
3385
|
+
* Default: `true`
|
|
3386
|
+
*/
|
|
3387
|
+
sendNotificationToBuyer?: boolean | null;
|
|
3388
|
+
/**
|
|
3389
|
+
* Whether to send notifications to the business.
|
|
3390
|
+
*
|
|
3391
|
+
* Default: `true`
|
|
3392
|
+
*/
|
|
3393
|
+
sendNotificationsToBusiness?: boolean | null;
|
|
3213
3394
|
}
|
|
3214
3395
|
export interface CreateOrderFromDraftResponse {
|
|
3396
|
+
/** The draft order after commit. */
|
|
3397
|
+
committedDraftOrder?: DraftOrder;
|
|
3398
|
+
/** Created order. */
|
|
3399
|
+
createdOrder?: Order;
|
|
3215
3400
|
}
|
|
3216
3401
|
export interface DeleteDraftOrderRequest {
|
|
3217
3402
|
/**
|
|
3218
|
-
*
|
|
3403
|
+
* Draft order ID.
|
|
3219
3404
|
* @format GUID
|
|
3220
3405
|
*/
|
|
3221
3406
|
draftOrderId: string;
|
|
@@ -3223,7 +3408,7 @@ export interface DeleteDraftOrderRequest {
|
|
|
3223
3408
|
export interface DeleteDraftOrderResponse {
|
|
3224
3409
|
}
|
|
3225
3410
|
export interface QueryDraftOrdersRequest {
|
|
3226
|
-
/**
|
|
3411
|
+
/** Query options. */
|
|
3227
3412
|
query?: CursorQuery;
|
|
3228
3413
|
}
|
|
3229
3414
|
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
@@ -3285,7 +3470,7 @@ export interface CursorPaging {
|
|
|
3285
3470
|
cursor?: string | null;
|
|
3286
3471
|
}
|
|
3287
3472
|
export interface QueryDraftOrdersResponse {
|
|
3288
|
-
/**
|
|
3473
|
+
/** Draft orders, found by query. */
|
|
3289
3474
|
draftOrders?: DraftOrder[];
|
|
3290
3475
|
/** Paging metadata. */
|
|
3291
3476
|
pagingMetadata?: CursorPagingMetadata;
|
|
@@ -3317,42 +3502,45 @@ export interface Cursors {
|
|
|
3317
3502
|
}
|
|
3318
3503
|
export interface UpdateExtendedFieldsRequest {
|
|
3319
3504
|
/** ID of the entity to update. */
|
|
3320
|
-
_id
|
|
3505
|
+
_id: string;
|
|
3321
3506
|
/** Identifier for the app whose extended fields are being updated. */
|
|
3322
|
-
namespace
|
|
3507
|
+
namespace: string;
|
|
3323
3508
|
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
3324
|
-
namespaceData
|
|
3509
|
+
namespaceData: Record<string, any> | null;
|
|
3325
3510
|
}
|
|
3326
3511
|
export interface UpdateExtendedFieldsResponse {
|
|
3327
|
-
/** Updated
|
|
3512
|
+
/** Updated draft order. */
|
|
3328
3513
|
draftOrder?: DraftOrder;
|
|
3329
3514
|
}
|
|
3330
3515
|
export interface SetTaxExemptionRequest {
|
|
3331
|
-
}
|
|
3332
|
-
export interface SetTaxExemptionResponse {
|
|
3333
|
-
}
|
|
3334
|
-
export interface GetDraftEditabilityStatusRequest {
|
|
3335
3516
|
/**
|
|
3336
3517
|
* Draft order ID.
|
|
3337
3518
|
* @format GUID
|
|
3338
3519
|
*/
|
|
3339
|
-
draftOrderId
|
|
3520
|
+
draftOrderId: string;
|
|
3521
|
+
/**
|
|
3522
|
+
* Flag, indicating whether the draft order is exempt from tax calculations.
|
|
3523
|
+
*
|
|
3524
|
+
* Default: `false`
|
|
3525
|
+
*/
|
|
3526
|
+
taxExempt: boolean | null;
|
|
3340
3527
|
}
|
|
3341
|
-
export interface
|
|
3528
|
+
export interface SetTaxExemptionResponse {
|
|
3529
|
+
/** Draft order details calculated with latest content. */
|
|
3530
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
3531
|
+
}
|
|
3532
|
+
export interface SetBusinessLocationRequest {
|
|
3342
3533
|
/**
|
|
3343
3534
|
* Draft order ID.
|
|
3344
3535
|
* @format GUID
|
|
3345
3536
|
*/
|
|
3346
|
-
draftOrderId
|
|
3347
|
-
/**
|
|
3348
|
-
|
|
3349
|
-
* @readonly
|
|
3350
|
-
*/
|
|
3351
|
-
status?: EditingStatus;
|
|
3352
|
-
}
|
|
3353
|
-
export interface SetBusinessLocationRequest {
|
|
3537
|
+
draftOrderId: string;
|
|
3538
|
+
/** Business location. */
|
|
3539
|
+
businessLocation?: Location;
|
|
3354
3540
|
}
|
|
3355
3541
|
export interface SetBusinessLocationResponse {
|
|
3542
|
+
/** Draft order details calculated with latest content. */
|
|
3543
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
3356
3544
|
}
|
|
3357
3545
|
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
3358
3546
|
createdEvent?: EntityCreatedEvent;
|
|
@@ -3494,13 +3682,13 @@ export declare enum WebhookIdentityType {
|
|
|
3494
3682
|
WIX_USER = "WIX_USER",
|
|
3495
3683
|
APP = "APP"
|
|
3496
3684
|
}
|
|
3497
|
-
type DraftOrderNonNullablePaths = `lineItems` | `lineItems.${number}.added` | `lineItems.${number}.changedDetails.priceBeforeChange.amount` | `lineItems.${number}.changedDetails.priceBeforeChange.formattedAmount` | `lineItems.${number}.changedDetails.priceDescriptionBeforeChange.original` | `lineItems.${number}.removed` | `lineItems.${number}.lineItem._id` | `lineItems.${number}.lineItem.productName.original` | `lineItems.${number}.lineItem.catalogReference.catalogItemId` | `lineItems.${number}.lineItem.catalogReference.appId` | `lineItems.${number}.lineItem.quantity` | `lineItems.${number}.lineItem.physicalProperties.shippable` | `lineItems.${number}.lineItem.itemType.preset` | `lineItems.${number}.lineItem.itemType.custom` | `lineItems.${number}.lineItem.paymentOption` | `lineItems.${number}.lineItem.taxDetails.taxRate` | `lineItems.${number}.lineItem.taxInfo.taxIncludedInPrice` | `lineItems.${number}.lineItem.digitalFile.fileId` | `lineItems.${number}.lineItem.subscriptionInfo.cycleNumber` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.autoRenewal` | `shippingInfo.added` | `shippingInfo.changedDetails.shippingInfoBeforeChange.title` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.pickupMethod` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.price.amount` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.price.formattedAmount` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.taxDetails.taxRate` | `shippingInfo.removed` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `additionalFees` | `additionalFees.${number}.additionalFee.name` | `additionalFees.${number}.additionalFee.price.amount` | `additionalFees.${number}.additionalFee.price.formattedAmount` | `additionalFees.${number}.additionalFee.taxDetails.taxRate` | `additionalFees.${number}.additionalFee._id` | `additionalFees.${number}.taxDetails.taxable` | `additionalFees.${number}.source` | `additionalFees.${number}.applied` | `discounts` | `discounts.${number}.discount.coupon._id` | `discounts.${number}.discount.coupon.code` | `discounts.${number}.discount.coupon.name` | `discounts.${number}.discount.coupon.amount.amount` | `discounts.${number}.discount.coupon.amount.formattedAmount` | `discounts.${number}.discount.merchantDiscount.discountReason` | `discounts.${number}.discount.discountRule._id` | `discounts.${number}.discount.discountRule.name.original` | `discounts.${number}.discount.discountType` | `discounts.${number}.source` | `discounts.${number}.applied` | `createdBy.userId` | `createdBy.appId` | `status` | `weightUnit` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `taxSummary.totalTax.amount` | `taxSummary.totalTax.formattedAmount` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.
|
|
3685
|
+
type DraftOrderNonNullablePaths = `lineItems` | `lineItems.${number}.added` | `lineItems.${number}.changedDetails.priceBeforeChange.amount` | `lineItems.${number}.changedDetails.priceBeforeChange.formattedAmount` | `lineItems.${number}.changedDetails.priceDescriptionBeforeChange.original` | `lineItems.${number}.removed` | `lineItems.${number}.lineItem._id` | `lineItems.${number}.lineItem.productName.original` | `lineItems.${number}.lineItem.catalogReference.catalogItemId` | `lineItems.${number}.lineItem.catalogReference.appId` | `lineItems.${number}.lineItem.quantity` | `lineItems.${number}.lineItem.physicalProperties.shippable` | `lineItems.${number}.lineItem.itemType.preset` | `lineItems.${number}.lineItem.itemType.custom` | `lineItems.${number}.lineItem.paymentOption` | `lineItems.${number}.lineItem.taxDetails.taxRate` | `lineItems.${number}.lineItem.taxInfo.taxIncludedInPrice` | `lineItems.${number}.lineItem.digitalFile.fileId` | `lineItems.${number}.lineItem.subscriptionInfo.cycleNumber` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.lineItem.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.lineItem.taxableAddress.addressType` | `shippingInfo.added` | `shippingInfo.changedDetails.shippingInfoBeforeChange.title` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.pickupMethod` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.price.amount` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.price.formattedAmount` | `shippingInfo.changedDetails.shippingInfoBeforeChange.cost.taxDetails.taxRate` | `shippingInfo.removed` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `additionalFees` | `additionalFees.${number}.additionalFee.name` | `additionalFees.${number}.additionalFee.price.amount` | `additionalFees.${number}.additionalFee.price.formattedAmount` | `additionalFees.${number}.additionalFee.taxDetails.taxRate` | `additionalFees.${number}.additionalFee._id` | `additionalFees.${number}.taxDetails.taxable` | `additionalFees.${number}.source` | `additionalFees.${number}.applied` | `discounts` | `discounts.${number}.discount.coupon._id` | `discounts.${number}.discount.coupon.code` | `discounts.${number}.discount.coupon.name` | `discounts.${number}.discount.coupon.amount.amount` | `discounts.${number}.discount.coupon.amount.formattedAmount` | `discounts.${number}.discount.merchantDiscount.discountReason` | `discounts.${number}.discount.discountRule._id` | `discounts.${number}.discount.discountRule.name.original` | `discounts.${number}.discount.discountType` | `discounts.${number}.source` | `discounts.${number}.applied` | `createdBy.userId` | `createdBy.appId` | `status` | `weightUnit` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `taxSummary.totalTax.amount` | `taxSummary.totalTax.formattedAmount` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.paid.amount` | `balanceSummary.paid.formattedAmount` | `commitSettings.updateInventory` | `commitSettings.updateInventory.${number}.lineItemId` | `recipientInfo.added` | `recipientInfo.changedDetails.recipientInfoBeforeChange.address.streetAddress.number` | `recipientInfo.changedDetails.recipientInfoBeforeChange.address.streetAddress.name` | `recipientInfo.changedDetails.recipientInfoBeforeChange.contactDetails.vatId._id` | `recipientInfo.changedDetails.recipientInfoBeforeChange.contactDetails.vatId.type` | `recipientInfo.removed` | `taxInfo.totalTax.amount` | `taxInfo.totalTax.formattedAmount` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `buyerDetails.added` | `buyerDetails.changedDetails.buyerInfoBeforeChange.visitorId` | `buyerDetails.changedDetails.buyerInfoBeforeChange.memberId` | `buyerDetails.removed` | `billingDetails.added` | `billingDetails.changedDetails.billingInfoBeforeChange.address.streetAddress.number` | `billingDetails.changedDetails.billingInfoBeforeChange.address.streetAddress.name` | `billingDetails.changedDetails.billingInfoBeforeChange.contactDetails.vatId._id` | `billingDetails.changedDetails.billingInfoBeforeChange.contactDetails.vatId.type` | `billingDetails.removed` | `businessLocationDetails.added` | `businessLocationDetails.changedDetails.businessLocationBeforeChange._id` | `businessLocationDetails.changedDetails.businessLocationBeforeChange.name` | `businessLocationDetails.removed`;
|
|
3498
3686
|
/**
|
|
3499
3687
|
* Creates or gets a draft order.
|
|
3500
3688
|
*
|
|
3501
3689
|
* When passing the ID of an order that is already in draft, the existing draft order will be returned.
|
|
3502
|
-
* To complete a draft and update the order, call
|
|
3503
|
-
* @param orderId -
|
|
3690
|
+
* To complete a draft and update the order, call Commit Draft Order([REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/draft-orders/commit-draft-order) | [SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/draft-orders/commit-draft-order)).
|
|
3691
|
+
* @param orderId - Existing order ID to create draft from.
|
|
3504
3692
|
* @public
|
|
3505
3693
|
* @documentationMaturity preview
|
|
3506
3694
|
* @requiredField orderId
|
|
@@ -3540,7 +3728,7 @@ export declare function createEmptyDraftOrder(): Promise<NonNullablePaths<Create
|
|
|
3540
3728
|
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
3541
3729
|
/**
|
|
3542
3730
|
* Adds line items to a draft order.
|
|
3543
|
-
* @param draftOrderId -
|
|
3731
|
+
* @param draftOrderId - Draft order ID.
|
|
3544
3732
|
* @public
|
|
3545
3733
|
* @documentationMaturity preview
|
|
3546
3734
|
* @requiredField draftOrderId
|
|
@@ -3578,10 +3766,13 @@ export interface AddLineItemsToDraftOrderOptions {
|
|
|
3578
3766
|
* > + Passing a quantity of `0` will remove the line item.
|
|
3579
3767
|
* > + Price cannot be updated for line items with `paymentOption: MEMBERSHIP`.
|
|
3580
3768
|
* > + Quantity cannot be decreased fulfilled line items. To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
|
|
3581
|
-
* @param draftOrderId -
|
|
3769
|
+
* @param draftOrderId - Draft order ID.
|
|
3770
|
+
* @param lineItemChanges - Details of changes to apply per line item.
|
|
3582
3771
|
* @public
|
|
3583
3772
|
* @documentationMaturity preview
|
|
3584
3773
|
* @requiredField draftOrderId
|
|
3774
|
+
* @requiredField lineItemChanges
|
|
3775
|
+
* @requiredField lineItemChanges.lineItemId
|
|
3585
3776
|
* @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
|
|
3586
3777
|
* @permissionScope Manage Stores - all permissions
|
|
3587
3778
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
@@ -3592,26 +3783,22 @@ export interface AddLineItemsToDraftOrderOptions {
|
|
|
3592
3783
|
* @applicableIdentity APP
|
|
3593
3784
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateLineItems
|
|
3594
3785
|
*/
|
|
3595
|
-
export declare function updateLineItems(draftOrderId: string,
|
|
3786
|
+
export declare function updateLineItems(draftOrderId: string, lineItemChanges: NonNullablePaths<LineItemChangeDetails, `lineItemId`>[]): Promise<NonNullablePaths<UpdateLineItemsResponse, {
|
|
3596
3787
|
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3597
3788
|
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
3598
|
-
export interface UpdateLineItemsOptions {
|
|
3599
|
-
/**
|
|
3600
|
-
* Details of changes to apply per line item
|
|
3601
|
-
* @minSize 1
|
|
3602
|
-
* @maxSize 300
|
|
3603
|
-
*/
|
|
3604
|
-
lineItemChanges?: LineItemChangeDetails[];
|
|
3605
|
-
}
|
|
3606
3789
|
/**
|
|
3607
|
-
*
|
|
3790
|
+
* Applies or unapplies discounts on a draft order.
|
|
3608
3791
|
*
|
|
3609
|
-
*
|
|
3610
|
-
*
|
|
3611
|
-
* @param
|
|
3792
|
+
* Unapplied discounts are still part of draft order, but do not affect balance.
|
|
3793
|
+
* Existing discounts, not mentioned in request, will keep their current state.
|
|
3794
|
+
* @param draftOrderId - Draft order ID.
|
|
3795
|
+
* @param discounts - Discount IDs to apply/unapply.
|
|
3796
|
+
* Existing discounts, not mentioned in request, will keep their current state.
|
|
3612
3797
|
* @public
|
|
3613
3798
|
* @documentationMaturity preview
|
|
3614
3799
|
* @requiredField discounts
|
|
3800
|
+
* @requiredField discounts._id
|
|
3801
|
+
* @requiredField discounts.applied
|
|
3615
3802
|
* @requiredField draftOrderId
|
|
3616
3803
|
* @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS
|
|
3617
3804
|
* @permissionScope Manage Stores - all permissions
|
|
@@ -3623,18 +3810,21 @@ export interface UpdateLineItemsOptions {
|
|
|
3623
3810
|
* @applicableIdentity APP
|
|
3624
3811
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetDiscounts
|
|
3625
3812
|
*/
|
|
3626
|
-
export declare function setDiscounts(draftOrderId: string, discounts: IdAndApplied[]): Promise<NonNullablePaths<SetDiscountsResponse, {
|
|
3813
|
+
export declare function setDiscounts(draftOrderId: string, discounts: NonNullablePaths<IdAndApplied, `_id` | `applied`>[]): Promise<NonNullablePaths<SetDiscountsResponse, {
|
|
3627
3814
|
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3628
3815
|
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
3629
3816
|
/**
|
|
3630
|
-
*
|
|
3631
|
-
*
|
|
3817
|
+
* Create custom discounts on a draft order.
|
|
3818
|
+
*
|
|
3819
|
+
* Newly added discounts are unapplied by default.
|
|
3820
|
+
* To apply them, use Set Discounts ([REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/draft-orders/set-discounts) | [SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/draft-orders/set-discounts)).
|
|
3821
|
+
* @param draftOrderId - Draft order ID.
|
|
3632
3822
|
* @public
|
|
3633
3823
|
* @documentationMaturity preview
|
|
3634
3824
|
* @requiredField draftOrderId
|
|
3635
|
-
* @requiredField options.discounts.amount
|
|
3636
3825
|
* @requiredField options.discounts.amount.amount
|
|
3637
3826
|
* @requiredField options.discounts.discountType
|
|
3827
|
+
* @requiredField options.discounts.priceAmount.amount
|
|
3638
3828
|
* @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS
|
|
3639
3829
|
* @permissionScope Manage Stores - all permissions
|
|
3640
3830
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
@@ -3645,12 +3835,12 @@ export declare function setDiscounts(draftOrderId: string, discounts: IdAndAppli
|
|
|
3645
3835
|
* @applicableIdentity APP
|
|
3646
3836
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateCustomDiscounts
|
|
3647
3837
|
*/
|
|
3648
|
-
export declare function createCustomDiscounts(draftOrderId: string, options?: NonNullablePaths<CreateCustomDiscountsOptions, `discounts.${number}.amount` | `discounts.${number}.
|
|
3838
|
+
export declare function createCustomDiscounts(draftOrderId: string, options?: NonNullablePaths<CreateCustomDiscountsOptions, `discounts.${number}.amount.amount` | `discounts.${number}.discountType` | `discounts.${number}.priceAmount.amount`>): Promise<NonNullablePaths<CreateCustomDiscountsResponse, {
|
|
3649
3839
|
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3650
3840
|
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
3651
3841
|
export interface CreateCustomDiscountsOptions {
|
|
3652
3842
|
/**
|
|
3653
|
-
*
|
|
3843
|
+
* Discounts to create. Created discounts are unapplied by default.
|
|
3654
3844
|
* @minSize 1
|
|
3655
3845
|
* @maxSize 100
|
|
3656
3846
|
*/
|
|
@@ -3658,8 +3848,8 @@ export interface CreateCustomDiscountsOptions {
|
|
|
3658
3848
|
}
|
|
3659
3849
|
/**
|
|
3660
3850
|
* Remove custom discounts from the order.
|
|
3661
|
-
* @param draftOrderId -
|
|
3662
|
-
* @param discountIds -
|
|
3851
|
+
* @param draftOrderId - Draft order ID.
|
|
3852
|
+
* @param discountIds - Ids of discounts to remove.
|
|
3663
3853
|
* @public
|
|
3664
3854
|
* @documentationMaturity preview
|
|
3665
3855
|
* @requiredField discountIds
|
|
@@ -3678,13 +3868,18 @@ export declare function deleteCustomDiscounts(draftOrderId: string, discountIds:
|
|
|
3678
3868
|
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3679
3869
|
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
3680
3870
|
/**
|
|
3681
|
-
*
|
|
3682
|
-
*
|
|
3683
|
-
*
|
|
3684
|
-
*
|
|
3871
|
+
* Applies or unapplies additional fees on a draft order.
|
|
3872
|
+
*
|
|
3873
|
+
* Unapplied fees are still part of draft order, but do not affect balance.
|
|
3874
|
+
* Existing additional fees, not mentioned in request, will keep their current state.
|
|
3875
|
+
* @param draftOrderId - Draft order ID.
|
|
3876
|
+
* @param additionalFees - Additional fee IDs to apply/unapply.
|
|
3877
|
+
* Existing additional fees, not mentioned in this list, will keep their current state.
|
|
3685
3878
|
* @public
|
|
3686
3879
|
* @documentationMaturity preview
|
|
3687
3880
|
* @requiredField additionalFees
|
|
3881
|
+
* @requiredField additionalFees._id
|
|
3882
|
+
* @requiredField additionalFees.applied
|
|
3688
3883
|
* @requiredField draftOrderId
|
|
3689
3884
|
* @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES
|
|
3690
3885
|
* @permissionScope Manage Stores - all permissions
|
|
@@ -3696,14 +3891,15 @@ export declare function deleteCustomDiscounts(draftOrderId: string, discountIds:
|
|
|
3696
3891
|
* @applicableIdentity APP
|
|
3697
3892
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetAdditionalFees
|
|
3698
3893
|
*/
|
|
3699
|
-
export declare function setAdditionalFees(draftOrderId: string, additionalFees: IdAndApplied[]): Promise<NonNullablePaths<SetAdditionalFeesResponse, {
|
|
3894
|
+
export declare function setAdditionalFees(draftOrderId: string, additionalFees: NonNullablePaths<IdAndApplied, `_id` | `applied`>[]): Promise<NonNullablePaths<SetAdditionalFeesResponse, {
|
|
3700
3895
|
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3701
3896
|
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
3702
3897
|
/**
|
|
3703
|
-
*
|
|
3704
|
-
*
|
|
3705
|
-
*
|
|
3706
|
-
*
|
|
3898
|
+
* Creates custom additional fees on a draft order.
|
|
3899
|
+
*
|
|
3900
|
+
* Newly added additional fees are unapplied by default.
|
|
3901
|
+
* To apply them, use Set Additional Fees ([REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/draft-orders/set-additional-fees) | [SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/draft-orders/set-additional-fees)).
|
|
3902
|
+
* @param draftOrderId - Draft order ID.
|
|
3707
3903
|
* @public
|
|
3708
3904
|
* @documentationMaturity preview
|
|
3709
3905
|
* @requiredField draftOrderId
|
|
@@ -3725,7 +3921,7 @@ export declare function createCustomAdditionalFees(draftOrderId: string, options
|
|
|
3725
3921
|
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
3726
3922
|
export interface CreateCustomAdditionalFeesOptions {
|
|
3727
3923
|
/**
|
|
3728
|
-
* The additional fees to
|
|
3924
|
+
* The additional fees to create. Created fees are unapplied by default.
|
|
3729
3925
|
* @minSize 1
|
|
3730
3926
|
* @maxSize 100
|
|
3731
3927
|
*/
|
|
@@ -3733,8 +3929,8 @@ export interface CreateCustomAdditionalFeesOptions {
|
|
|
3733
3929
|
}
|
|
3734
3930
|
/**
|
|
3735
3931
|
* Remove custom additional fees from the order.
|
|
3736
|
-
* @param draftOrderId -
|
|
3737
|
-
* @param customAdditionalFees -
|
|
3932
|
+
* @param draftOrderId - Draft order ID.
|
|
3933
|
+
* @param customAdditionalFees - Ids of additional fees to remove.
|
|
3738
3934
|
* @public
|
|
3739
3935
|
* @documentationMaturity preview
|
|
3740
3936
|
* @requiredField customAdditionalFees
|
|
@@ -3753,9 +3949,11 @@ export declare function deleteCustomAdditionalFees(draftOrderId: string, customA
|
|
|
3753
3949
|
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3754
3950
|
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
3755
3951
|
/**
|
|
3756
|
-
* Sets shipping
|
|
3952
|
+
* Sets shipping information on a draft order.
|
|
3953
|
+
* @param draftOrderId - Draft order ID.
|
|
3757
3954
|
* @public
|
|
3758
3955
|
* @documentationMaturity preview
|
|
3956
|
+
* @requiredField draftOrderId
|
|
3759
3957
|
* @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
|
|
3760
3958
|
* @permissionScope Manage Stores - all permissions
|
|
3761
3959
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
@@ -3766,11 +3964,19 @@ export declare function deleteCustomAdditionalFees(draftOrderId: string, customA
|
|
|
3766
3964
|
* @applicableIdentity APP
|
|
3767
3965
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetShippingInfo
|
|
3768
3966
|
*/
|
|
3769
|
-
export declare function setShippingInfo(): Promise<
|
|
3967
|
+
export declare function setShippingInfo(draftOrderId: string, options?: SetShippingInfoOptions): Promise<NonNullablePaths<SetShippingInfoResponse, {
|
|
3968
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3969
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
3970
|
+
export interface SetShippingInfoOptions {
|
|
3971
|
+
/** Shipping information. Empty value removes shipping information from draft. */
|
|
3972
|
+
shippingInfo?: V1ShippingInformation;
|
|
3973
|
+
}
|
|
3770
3974
|
/**
|
|
3771
|
-
* Sets buyer info
|
|
3975
|
+
* Sets buyer info on a draft order.
|
|
3976
|
+
* @param draftOrderId - Draft order ID.
|
|
3772
3977
|
* @public
|
|
3773
3978
|
* @documentationMaturity preview
|
|
3979
|
+
* @requiredField draftOrderId
|
|
3774
3980
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
|
|
3775
3981
|
* @permissionScope Manage Stores - all permissions
|
|
3776
3982
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
@@ -3781,11 +3987,19 @@ export declare function setShippingInfo(): Promise<void>;
|
|
|
3781
3987
|
* @applicableIdentity APP
|
|
3782
3988
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBuyerInfo
|
|
3783
3989
|
*/
|
|
3784
|
-
export declare function setBuyerInfo(): Promise<
|
|
3990
|
+
export declare function setBuyerInfo(draftOrderId: string, options?: SetBuyerInfoOptions): Promise<NonNullablePaths<SetBuyerInfoResponse, {
|
|
3991
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3992
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
3993
|
+
export interface SetBuyerInfoOptions {
|
|
3994
|
+
/** Buyer information. Empty value removes buyer information from draft. */
|
|
3995
|
+
buyerInfo?: BuyerInfo;
|
|
3996
|
+
}
|
|
3785
3997
|
/**
|
|
3786
|
-
* Sets recipient info
|
|
3998
|
+
* Sets recipient info on a draft order.
|
|
3999
|
+
* @param draftOrderId - Draft order ID.
|
|
3787
4000
|
* @public
|
|
3788
4001
|
* @documentationMaturity preview
|
|
4002
|
+
* @requiredField draftOrderId
|
|
3789
4003
|
* @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
|
|
3790
4004
|
* @permissionScope Manage Stores - all permissions
|
|
3791
4005
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
@@ -3796,11 +4010,19 @@ export declare function setBuyerInfo(): Promise<void>;
|
|
|
3796
4010
|
* @applicableIdentity APP
|
|
3797
4011
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetRecipientInfo
|
|
3798
4012
|
*/
|
|
3799
|
-
export declare function setRecipientInfo(): Promise<
|
|
4013
|
+
export declare function setRecipientInfo(draftOrderId: string, options?: SetRecipientInfoOptions): Promise<NonNullablePaths<SetRecipientInfoResponse, {
|
|
4014
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4015
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4016
|
+
export interface SetRecipientInfoOptions {
|
|
4017
|
+
/** Order recipient address and contact details. Empty value removes recipient information from draft. */
|
|
4018
|
+
recipientInfo?: AddressWithContact;
|
|
4019
|
+
}
|
|
3800
4020
|
/**
|
|
3801
|
-
* Sets billing info
|
|
4021
|
+
* Sets billing info on a draft order.
|
|
4022
|
+
* @param draftOrderId - Draft order ID.
|
|
3802
4023
|
* @public
|
|
3803
4024
|
* @documentationMaturity preview
|
|
4025
|
+
* @requiredField draftOrderId
|
|
3804
4026
|
* @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
|
|
3805
4027
|
* @permissionScope Manage Stores - all permissions
|
|
3806
4028
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
@@ -3811,14 +4033,21 @@ export declare function setRecipientInfo(): Promise<void>;
|
|
|
3811
4033
|
* @applicableIdentity APP
|
|
3812
4034
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBillingInfo
|
|
3813
4035
|
*/
|
|
3814
|
-
export declare function setBillingInfo(): Promise<
|
|
4036
|
+
export declare function setBillingInfo(draftOrderId: string, options?: SetBillingInfoOptions): Promise<NonNullablePaths<SetBillingInfoResponse, {
|
|
4037
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4038
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4039
|
+
export interface SetBillingInfoOptions {
|
|
4040
|
+
/** Billing address and contact details. Empty value removes billing information from draft. */
|
|
4041
|
+
billingInfo?: AddressWithContact;
|
|
4042
|
+
}
|
|
3815
4043
|
/**
|
|
3816
|
-
*
|
|
3817
|
-
*
|
|
4044
|
+
* Gets a draft order.
|
|
4045
|
+
*
|
|
4046
|
+
* Draft order is recalculated and contains latest tax and totals (unless already committed).
|
|
3818
4047
|
* Automatic discounts and automatic additional fees will reflect the latest prices and eligibility.
|
|
3819
4048
|
* Calculation will be based on current draft order content - items, shipping info and eligible discounts and additional fees.
|
|
3820
|
-
* When
|
|
3821
|
-
* @param draftOrderId -
|
|
4049
|
+
* When retrieving an already committed draft, it's not recalculated and contains data calculated during commit.
|
|
4050
|
+
* @param draftOrderId - Draft order ID.
|
|
3822
4051
|
* @public
|
|
3823
4052
|
* @documentationMaturity preview
|
|
3824
4053
|
* @requiredField draftOrderId
|
|
@@ -3837,8 +4066,8 @@ export declare function getDraftOrder(draftOrderId: string): Promise<NonNullable
|
|
|
3837
4066
|
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
3838
4067
|
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
3839
4068
|
/**
|
|
3840
|
-
* Checks whether a draft can be created for this order
|
|
3841
|
-
* @param orderId - Order
|
|
4069
|
+
* Checks whether a draft can be created for this order.
|
|
4070
|
+
* @param orderId - Order Id.
|
|
3842
4071
|
* @public
|
|
3843
4072
|
* @documentationMaturity preview
|
|
3844
4073
|
* @requiredField orderId
|
|
@@ -3854,10 +4083,11 @@ export declare function getDraftOrder(draftOrderId: string): Promise<NonNullable
|
|
|
3854
4083
|
*/
|
|
3855
4084
|
export declare function getOrderDraftabilityStatus(orderId: string): Promise<NonNullablePaths<GetOrderDraftabilityStatusResponse, `orderId` | `orderDraftable` | `nonDraftableReasons`>>;
|
|
3856
4085
|
/**
|
|
3857
|
-
* Commit latest changes to the baseline order and control
|
|
4086
|
+
* Commit latest changes to the baseline order and control which side-effects are executed.
|
|
4087
|
+
*
|
|
3858
4088
|
* Commit cannot be undone or reverted.
|
|
3859
|
-
*
|
|
3860
|
-
* @param draftOrderId -
|
|
4089
|
+
* Committed draft will become closed for further modifications, however it's kept for reference and can be retrieved.
|
|
4090
|
+
* @param draftOrderId - Draft order ID.
|
|
3861
4091
|
* @public
|
|
3862
4092
|
* @documentationMaturity preview
|
|
3863
4093
|
* @requiredField draftOrderId
|
|
@@ -3874,9 +4104,9 @@ export declare function getOrderDraftabilityStatus(orderId: string): Promise<Non
|
|
|
3874
4104
|
*/
|
|
3875
4105
|
export declare function commitDraftOrder(draftOrderId: string, options?: CommitDraftOrderOptions): Promise<NonNullablePaths<CommitDraftOrderResponse, {
|
|
3876
4106
|
[P in DraftOrderNonNullablePaths]: `committedDraftOrder.${P}`;
|
|
3877
|
-
}[DraftOrderNonNullablePaths] | `orderAfterCommit.number` | `orderAfterCommit.lineItems` | `orderAfterCommit.lineItems.${number}._id` | `orderAfterCommit.lineItems.${number}.productName.original` | `orderAfterCommit.lineItems.${number}.catalogReference.catalogItemId` | `orderAfterCommit.lineItems.${number}.catalogReference.appId` | `orderAfterCommit.lineItems.${number}.quantity` | `orderAfterCommit.lineItems.${number}.totalDiscount.amount` | `orderAfterCommit.lineItems.${number}.totalDiscount.formattedAmount` | `orderAfterCommit.lineItems.${number}.physicalProperties.shippable` | `orderAfterCommit.lineItems.${number}.itemType.preset` | `orderAfterCommit.lineItems.${number}.itemType.custom` | `orderAfterCommit.lineItems.${number}.paymentOption` | `orderAfterCommit.lineItems.${number}.taxDetails.taxRate` | `orderAfterCommit.lineItems.${number}.taxInfo.taxIncludedInPrice` | `orderAfterCommit.lineItems.${number}.digitalFile.fileId` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.cycleNumber` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `orderAfterCommit.lineItems.${number}.priceDescription.original` | `orderAfterCommit.buyerInfo.visitorId` | `orderAfterCommit.buyerInfo.memberId` | `orderAfterCommit.paymentStatus` | `orderAfterCommit.fulfillmentStatus` | `orderAfterCommit.weightUnit` | `orderAfterCommit.taxIncludedInPrices` | `orderAfterCommit.billingInfo.address.streetAddress.number` | `orderAfterCommit.billingInfo.address.streetAddress.name` | `orderAfterCommit.billingInfo.contactDetails.vatId._id` | `orderAfterCommit.billingInfo.contactDetails.vatId.type` | `orderAfterCommit.shippingInfo.title` | `orderAfterCommit.shippingInfo.logistics.pickupDetails.pickupMethod` | `orderAfterCommit.status` | `orderAfterCommit.taxInfo.taxBreakdown` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.taxName` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.taxType` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.jurisdiction` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.jurisdictionType` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.rate` | `orderAfterCommit.appliedDiscounts` | `orderAfterCommit.appliedDiscounts.${number}.coupon._id` | `orderAfterCommit.appliedDiscounts.${number}.coupon.code` | `orderAfterCommit.appliedDiscounts.${number}.coupon.name` | `orderAfterCommit.appliedDiscounts.${number}.merchantDiscount.discountReason` | `orderAfterCommit.appliedDiscounts.${number}.discountRule._id` | `orderAfterCommit.appliedDiscounts.${number}.discountRule.name.original` | `orderAfterCommit.appliedDiscounts.${number}.discountType` | `orderAfterCommit.activities` | `orderAfterCommit.activities.${number}.customActivity.appId` | `orderAfterCommit.activities.${number}.customActivity.type` | `orderAfterCommit.activities.${number}.merchantComment.message` | `orderAfterCommit.activities.${number}.orderRefunded.manual` | `orderAfterCommit.activities.${number}.orderRefunded.reason` | `orderAfterCommit.activities.${number}.type` | `orderAfterCommit.attributionSource` | `orderAfterCommit.createdBy.userId` | `orderAfterCommit.createdBy.memberId` | `orderAfterCommit.createdBy.visitorId` | `orderAfterCommit.createdBy.appId` | `orderAfterCommit.channelInfo.type` | `orderAfterCommit.customFields` | `orderAfterCommit.customFields.${number}.title` | `orderAfterCommit.balanceSummary.balance.amount` | `orderAfterCommit.balanceSummary.balance.formattedAmount` | `orderAfterCommit.additionalFees` | `orderAfterCommit.additionalFees.${number}.name` | `orderAfterCommit.additionalFees.${number}._id` | `orderAfterCommit.tags.privateTags.tagIds` | `orderAfterCommit.businessLocation._id` | `orderAfterCommit.businessLocation.name`>>;
|
|
4107
|
+
}[DraftOrderNonNullablePaths] | `orderAfterCommit.number` | `orderAfterCommit.lineItems` | `orderAfterCommit.lineItems.${number}._id` | `orderAfterCommit.lineItems.${number}.productName.original` | `orderAfterCommit.lineItems.${number}.catalogReference.catalogItemId` | `orderAfterCommit.lineItems.${number}.catalogReference.appId` | `orderAfterCommit.lineItems.${number}.quantity` | `orderAfterCommit.lineItems.${number}.totalDiscount.amount` | `orderAfterCommit.lineItems.${number}.totalDiscount.formattedAmount` | `orderAfterCommit.lineItems.${number}.physicalProperties.shippable` | `orderAfterCommit.lineItems.${number}.itemType.preset` | `orderAfterCommit.lineItems.${number}.itemType.custom` | `orderAfterCommit.lineItems.${number}.paymentOption` | `orderAfterCommit.lineItems.${number}.taxDetails.taxRate` | `orderAfterCommit.lineItems.${number}.taxInfo.taxIncludedInPrice` | `orderAfterCommit.lineItems.${number}.digitalFile.fileId` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.cycleNumber` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `orderAfterCommit.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `orderAfterCommit.lineItems.${number}.priceDescription.original` | `orderAfterCommit.lineItems.${number}.taxableAddress.addressType` | `orderAfterCommit.buyerInfo.visitorId` | `orderAfterCommit.buyerInfo.memberId` | `orderAfterCommit.paymentStatus` | `orderAfterCommit.fulfillmentStatus` | `orderAfterCommit.weightUnit` | `orderAfterCommit.taxIncludedInPrices` | `orderAfterCommit.billingInfo.address.streetAddress.number` | `orderAfterCommit.billingInfo.address.streetAddress.name` | `orderAfterCommit.billingInfo.contactDetails.vatId._id` | `orderAfterCommit.billingInfo.contactDetails.vatId.type` | `orderAfterCommit.shippingInfo.title` | `orderAfterCommit.shippingInfo.logistics.pickupDetails.pickupMethod` | `orderAfterCommit.status` | `orderAfterCommit.taxInfo.taxBreakdown` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.taxName` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.taxType` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.jurisdiction` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.jurisdictionType` | `orderAfterCommit.taxInfo.taxBreakdown.${number}.rate` | `orderAfterCommit.appliedDiscounts` | `orderAfterCommit.appliedDiscounts.${number}.coupon._id` | `orderAfterCommit.appliedDiscounts.${number}.coupon.code` | `orderAfterCommit.appliedDiscounts.${number}.coupon.name` | `orderAfterCommit.appliedDiscounts.${number}.merchantDiscount.discountReason` | `orderAfterCommit.appliedDiscounts.${number}.discountRule._id` | `orderAfterCommit.appliedDiscounts.${number}.discountRule.name.original` | `orderAfterCommit.appliedDiscounts.${number}.discountType` | `orderAfterCommit.activities` | `orderAfterCommit.activities.${number}.customActivity.appId` | `orderAfterCommit.activities.${number}.customActivity.type` | `orderAfterCommit.activities.${number}.merchantComment.message` | `orderAfterCommit.activities.${number}.orderRefunded.manual` | `orderAfterCommit.activities.${number}.orderRefunded.reason` | `orderAfterCommit.activities.${number}.type` | `orderAfterCommit.attributionSource` | `orderAfterCommit.createdBy.userId` | `orderAfterCommit.createdBy.memberId` | `orderAfterCommit.createdBy.visitorId` | `orderAfterCommit.createdBy.appId` | `orderAfterCommit.channelInfo.type` | `orderAfterCommit.customFields` | `orderAfterCommit.customFields.${number}.title` | `orderAfterCommit.balanceSummary.balance.amount` | `orderAfterCommit.balanceSummary.balance.formattedAmount` | `orderAfterCommit.additionalFees` | `orderAfterCommit.additionalFees.${number}.name` | `orderAfterCommit.additionalFees.${number}._id` | `orderAfterCommit.tags.privateTags.tagIds` | `orderAfterCommit.businessLocation._id` | `orderAfterCommit.businessLocation.name`>>;
|
|
3878
4108
|
export interface CommitDraftOrderOptions {
|
|
3879
|
-
/** Optional side effects to trigger */
|
|
4109
|
+
/** Optional side effects to trigger. */
|
|
3880
4110
|
commitSettings?: DraftOrderCommitSettings;
|
|
3881
4111
|
/**
|
|
3882
4112
|
* Reason for edit, given by user (optional).
|
|
@@ -3885,11 +4115,14 @@ export interface CommitDraftOrderOptions {
|
|
|
3885
4115
|
reason?: string | null;
|
|
3886
4116
|
}
|
|
3887
4117
|
/**
|
|
3888
|
-
*
|
|
4118
|
+
* Creates a new order while specifying which side-effects are executed.
|
|
4119
|
+
*
|
|
3889
4120
|
* Commit cannot be undone or reverted.
|
|
3890
|
-
*
|
|
4121
|
+
* Committed draft will become closed for further modifications, however it's kept for reference and can be retrieved.
|
|
4122
|
+
* @param draftOrderId - Draft order ID.
|
|
3891
4123
|
* @public
|
|
3892
4124
|
* @documentationMaturity preview
|
|
4125
|
+
* @requiredField draftOrderId
|
|
3893
4126
|
* @permissionId ECOM.DRAFT_ORDER_CREATE_ORDER_FROM_DRAFT
|
|
3894
4127
|
* @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
|
|
3895
4128
|
* @permissionScope Manage Stores - all permissions
|
|
@@ -3901,11 +4134,25 @@ export interface CommitDraftOrderOptions {
|
|
|
3901
4134
|
* @applicableIdentity APP
|
|
3902
4135
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateOrderFromDraft
|
|
3903
4136
|
*/
|
|
3904
|
-
export declare function createOrderFromDraft(): Promise<
|
|
4137
|
+
export declare function createOrderFromDraft(draftOrderId: string, options?: CreateOrderFromDraftOptions): Promise<NonNullablePaths<CreateOrderFromDraftResponse, {
|
|
4138
|
+
[P in DraftOrderNonNullablePaths]: `committedDraftOrder.${P}`;
|
|
4139
|
+
}[DraftOrderNonNullablePaths] | `createdOrder.number` | `createdOrder.lineItems` | `createdOrder.lineItems.${number}._id` | `createdOrder.lineItems.${number}.productName.original` | `createdOrder.lineItems.${number}.catalogReference.catalogItemId` | `createdOrder.lineItems.${number}.catalogReference.appId` | `createdOrder.lineItems.${number}.quantity` | `createdOrder.lineItems.${number}.totalDiscount.amount` | `createdOrder.lineItems.${number}.totalDiscount.formattedAmount` | `createdOrder.lineItems.${number}.physicalProperties.shippable` | `createdOrder.lineItems.${number}.itemType.preset` | `createdOrder.lineItems.${number}.itemType.custom` | `createdOrder.lineItems.${number}.paymentOption` | `createdOrder.lineItems.${number}.taxDetails.taxRate` | `createdOrder.lineItems.${number}.taxInfo.taxIncludedInPrice` | `createdOrder.lineItems.${number}.digitalFile.fileId` | `createdOrder.lineItems.${number}.subscriptionInfo.cycleNumber` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `createdOrder.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `createdOrder.lineItems.${number}.priceDescription.original` | `createdOrder.lineItems.${number}.taxableAddress.addressType` | `createdOrder.buyerInfo.visitorId` | `createdOrder.buyerInfo.memberId` | `createdOrder.paymentStatus` | `createdOrder.fulfillmentStatus` | `createdOrder.weightUnit` | `createdOrder.taxIncludedInPrices` | `createdOrder.billingInfo.address.streetAddress.number` | `createdOrder.billingInfo.address.streetAddress.name` | `createdOrder.billingInfo.contactDetails.vatId._id` | `createdOrder.billingInfo.contactDetails.vatId.type` | `createdOrder.shippingInfo.title` | `createdOrder.shippingInfo.logistics.pickupDetails.pickupMethod` | `createdOrder.status` | `createdOrder.taxInfo.taxBreakdown` | `createdOrder.taxInfo.taxBreakdown.${number}.taxName` | `createdOrder.taxInfo.taxBreakdown.${number}.taxType` | `createdOrder.taxInfo.taxBreakdown.${number}.jurisdiction` | `createdOrder.taxInfo.taxBreakdown.${number}.jurisdictionType` | `createdOrder.taxInfo.taxBreakdown.${number}.rate` | `createdOrder.appliedDiscounts` | `createdOrder.appliedDiscounts.${number}.coupon._id` | `createdOrder.appliedDiscounts.${number}.coupon.code` | `createdOrder.appliedDiscounts.${number}.coupon.name` | `createdOrder.appliedDiscounts.${number}.merchantDiscount.discountReason` | `createdOrder.appliedDiscounts.${number}.discountRule._id` | `createdOrder.appliedDiscounts.${number}.discountRule.name.original` | `createdOrder.appliedDiscounts.${number}.discountType` | `createdOrder.activities` | `createdOrder.activities.${number}.customActivity.appId` | `createdOrder.activities.${number}.customActivity.type` | `createdOrder.activities.${number}.merchantComment.message` | `createdOrder.activities.${number}.orderRefunded.manual` | `createdOrder.activities.${number}.orderRefunded.reason` | `createdOrder.activities.${number}.type` | `createdOrder.attributionSource` | `createdOrder.createdBy.userId` | `createdOrder.createdBy.memberId` | `createdOrder.createdBy.visitorId` | `createdOrder.createdBy.appId` | `createdOrder.channelInfo.type` | `createdOrder.customFields` | `createdOrder.customFields.${number}.title` | `createdOrder.balanceSummary.balance.amount` | `createdOrder.balanceSummary.balance.formattedAmount` | `createdOrder.additionalFees` | `createdOrder.additionalFees.${number}.name` | `createdOrder.additionalFees.${number}._id` | `createdOrder.tags.privateTags.tagIds` | `createdOrder.businessLocation._id` | `createdOrder.businessLocation.name`>>;
|
|
4140
|
+
export interface CreateOrderFromDraftOptions {
|
|
4141
|
+
/** Optional side effects to trigger. */
|
|
4142
|
+
createSettings?: OrderCreateSettings;
|
|
4143
|
+
/**
|
|
4144
|
+
* Reason for order creation, given by user (optional).
|
|
4145
|
+
* @maxLength 200
|
|
4146
|
+
*/
|
|
4147
|
+
reason?: string | null;
|
|
4148
|
+
/** Information about the sales channel that submitted this order. */
|
|
4149
|
+
channelInfo?: ChannelInfo;
|
|
4150
|
+
}
|
|
3905
4151
|
/**
|
|
3906
|
-
*
|
|
3907
|
-
*
|
|
3908
|
-
*
|
|
4152
|
+
* Deletes a draft order along with all its pending changes.
|
|
4153
|
+
*
|
|
4154
|
+
* Draft orders in status 'COMMITTED' cannot be deleted.
|
|
4155
|
+
* @param draftOrderId - Draft order ID.
|
|
3909
4156
|
* @public
|
|
3910
4157
|
* @documentationMaturity preview
|
|
3911
4158
|
* @requiredField draftOrderId
|
|
@@ -4023,9 +4270,49 @@ export interface DraftOrdersQueryBuilder {
|
|
|
4023
4270
|
find: () => Promise<DraftOrdersQueryResult>;
|
|
4024
4271
|
}
|
|
4025
4272
|
/**
|
|
4026
|
-
*
|
|
4273
|
+
* Updates extended fields on a draft order.
|
|
4274
|
+
* @param _id - ID of the entity to update.
|
|
4275
|
+
* @param namespace - Identifier for the app whose extended fields are being updated.
|
|
4276
|
+
* @public
|
|
4277
|
+
* @documentationMaturity preview
|
|
4278
|
+
* @requiredField _id
|
|
4279
|
+
* @requiredField namespace
|
|
4280
|
+
* @requiredField options
|
|
4281
|
+
* @requiredField options.namespaceData
|
|
4282
|
+
* @permissionId ECOM.DRAFT_ORDER_UPDATE_EXTENDED_FIELDS
|
|
4283
|
+
* @permissionId ECOM.DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
|
|
4284
|
+
* @permissionScope Manage Stores - all permissions
|
|
4285
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4286
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4287
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4288
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4289
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4290
|
+
* @permissionScope Manage Stores - all permissions
|
|
4291
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4292
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4293
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4294
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
4295
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
4296
|
+
* @permissionScope Manage Orders
|
|
4297
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
4298
|
+
* @applicableIdentity APP
|
|
4299
|
+
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateExtendedFields
|
|
4300
|
+
*/
|
|
4301
|
+
export declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
|
|
4302
|
+
[P in DraftOrderNonNullablePaths]: `draftOrder.${P}`;
|
|
4303
|
+
}[DraftOrderNonNullablePaths]>>;
|
|
4304
|
+
export interface UpdateExtendedFieldsOptions {
|
|
4305
|
+
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
4306
|
+
namespaceData: Record<string, any> | null;
|
|
4307
|
+
}
|
|
4308
|
+
/**
|
|
4309
|
+
* Sets tax exemption on a draft order.
|
|
4310
|
+
* @param draftOrderId - Draft order ID.
|
|
4027
4311
|
* @public
|
|
4028
4312
|
* @documentationMaturity preview
|
|
4313
|
+
* @requiredField draftOrderId
|
|
4314
|
+
* @requiredField options
|
|
4315
|
+
* @requiredField options.taxExempt
|
|
4029
4316
|
* @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION
|
|
4030
4317
|
* @permissionScope Manage Stores - all permissions
|
|
4031
4318
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
@@ -4036,11 +4323,24 @@ export interface DraftOrdersQueryBuilder {
|
|
|
4036
4323
|
* @applicableIdentity APP
|
|
4037
4324
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetTaxExemption
|
|
4038
4325
|
*/
|
|
4039
|
-
export declare function setTaxExemption(): Promise<
|
|
4326
|
+
export declare function setTaxExemption(draftOrderId: string, options: NonNullablePaths<SetTaxExemptionOptions, `taxExempt`>): Promise<NonNullablePaths<SetTaxExemptionResponse, {
|
|
4327
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4328
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4329
|
+
export interface SetTaxExemptionOptions {
|
|
4330
|
+
/**
|
|
4331
|
+
* Flag, indicating whether the draft order is exempt from tax calculations.
|
|
4332
|
+
*
|
|
4333
|
+
* Default: `false`
|
|
4334
|
+
*/
|
|
4335
|
+
taxExempt: boolean | null;
|
|
4336
|
+
}
|
|
4040
4337
|
/**
|
|
4041
|
-
* Sets business location
|
|
4338
|
+
* Sets business location on a draft order.
|
|
4339
|
+
* @param draftOrderId - Draft order ID.
|
|
4042
4340
|
* @public
|
|
4043
4341
|
* @documentationMaturity preview
|
|
4342
|
+
* @requiredField draftOrderId
|
|
4343
|
+
* @requiredField options.businessLocation._id
|
|
4044
4344
|
* @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
|
|
4045
4345
|
* @permissionScope Manage Stores - all permissions
|
|
4046
4346
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
@@ -4051,5 +4351,11 @@ export declare function setTaxExemption(): Promise<void>;
|
|
|
4051
4351
|
* @applicableIdentity APP
|
|
4052
4352
|
* @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBusinessLocation
|
|
4053
4353
|
*/
|
|
4054
|
-
export declare function setBusinessLocation(): Promise<
|
|
4354
|
+
export declare function setBusinessLocation(draftOrderId: string, options?: NonNullablePaths<SetBusinessLocationOptions, `businessLocation._id`>): Promise<NonNullablePaths<SetBusinessLocationResponse, {
|
|
4355
|
+
[P in DraftOrderNonNullablePaths]: `calculatedDraftOrder.draftOrder.${P}`;
|
|
4356
|
+
}[DraftOrderNonNullablePaths] | `calculatedDraftOrder.shippingOptions` | `calculatedDraftOrder.shippingOptions.${number}.code` | `calculatedDraftOrder.shippingOptions.${number}.title` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.number` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.address.streetAddress.name` | `calculatedDraftOrder.shippingOptions.${number}.logistics.pickupDetails.pickupMethod` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.amount` | `calculatedDraftOrder.shippingOptions.${number}.cost.price.formattedAmount` | `calculatedDraftOrder.shippingOptions.${number}.cost.currency` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.code` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.applicationError.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `calculatedDraftOrder.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors` | `calculatedDraftOrder.calculationErrors.carrierErrors.errors.${number}.carrierId` | `calculatedDraftOrder.calculationErrors.orderValidationErrors`>>;
|
|
4357
|
+
export interface SetBusinessLocationOptions {
|
|
4358
|
+
/** Business location. */
|
|
4359
|
+
businessLocation?: Location;
|
|
4360
|
+
}
|
|
4055
4361
|
export {};
|