@wix/auto_sdk_ecom_draft-orders 1.0.21 → 1.0.22

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