@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
|
@@ -26,14 +26,14 @@ export interface DraftOrder {
|
|
|
26
26
|
/**
|
|
27
27
|
* Buyer information.
|
|
28
28
|
* @deprecated Buyer information.
|
|
29
|
-
* @replacedBy
|
|
29
|
+
* @replacedBy buyer_details
|
|
30
30
|
* @targetRemovalDate 2024-08-30
|
|
31
31
|
*/
|
|
32
32
|
buyerInfo?: BuyerInfo;
|
|
33
33
|
/**
|
|
34
34
|
* Billing address and contact details.
|
|
35
35
|
* @deprecated Billing address and contact details.
|
|
36
|
-
* @replacedBy
|
|
36
|
+
* @replacedBy billing_details
|
|
37
37
|
* @targetRemovalDate 2024-08-30
|
|
38
38
|
*/
|
|
39
39
|
billingInfo?: AddressWithContact;
|
|
@@ -110,12 +110,31 @@ export interface DraftOrder {
|
|
|
110
110
|
* @format GUID
|
|
111
111
|
*/
|
|
112
112
|
purchaseFlowId?: string | null;
|
|
113
|
+
/**
|
|
114
|
+
* Order recipient address and contact details.
|
|
115
|
+
*
|
|
116
|
+
* This field may differ from the address in `shippingInfo.logistics` when:
|
|
117
|
+
* + The chosen shipping option is pickup point or store pickup.
|
|
118
|
+
* + No shipping option is selected.
|
|
119
|
+
*/
|
|
113
120
|
recipientInfo?: RecipientInfoDetails;
|
|
121
|
+
/** Tax information. */
|
|
122
|
+
taxInfo?: OrderTaxInfo;
|
|
114
123
|
/**
|
|
115
124
|
* Custom field data for the draft order object.
|
|
116
125
|
* [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.
|
|
117
126
|
*/
|
|
118
127
|
extendedFields?: ExtendedFields;
|
|
128
|
+
/**
|
|
129
|
+
* Buyer information.
|
|
130
|
+
* Includes details about changes when relevant.
|
|
131
|
+
*/
|
|
132
|
+
buyerDetails?: BuyerDetails;
|
|
133
|
+
/**
|
|
134
|
+
* Billing address and contact details.
|
|
135
|
+
* Includes details about changes when relevant.
|
|
136
|
+
*/
|
|
137
|
+
billingDetails?: BillingDetails;
|
|
119
138
|
/**
|
|
120
139
|
* Order business location
|
|
121
140
|
* Includes details about changes when relevant.
|
|
@@ -279,6 +298,8 @@ export interface OrderLineItem {
|
|
|
279
298
|
* @maxSize 5
|
|
280
299
|
*/
|
|
281
300
|
locations?: LocationAndQuantity[];
|
|
301
|
+
/** Address used for tax calculation. */
|
|
302
|
+
taxableAddress?: TaxableAddress;
|
|
282
303
|
/**
|
|
283
304
|
* Custom extended fields for the line item object.
|
|
284
305
|
*
|
|
@@ -1086,6 +1107,7 @@ export interface AdditionalFeeDetails {
|
|
|
1086
1107
|
*
|
|
1087
1108
|
* Supported values:
|
|
1088
1109
|
* + `ORIGINAL_ORDER`: This additional fee is part of the original order.
|
|
1110
|
+
* + `AUTOMATIC`: User added a catalog item which is configured to have an additional fee.
|
|
1089
1111
|
* + `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.
|
|
1090
1112
|
*/
|
|
1091
1113
|
source?: SourceType;
|
|
@@ -1141,11 +1163,11 @@ export interface TaxDetails {
|
|
|
1141
1163
|
taxGroupId?: string | null;
|
|
1142
1164
|
}
|
|
1143
1165
|
export declare enum SourceType {
|
|
1144
|
-
/** Part of the original order */
|
|
1166
|
+
/** Part of the original order. */
|
|
1145
1167
|
ORIGINAL_ORDER = "ORIGINAL_ORDER",
|
|
1146
|
-
/** Added by
|
|
1168
|
+
/** Added automatically, as the result of recalculation caused by changes in draft order. */
|
|
1147
1169
|
AUTOMATIC = "AUTOMATIC",
|
|
1148
|
-
/** Added manually to
|
|
1170
|
+
/** Added manually to draft order. */
|
|
1149
1171
|
CUSTOM = "CUSTOM"
|
|
1150
1172
|
}
|
|
1151
1173
|
export interface DiscountDetails {
|
|
@@ -1311,9 +1333,9 @@ export interface CreatedByStringOneOf {
|
|
|
1311
1333
|
appId?: string;
|
|
1312
1334
|
}
|
|
1313
1335
|
export declare enum EditingStatus {
|
|
1314
|
-
/**
|
|
1336
|
+
/** Draft order can be modified and committed. */
|
|
1315
1337
|
DRAFT = "DRAFT",
|
|
1316
|
-
/**
|
|
1338
|
+
/** Draft order is already committed. No further modifications allowed. */
|
|
1317
1339
|
COMMITTED = "COMMITTED"
|
|
1318
1340
|
}
|
|
1319
1341
|
export declare enum WeightUnit {
|
|
@@ -1351,6 +1373,18 @@ export interface BalanceSummary {
|
|
|
1351
1373
|
* @readonly
|
|
1352
1374
|
*/
|
|
1353
1375
|
balance?: Balance;
|
|
1376
|
+
/**
|
|
1377
|
+
* Sum of all approved and successful payments.
|
|
1378
|
+
*
|
|
1379
|
+
* The value includes payments that have subsequently been fully or partially refunded.
|
|
1380
|
+
* @readonly
|
|
1381
|
+
*/
|
|
1382
|
+
paid?: Price;
|
|
1383
|
+
/**
|
|
1384
|
+
* Sum of all successfully refunded payments.
|
|
1385
|
+
* @readonly
|
|
1386
|
+
*/
|
|
1387
|
+
refunded?: Price;
|
|
1354
1388
|
/**
|
|
1355
1389
|
* Sum of all authorized payments.
|
|
1356
1390
|
* @readonly
|
|
@@ -1490,18 +1524,50 @@ export interface OrderTaxBreakdown {
|
|
|
1490
1524
|
aggregatedTaxAmount?: Price;
|
|
1491
1525
|
}
|
|
1492
1526
|
export interface BuyerDetails extends BuyerDetailsChangeTypeOneOf {
|
|
1527
|
+
/** Indicates that buyer information was added during draft. */
|
|
1528
|
+
added?: boolean;
|
|
1529
|
+
/** Indicates that buyer information was changed. Contains billing information before draft. */
|
|
1530
|
+
changedDetails?: BuyerChangedDetails;
|
|
1531
|
+
/** Indicates that buyer information was removed during draft. */
|
|
1532
|
+
removed?: boolean;
|
|
1533
|
+
/** Buyer information. */
|
|
1534
|
+
buyerInfo?: BuyerInfo;
|
|
1493
1535
|
}
|
|
1494
1536
|
/** @oneof */
|
|
1495
1537
|
export interface BuyerDetailsChangeTypeOneOf {
|
|
1538
|
+
/** Indicates that buyer information was added during draft. */
|
|
1539
|
+
added?: boolean;
|
|
1540
|
+
/** Indicates that buyer information was changed. Contains billing information before draft. */
|
|
1541
|
+
changedDetails?: BuyerChangedDetails;
|
|
1542
|
+
/** Indicates that buyer information was removed during draft. */
|
|
1543
|
+
removed?: boolean;
|
|
1496
1544
|
}
|
|
1497
1545
|
export interface BuyerChangedDetails {
|
|
1546
|
+
/** Buyer information before draft. */
|
|
1547
|
+
buyerInfoBeforeChange?: BuyerInfo;
|
|
1498
1548
|
}
|
|
1499
1549
|
export interface BillingDetails extends BillingDetailsChangeTypeOneOf {
|
|
1550
|
+
/** Indicates that billing information was added during draft. */
|
|
1551
|
+
added?: boolean;
|
|
1552
|
+
/** Indicates that billing information was changed. Contains billing information before draft. */
|
|
1553
|
+
changedDetails?: BillingChangedDetails;
|
|
1554
|
+
/** Indicates that billing information was removed during draft. */
|
|
1555
|
+
removed?: boolean;
|
|
1556
|
+
/** Billing address and contact details. */
|
|
1557
|
+
billingInfo?: AddressWithContact;
|
|
1500
1558
|
}
|
|
1501
1559
|
/** @oneof */
|
|
1502
1560
|
export interface BillingDetailsChangeTypeOneOf {
|
|
1561
|
+
/** Indicates that billing information was added during draft. */
|
|
1562
|
+
added?: boolean;
|
|
1563
|
+
/** Indicates that billing information was changed. Contains billing information before draft. */
|
|
1564
|
+
changedDetails?: BillingChangedDetails;
|
|
1565
|
+
/** Indicates that billing information was removed during draft. */
|
|
1566
|
+
removed?: boolean;
|
|
1503
1567
|
}
|
|
1504
1568
|
export interface BillingChangedDetails {
|
|
1569
|
+
/** Billing address and contact details before draft. */
|
|
1570
|
+
billingInfoBeforeChange?: AddressWithContact;
|
|
1505
1571
|
}
|
|
1506
1572
|
export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
|
|
1507
1573
|
/** Indicates that business location was added during draft. */
|
|
@@ -1543,22 +1609,24 @@ export interface BusinessLocationChangedDetails {
|
|
|
1543
1609
|
}
|
|
1544
1610
|
export interface CreateDraftOrderRequest {
|
|
1545
1611
|
/**
|
|
1546
|
-
*
|
|
1612
|
+
* Existing order ID to create draft from.
|
|
1547
1613
|
* @format GUID
|
|
1548
1614
|
*/
|
|
1549
1615
|
orderId: string | null;
|
|
1550
1616
|
}
|
|
1551
1617
|
export interface CreateDraftOrderResponse {
|
|
1552
|
-
/**
|
|
1618
|
+
/** Draft order details calculated with latest content. */
|
|
1553
1619
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1554
|
-
}
|
|
1555
|
-
export interface CalculatedDraftOrder {
|
|
1556
1620
|
/**
|
|
1557
|
-
*
|
|
1558
|
-
*
|
|
1621
|
+
* Flag indicating whether response contains draft order that existed before request.
|
|
1622
|
+
* `False` - new draft order was created.
|
|
1559
1623
|
*/
|
|
1624
|
+
preexistingDraftOrder?: boolean | null;
|
|
1625
|
+
}
|
|
1626
|
+
export interface CalculatedDraftOrder {
|
|
1627
|
+
/** Draft order full details with calculations based on it's content. */
|
|
1560
1628
|
draftOrder?: DraftOrder;
|
|
1561
|
-
/**
|
|
1629
|
+
/** Order shipping options. */
|
|
1562
1630
|
shippingOptions?: ShippingOption[];
|
|
1563
1631
|
/** Errors that occurred during calculation. */
|
|
1564
1632
|
calculationErrors?: CalculationErrors;
|
|
@@ -1591,18 +1659,14 @@ export interface DeliveryLogistics {
|
|
|
1591
1659
|
export interface PickupDetails {
|
|
1592
1660
|
/** Pickup address */
|
|
1593
1661
|
address?: Address;
|
|
1594
|
-
/**
|
|
1595
|
-
* Pickup method.
|
|
1596
|
-
*
|
|
1597
|
-
* Supported values:
|
|
1598
|
-
* + `"STORE_PICKUP"`
|
|
1599
|
-
* + `"PICKUP_POINT"`
|
|
1600
|
-
*/
|
|
1662
|
+
/** Pickup method. */
|
|
1601
1663
|
pickupMethod?: PickupMethod;
|
|
1602
1664
|
}
|
|
1603
1665
|
export declare enum PickupMethod {
|
|
1604
1666
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1667
|
+
/** Pickup is from the merchant's brick and mortar store. */
|
|
1605
1668
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1669
|
+
/** Item is shipped to a specified pickup point. */
|
|
1606
1670
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1607
1671
|
}
|
|
1608
1672
|
export interface DeliveryTimeSlot {
|
|
@@ -1744,12 +1808,12 @@ export interface CarrierError {
|
|
|
1744
1808
|
export interface CreateEmptyDraftOrderRequest {
|
|
1745
1809
|
}
|
|
1746
1810
|
export interface CreateEmptyDraftOrderResponse {
|
|
1747
|
-
/**
|
|
1811
|
+
/** Draft order details calculated with latest content. */
|
|
1748
1812
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1749
1813
|
}
|
|
1750
1814
|
export interface AddLineItemsToDraftOrderRequest {
|
|
1751
1815
|
/**
|
|
1752
|
-
*
|
|
1816
|
+
* Draft order ID.
|
|
1753
1817
|
* @format GUID
|
|
1754
1818
|
*/
|
|
1755
1819
|
draftOrderId: string;
|
|
@@ -1765,7 +1829,10 @@ export interface AddLineItemsToDraftOrderRequest {
|
|
|
1765
1829
|
customLineItems?: CustomLineItem[];
|
|
1766
1830
|
}
|
|
1767
1831
|
export interface CatalogReferenceLineItem {
|
|
1768
|
-
/**
|
|
1832
|
+
/**
|
|
1833
|
+
* Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.
|
|
1834
|
+
* Optional for custom line items, which don't trigger the Catalog service plugin.
|
|
1835
|
+
*/
|
|
1769
1836
|
catalogReference?: CatalogReference;
|
|
1770
1837
|
/**
|
|
1771
1838
|
* Item quantity.
|
|
@@ -1775,6 +1842,12 @@ export interface CatalogReferenceLineItem {
|
|
|
1775
1842
|
quantity?: number;
|
|
1776
1843
|
/** Item price override. */
|
|
1777
1844
|
price?: Price;
|
|
1845
|
+
/**
|
|
1846
|
+
* Whether the price is not yet defined, and will be updated after the order is created.
|
|
1847
|
+
*
|
|
1848
|
+
* Default: `false`
|
|
1849
|
+
*/
|
|
1850
|
+
priceUndetermined?: boolean;
|
|
1778
1851
|
/**
|
|
1779
1852
|
* Line item locations.
|
|
1780
1853
|
*
|
|
@@ -1798,7 +1871,10 @@ export interface CustomLineItem {
|
|
|
1798
1871
|
* @max 100000
|
|
1799
1872
|
*/
|
|
1800
1873
|
quantity?: number;
|
|
1801
|
-
/**
|
|
1874
|
+
/**
|
|
1875
|
+
* Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.
|
|
1876
|
+
* Optional for custom line items, which don't trigger the Catalog service plugin.
|
|
1877
|
+
*/
|
|
1802
1878
|
catalogReference?: CatalogReference;
|
|
1803
1879
|
/**
|
|
1804
1880
|
* Item name.
|
|
@@ -1871,35 +1947,35 @@ export declare enum FileType {
|
|
|
1871
1947
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
1872
1948
|
}
|
|
1873
1949
|
export interface AddLineItemsToDraftOrderResponse {
|
|
1874
|
-
/**
|
|
1950
|
+
/** Draft order details calculated with latest content. */
|
|
1875
1951
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1876
1952
|
}
|
|
1877
1953
|
export interface UpdateLineItemsRequest {
|
|
1878
1954
|
/**
|
|
1879
|
-
*
|
|
1955
|
+
* Draft order ID.
|
|
1880
1956
|
* @format GUID
|
|
1881
1957
|
*/
|
|
1882
1958
|
draftOrderId: string;
|
|
1883
1959
|
/**
|
|
1884
|
-
* Details of changes to apply per line item
|
|
1960
|
+
* Details of changes to apply per line item.
|
|
1885
1961
|
* @minSize 1
|
|
1886
1962
|
* @maxSize 300
|
|
1887
1963
|
*/
|
|
1888
|
-
lineItemChanges
|
|
1964
|
+
lineItemChanges: LineItemChangeDetails[];
|
|
1889
1965
|
}
|
|
1890
1966
|
export interface LineItemChangeDetails {
|
|
1891
1967
|
/**
|
|
1892
|
-
*
|
|
1968
|
+
* Line item ID.
|
|
1893
1969
|
* @format GUID
|
|
1894
1970
|
*/
|
|
1895
1971
|
lineItemId?: string;
|
|
1896
1972
|
/**
|
|
1897
|
-
* The new quantity for the line item.
|
|
1973
|
+
* The new quantity for the line item. Quantity zero removes the line item.
|
|
1898
1974
|
* @max 1000000
|
|
1899
1975
|
*/
|
|
1900
1976
|
newQuantity?: number | null;
|
|
1901
1977
|
/**
|
|
1902
|
-
* The new price for 1 unit of the line item
|
|
1978
|
+
* The new price for 1 unit of the line item.
|
|
1903
1979
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
1904
1980
|
*/
|
|
1905
1981
|
newPrice?: string | null;
|
|
@@ -1907,51 +1983,59 @@ export interface LineItemChangeDetails {
|
|
|
1907
1983
|
newPriceDescription?: PriceDescription;
|
|
1908
1984
|
}
|
|
1909
1985
|
export interface UpdateLineItemsResponse {
|
|
1910
|
-
/**
|
|
1986
|
+
/** Draft order details calculated with latest content. */
|
|
1911
1987
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1912
1988
|
}
|
|
1913
1989
|
export interface SetDiscountsRequest {
|
|
1914
1990
|
/**
|
|
1915
|
-
*
|
|
1991
|
+
* Draft order ID.
|
|
1916
1992
|
* @format GUID
|
|
1917
1993
|
*/
|
|
1918
1994
|
draftOrderId: string;
|
|
1919
1995
|
/**
|
|
1920
|
-
*
|
|
1996
|
+
* Discount IDs to apply/unapply.
|
|
1997
|
+
* Existing discounts, not mentioned in request, will keep their current state.
|
|
1921
1998
|
* @minSize 1
|
|
1999
|
+
* @maxSize 320
|
|
1922
2000
|
*/
|
|
1923
2001
|
discounts: IdAndApplied[];
|
|
1924
2002
|
}
|
|
1925
2003
|
export interface IdAndApplied {
|
|
1926
|
-
/**
|
|
2004
|
+
/**
|
|
2005
|
+
* Entity ID. Depending on context, it's either discount or additional fee ID.
|
|
2006
|
+
* @format GUID
|
|
2007
|
+
*/
|
|
1927
2008
|
id?: string;
|
|
1928
|
-
/**
|
|
2009
|
+
/** Flag indicating whether entity (discount/additional fee) should be applied to a draft order. */
|
|
1929
2010
|
applied?: boolean;
|
|
1930
2011
|
}
|
|
1931
2012
|
export interface SetDiscountsResponse {
|
|
1932
|
-
/**
|
|
2013
|
+
/** Draft order details calculated with latest content. */
|
|
1933
2014
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1934
2015
|
}
|
|
1935
2016
|
export interface CreateCustomDiscountsRequest {
|
|
1936
2017
|
/**
|
|
1937
|
-
*
|
|
2018
|
+
* Draft order ID.
|
|
1938
2019
|
* @format GUID
|
|
1939
2020
|
*/
|
|
1940
2021
|
draftOrderId: string;
|
|
1941
2022
|
/**
|
|
1942
|
-
*
|
|
2023
|
+
* Discounts to create. Created discounts are unapplied by default.
|
|
1943
2024
|
* @minSize 1
|
|
1944
2025
|
* @maxSize 100
|
|
1945
2026
|
*/
|
|
1946
2027
|
discounts?: DiscountOption[];
|
|
1947
2028
|
}
|
|
1948
2029
|
export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
2030
|
+
/** Discount price amount. */
|
|
2031
|
+
priceAmount?: Price;
|
|
1949
2032
|
/**
|
|
1950
|
-
* Discount
|
|
1951
|
-
*
|
|
1952
|
-
*
|
|
1953
|
-
* * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
|
|
2033
|
+
* Discount percentage amount.
|
|
2034
|
+
* @format DECIMAL_VALUE
|
|
2035
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1954
2036
|
*/
|
|
2037
|
+
percentage?: string | null;
|
|
2038
|
+
/** Discount type. */
|
|
1955
2039
|
discountType?: DiscountType;
|
|
1956
2040
|
/**
|
|
1957
2041
|
* ID of line item discount applies to.
|
|
@@ -1975,31 +2059,47 @@ export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
|
|
|
1975
2059
|
description?: string | null;
|
|
1976
2060
|
/**
|
|
1977
2061
|
* Should opt-in the added discount. default = false.
|
|
1978
|
-
* if not set or false, then to opt-in them, please call SetDiscounts with the added discounts
|
|
2062
|
+
* if not set or false, then to opt-in them, please call SetDiscounts with the added discounts IDs.
|
|
1979
2063
|
*/
|
|
1980
2064
|
applyToDraftOrder?: boolean | null;
|
|
2065
|
+
/**
|
|
2066
|
+
* Line items the discount applies to.
|
|
2067
|
+
* @maxSize 1
|
|
2068
|
+
*/
|
|
2069
|
+
lineItemDiscounts?: LineItemDiscount[];
|
|
1981
2070
|
}
|
|
1982
2071
|
/** @oneof */
|
|
1983
2072
|
export interface DiscountOptionDiscountAmountOneOf {
|
|
2073
|
+
/** Discount price amount. */
|
|
2074
|
+
priceAmount?: Price;
|
|
2075
|
+
/**
|
|
2076
|
+
* Discount percentage amount.
|
|
2077
|
+
* @format DECIMAL_VALUE
|
|
2078
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
2079
|
+
*/
|
|
2080
|
+
percentage?: string | null;
|
|
1984
2081
|
}
|
|
1985
2082
|
export declare enum DiscountType {
|
|
1986
2083
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
2084
|
+
/** Discount applies to entire order. */
|
|
1987
2085
|
GLOBAL = "GLOBAL",
|
|
2086
|
+
/** Discount applies to specific items. */
|
|
1988
2087
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
2088
|
+
/** Discount applies to shipping. For example, free shipping. */
|
|
1989
2089
|
SHIPPING = "SHIPPING"
|
|
1990
2090
|
}
|
|
1991
2091
|
export interface CreateCustomDiscountsResponse {
|
|
1992
|
-
/**
|
|
2092
|
+
/** Draft order details calculated with latest content. */
|
|
1993
2093
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
1994
2094
|
}
|
|
1995
2095
|
export interface DeleteCustomDiscountsRequest {
|
|
1996
2096
|
/**
|
|
1997
|
-
*
|
|
2097
|
+
* Draft order ID.
|
|
1998
2098
|
* @format GUID
|
|
1999
2099
|
*/
|
|
2000
2100
|
draftOrderId: string;
|
|
2001
2101
|
/**
|
|
2002
|
-
*
|
|
2102
|
+
* Ids of discounts to remove.
|
|
2003
2103
|
* @format GUID
|
|
2004
2104
|
* @minSize 1
|
|
2005
2105
|
* @maxSize 100
|
|
@@ -2007,34 +2107,35 @@ export interface DeleteCustomDiscountsRequest {
|
|
|
2007
2107
|
discountIds: string[];
|
|
2008
2108
|
}
|
|
2009
2109
|
export interface DeleteCustomDiscountsResponse {
|
|
2010
|
-
/**
|
|
2110
|
+
/** Draft order details calculated with latest content. */
|
|
2011
2111
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2012
2112
|
}
|
|
2013
2113
|
export interface SetAdditionalFeesRequest {
|
|
2014
2114
|
/**
|
|
2015
|
-
*
|
|
2115
|
+
* Draft order ID.
|
|
2016
2116
|
* @format GUID
|
|
2017
2117
|
*/
|
|
2018
2118
|
draftOrderId: string;
|
|
2019
2119
|
/**
|
|
2020
|
-
*
|
|
2120
|
+
* Additional fee IDs to apply/unapply.
|
|
2121
|
+
* Existing additional fees, not mentioned in this list, will keep their current state.
|
|
2021
2122
|
* @minSize 1
|
|
2022
2123
|
* @maxSize 100
|
|
2023
2124
|
*/
|
|
2024
2125
|
additionalFees: IdAndApplied[];
|
|
2025
2126
|
}
|
|
2026
2127
|
export interface SetAdditionalFeesResponse {
|
|
2027
|
-
/**
|
|
2128
|
+
/** Draft order details calculated with latest content. */
|
|
2028
2129
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2029
2130
|
}
|
|
2030
2131
|
export interface CreateCustomAdditionalFeesRequest {
|
|
2031
2132
|
/**
|
|
2032
|
-
*
|
|
2133
|
+
* Draft order ID.
|
|
2033
2134
|
* @format GUID
|
|
2034
2135
|
*/
|
|
2035
2136
|
draftOrderId: string;
|
|
2036
2137
|
/**
|
|
2037
|
-
* The additional fees to
|
|
2138
|
+
* The additional fees to create. Created fees are unapplied by default.
|
|
2038
2139
|
* @minSize 1
|
|
2039
2140
|
* @maxSize 100
|
|
2040
2141
|
*/
|
|
@@ -2053,7 +2154,7 @@ export interface AdditionalFeeOption {
|
|
|
2053
2154
|
taxDetails?: TaxDetails;
|
|
2054
2155
|
/**
|
|
2055
2156
|
* Should apply the additional fee. default = false.
|
|
2056
|
-
* if not set or false, then to apply them, please call ApplyAdditionalFees with the added additional fee
|
|
2157
|
+
* if not set or false, then to apply them, please call ApplyAdditionalFees with the added additional fee IDs.
|
|
2057
2158
|
*/
|
|
2058
2159
|
applyToDraftOrder?: boolean | null;
|
|
2059
2160
|
/**
|
|
@@ -2062,19 +2163,26 @@ export interface AdditionalFeeOption {
|
|
|
2062
2163
|
* @maxLength 100
|
|
2063
2164
|
*/
|
|
2064
2165
|
code?: string | null;
|
|
2166
|
+
/**
|
|
2167
|
+
* Optional - Line items associated with this additional fee.
|
|
2168
|
+
* If no `lineItemIds` are provided, the fee will be associated with the whole order.
|
|
2169
|
+
* @format GUID
|
|
2170
|
+
* @maxSize 300
|
|
2171
|
+
*/
|
|
2172
|
+
lineItemIds?: string[];
|
|
2065
2173
|
}
|
|
2066
2174
|
export interface CreateCustomAdditionalFeesResponse {
|
|
2067
|
-
/**
|
|
2175
|
+
/** Draft order details calculated with latest content. */
|
|
2068
2176
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2069
2177
|
}
|
|
2070
2178
|
export interface DeleteCustomAdditionalFeesRequest {
|
|
2071
2179
|
/**
|
|
2072
|
-
*
|
|
2180
|
+
* Draft order ID.
|
|
2073
2181
|
* @format GUID
|
|
2074
2182
|
*/
|
|
2075
2183
|
draftOrderId: string;
|
|
2076
2184
|
/**
|
|
2077
|
-
*
|
|
2185
|
+
* Ids of additional fees to remove.
|
|
2078
2186
|
* @format GUID
|
|
2079
2187
|
* @minSize 1
|
|
2080
2188
|
* @maxSize 100
|
|
@@ -2082,93 +2190,138 @@ export interface DeleteCustomAdditionalFeesRequest {
|
|
|
2082
2190
|
customAdditionalFees: string[];
|
|
2083
2191
|
}
|
|
2084
2192
|
export interface DeleteCustomAdditionalFeesResponse {
|
|
2085
|
-
/**
|
|
2193
|
+
/** Draft order details calculated with latest content. */
|
|
2086
2194
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2087
2195
|
}
|
|
2088
2196
|
export interface SetShippingInfoRequest {
|
|
2197
|
+
/**
|
|
2198
|
+
* Draft order ID.
|
|
2199
|
+
* @format GUID
|
|
2200
|
+
*/
|
|
2201
|
+
draftOrderId: string;
|
|
2202
|
+
/** Shipping information. Empty value removes shipping information from draft. */
|
|
2203
|
+
shippingInfo?: V1ShippingInformation;
|
|
2089
2204
|
}
|
|
2090
2205
|
export interface SetShippingInfoResponse {
|
|
2206
|
+
/** Draft order details calculated with latest content. */
|
|
2207
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2091
2208
|
}
|
|
2092
2209
|
export interface SetBuyerInfoRequest {
|
|
2210
|
+
/**
|
|
2211
|
+
* Draft order ID.
|
|
2212
|
+
* @format GUID
|
|
2213
|
+
*/
|
|
2214
|
+
draftOrderId: string;
|
|
2215
|
+
/** Buyer information. Empty value removes buyer information from draft. */
|
|
2216
|
+
buyerInfo?: BuyerInfo;
|
|
2093
2217
|
}
|
|
2094
2218
|
export interface SetBuyerInfoResponse {
|
|
2219
|
+
/** Draft order details calculated with latest content. */
|
|
2220
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2095
2221
|
}
|
|
2096
2222
|
export interface SetRecipientInfoRequest {
|
|
2223
|
+
/**
|
|
2224
|
+
* Draft order ID.
|
|
2225
|
+
* @format GUID
|
|
2226
|
+
*/
|
|
2227
|
+
draftOrderId: string;
|
|
2228
|
+
/** Order recipient address and contact details. Empty value removes recipient information from draft. */
|
|
2229
|
+
recipientInfo?: AddressWithContact;
|
|
2097
2230
|
}
|
|
2098
2231
|
export interface SetRecipientInfoResponse {
|
|
2232
|
+
/** Draft order details calculated with latest content. */
|
|
2233
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2099
2234
|
}
|
|
2100
2235
|
export interface SetBillingInfoRequest {
|
|
2236
|
+
/**
|
|
2237
|
+
* Draft order ID.
|
|
2238
|
+
* @format GUID
|
|
2239
|
+
*/
|
|
2240
|
+
draftOrderId: string;
|
|
2241
|
+
/** Billing address and contact details. Empty value removes billing information from draft. */
|
|
2242
|
+
billingInfo?: AddressWithContact;
|
|
2101
2243
|
}
|
|
2102
2244
|
export interface SetBillingInfoResponse {
|
|
2245
|
+
/** Draft order details calculated with latest content. */
|
|
2246
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2103
2247
|
}
|
|
2248
|
+
/** Deprecated */
|
|
2104
2249
|
export interface UpdateShippingInfoRequest {
|
|
2105
2250
|
/**
|
|
2106
|
-
*
|
|
2251
|
+
* Draft order ID.
|
|
2107
2252
|
* @format GUID
|
|
2108
2253
|
*/
|
|
2109
2254
|
draftOrderId?: string;
|
|
2110
|
-
/**
|
|
2255
|
+
/** Update the shipping option on the order. If not set then the selected shipping is removed. */
|
|
2111
2256
|
shippingOption?: ShippingOption;
|
|
2112
2257
|
}
|
|
2258
|
+
/** Deprecated */
|
|
2113
2259
|
export interface UpdateShippingInfoResponse {
|
|
2114
|
-
/**
|
|
2260
|
+
/** Draft order details calculated with latest content. */
|
|
2115
2261
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2116
2262
|
}
|
|
2117
2263
|
export interface GetDraftOrderRequest {
|
|
2118
2264
|
/**
|
|
2119
|
-
*
|
|
2265
|
+
* Draft order ID.
|
|
2120
2266
|
* @format GUID
|
|
2121
2267
|
*/
|
|
2122
2268
|
draftOrderId: string;
|
|
2123
2269
|
}
|
|
2124
2270
|
export interface GetDraftOrderResponse {
|
|
2125
|
-
/**
|
|
2271
|
+
/** Draft order details calculated with latest content. */
|
|
2126
2272
|
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
2127
2273
|
}
|
|
2128
2274
|
export interface GetOrderDraftabilityStatusRequest {
|
|
2129
2275
|
/**
|
|
2130
|
-
* Order
|
|
2131
|
-
* @
|
|
2132
|
-
* @maxLength 100
|
|
2276
|
+
* Order Id.
|
|
2277
|
+
* @format GUID
|
|
2133
2278
|
*/
|
|
2134
2279
|
orderId: string;
|
|
2135
2280
|
}
|
|
2136
2281
|
export interface GetOrderDraftabilityStatusResponse {
|
|
2137
2282
|
/**
|
|
2138
|
-
* Order
|
|
2139
|
-
* @
|
|
2140
|
-
* @maxLength 100
|
|
2283
|
+
* Order Id.
|
|
2284
|
+
* @format GUID
|
|
2141
2285
|
*/
|
|
2142
2286
|
orderId?: string;
|
|
2143
|
-
/**
|
|
2287
|
+
/** Flag, indicating whether a draft can be created from this order. */
|
|
2144
2288
|
orderDraftable?: boolean;
|
|
2145
2289
|
/**
|
|
2146
|
-
* Reasons why the order is not draftable
|
|
2290
|
+
* Reasons why the order is not draftable.
|
|
2147
2291
|
* @maxSize 5
|
|
2148
2292
|
*/
|
|
2149
2293
|
nonDraftableReasons?: NonDraftableReason[];
|
|
2150
2294
|
}
|
|
2151
2295
|
export declare enum NonDraftableReason {
|
|
2152
2296
|
UNSPECIFIED = "UNSPECIFIED",
|
|
2297
|
+
/** Modifications of refunded orders are not supported. */
|
|
2153
2298
|
PARTIALLY_OR_FULLY_REFUNDED = "PARTIALLY_OR_FULLY_REFUNDED",
|
|
2299
|
+
/**
|
|
2300
|
+
* Original order must be created via one of the following channel types:
|
|
2301
|
+
* + WEB
|
|
2302
|
+
* + POS
|
|
2303
|
+
* + BACKOFFICE_MERCHANT
|
|
2304
|
+
* + WIX_APP_STORE
|
|
2305
|
+
*/
|
|
2154
2306
|
UNSUPPORTED_CHANNEL_TYPE = "UNSUPPORTED_CHANNEL_TYPE",
|
|
2307
|
+
/** Order status is not APPROVED. */
|
|
2155
2308
|
ORDER_STATUS_IS_NOT_SUPPORTED = "ORDER_STATUS_IS_NOT_SUPPORTED",
|
|
2309
|
+
/** Site and order currencies are different. */
|
|
2156
2310
|
ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT = "ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT",
|
|
2311
|
+
/** Site and order weight units are different. */
|
|
2157
2312
|
ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT = "ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT",
|
|
2158
|
-
|
|
2159
|
-
/** remove - this is not a reason, it's an error */
|
|
2313
|
+
/** Order not found. */
|
|
2160
2314
|
ORDER_NOT_FOUND = "ORDER_NOT_FOUND",
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
TAXABLE_EXISTING_ADDITIONAL_FEE = "TAXABLE_EXISTING_ADDITIONAL_FEE"
|
|
2315
|
+
/** Modifications of orders with subscription items are not supported. */
|
|
2316
|
+
SUBSCRIPTION_LINE_ITEM_EXISTS = "SUBSCRIPTION_LINE_ITEM_EXISTS"
|
|
2164
2317
|
}
|
|
2165
2318
|
export interface CommitDraftOrderRequest {
|
|
2166
2319
|
/**
|
|
2167
|
-
*
|
|
2320
|
+
* Draft order ID.
|
|
2168
2321
|
* @format GUID
|
|
2169
2322
|
*/
|
|
2170
2323
|
draftOrderId: string;
|
|
2171
|
-
/** Optional side effects to trigger */
|
|
2324
|
+
/** Optional side effects to trigger. */
|
|
2172
2325
|
commitSettings?: DraftOrderCommitSettings;
|
|
2173
2326
|
/**
|
|
2174
2327
|
* Reason for edit, given by user (optional).
|
|
@@ -2177,9 +2330,9 @@ export interface CommitDraftOrderRequest {
|
|
|
2177
2330
|
reason?: string | null;
|
|
2178
2331
|
}
|
|
2179
2332
|
export interface CommitDraftOrderResponse {
|
|
2180
|
-
/**
|
|
2333
|
+
/** Draft order after commit. */
|
|
2181
2334
|
committedDraftOrder?: DraftOrder;
|
|
2182
|
-
/**
|
|
2335
|
+
/** Updated order after commit. */
|
|
2183
2336
|
orderAfterCommit?: Order;
|
|
2184
2337
|
}
|
|
2185
2338
|
export interface Order {
|
|
@@ -3234,16 +3387,48 @@ export interface TagList {
|
|
|
3234
3387
|
tagIds?: string[];
|
|
3235
3388
|
}
|
|
3236
3389
|
export interface CreateOrderFromDraftRequest {
|
|
3390
|
+
/**
|
|
3391
|
+
* Draft order ID.
|
|
3392
|
+
* @format GUID
|
|
3393
|
+
*/
|
|
3394
|
+
draftOrderId: string;
|
|
3395
|
+
/** Optional side effects to trigger. */
|
|
3396
|
+
createSettings?: OrderCreateSettings;
|
|
3397
|
+
/**
|
|
3398
|
+
* Reason for order creation, given by user (optional).
|
|
3399
|
+
* @maxLength 200
|
|
3400
|
+
*/
|
|
3401
|
+
reason?: string | null;
|
|
3402
|
+
/** Information about the sales channel that submitted this order. */
|
|
3403
|
+
channelInfo?: ChannelInfo;
|
|
3237
3404
|
}
|
|
3238
3405
|
export interface OrderCreateSettings {
|
|
3406
|
+
/** Notification settings to be applied on order creation */
|
|
3407
|
+
notifications?: OrderCreateNotifications;
|
|
3239
3408
|
}
|
|
3240
3409
|
export interface OrderCreateNotifications {
|
|
3410
|
+
/**
|
|
3411
|
+
* Whether to send notification to the buyer.
|
|
3412
|
+
*
|
|
3413
|
+
* Default: `true`
|
|
3414
|
+
*/
|
|
3415
|
+
sendNotificationToBuyer?: boolean | null;
|
|
3416
|
+
/**
|
|
3417
|
+
* Whether to send notifications to the business.
|
|
3418
|
+
*
|
|
3419
|
+
* Default: `true`
|
|
3420
|
+
*/
|
|
3421
|
+
sendNotificationsToBusiness?: boolean | null;
|
|
3241
3422
|
}
|
|
3242
3423
|
export interface CreateOrderFromDraftResponse {
|
|
3424
|
+
/** The draft order after commit. */
|
|
3425
|
+
committedDraftOrder?: DraftOrder;
|
|
3426
|
+
/** Created order. */
|
|
3427
|
+
createdOrder?: Order;
|
|
3243
3428
|
}
|
|
3244
3429
|
export interface DeleteDraftOrderRequest {
|
|
3245
3430
|
/**
|
|
3246
|
-
*
|
|
3431
|
+
* Draft order ID.
|
|
3247
3432
|
* @format GUID
|
|
3248
3433
|
*/
|
|
3249
3434
|
draftOrderId: string;
|
|
@@ -3251,7 +3436,7 @@ export interface DeleteDraftOrderRequest {
|
|
|
3251
3436
|
export interface DeleteDraftOrderResponse {
|
|
3252
3437
|
}
|
|
3253
3438
|
export interface QueryDraftOrdersRequest {
|
|
3254
|
-
/**
|
|
3439
|
+
/** Query options. */
|
|
3255
3440
|
query?: CursorQuery;
|
|
3256
3441
|
}
|
|
3257
3442
|
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
@@ -3313,7 +3498,7 @@ export interface CursorPaging {
|
|
|
3313
3498
|
cursor?: string | null;
|
|
3314
3499
|
}
|
|
3315
3500
|
export interface QueryDraftOrdersResponse {
|
|
3316
|
-
/**
|
|
3501
|
+
/** Draft orders, found by query. */
|
|
3317
3502
|
draftOrders?: DraftOrder[];
|
|
3318
3503
|
/** Paging metadata. */
|
|
3319
3504
|
pagingMetadata?: CursorPagingMetadata;
|
|
@@ -3345,42 +3530,45 @@ export interface Cursors {
|
|
|
3345
3530
|
}
|
|
3346
3531
|
export interface UpdateExtendedFieldsRequest {
|
|
3347
3532
|
/** ID of the entity to update. */
|
|
3348
|
-
id
|
|
3533
|
+
id: string;
|
|
3349
3534
|
/** Identifier for the app whose extended fields are being updated. */
|
|
3350
|
-
namespace
|
|
3535
|
+
namespace: string;
|
|
3351
3536
|
/** 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. */
|
|
3352
|
-
namespaceData
|
|
3537
|
+
namespaceData: Record<string, any> | null;
|
|
3353
3538
|
}
|
|
3354
3539
|
export interface UpdateExtendedFieldsResponse {
|
|
3355
|
-
/** Updated
|
|
3540
|
+
/** Updated draft order. */
|
|
3356
3541
|
draftOrder?: DraftOrder;
|
|
3357
3542
|
}
|
|
3358
3543
|
export interface SetTaxExemptionRequest {
|
|
3359
|
-
}
|
|
3360
|
-
export interface SetTaxExemptionResponse {
|
|
3361
|
-
}
|
|
3362
|
-
export interface GetDraftEditabilityStatusRequest {
|
|
3363
3544
|
/**
|
|
3364
3545
|
* Draft order ID.
|
|
3365
3546
|
* @format GUID
|
|
3366
3547
|
*/
|
|
3367
|
-
draftOrderId
|
|
3548
|
+
draftOrderId: string;
|
|
3549
|
+
/**
|
|
3550
|
+
* Flag, indicating whether the draft order is exempt from tax calculations.
|
|
3551
|
+
*
|
|
3552
|
+
* Default: `false`
|
|
3553
|
+
*/
|
|
3554
|
+
taxExempt: boolean | null;
|
|
3368
3555
|
}
|
|
3369
|
-
export interface
|
|
3556
|
+
export interface SetTaxExemptionResponse {
|
|
3557
|
+
/** Draft order details calculated with latest content. */
|
|
3558
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
3559
|
+
}
|
|
3560
|
+
export interface SetBusinessLocationRequest {
|
|
3370
3561
|
/**
|
|
3371
3562
|
* Draft order ID.
|
|
3372
3563
|
* @format GUID
|
|
3373
3564
|
*/
|
|
3374
|
-
draftOrderId
|
|
3375
|
-
/**
|
|
3376
|
-
|
|
3377
|
-
* @readonly
|
|
3378
|
-
*/
|
|
3379
|
-
status?: EditingStatus;
|
|
3380
|
-
}
|
|
3381
|
-
export interface SetBusinessLocationRequest {
|
|
3565
|
+
draftOrderId: string;
|
|
3566
|
+
/** Business location. */
|
|
3567
|
+
businessLocation?: Location;
|
|
3382
3568
|
}
|
|
3383
3569
|
export interface SetBusinessLocationResponse {
|
|
3570
|
+
/** Draft order details calculated with latest content. */
|
|
3571
|
+
calculatedDraftOrder?: CalculatedDraftOrder;
|
|
3384
3572
|
}
|
|
3385
3573
|
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
3386
3574
|
createdEvent?: EntityCreatedEvent;
|