@wix/auto_sdk_ecom_draft-orders 1.0.34 → 1.0.35

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 (134) hide show
  1. package/build/{es/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-CAxetX1U.d.mts} +571 -368
  2. package/build/{cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-CAxetX1U.d.ts} +571 -368
  3. package/build/index.d.mts +291 -0
  4. package/build/index.d.ts +291 -0
  5. package/build/index.js +5403 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +5326 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-CIHFdzik.d.mts} +746 -368
  10. package/build/internal/{es/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-CIHFdzik.d.ts} +746 -368
  11. package/build/internal/index.d.mts +291 -0
  12. package/build/internal/index.d.ts +291 -0
  13. package/build/internal/index.js +5403 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +5326 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +3140 -0
  18. package/build/internal/meta.d.ts +3140 -0
  19. package/build/internal/meta.js +3455 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +3406 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +3140 -0
  24. package/build/meta.d.ts +3140 -0
  25. package/build/meta.js +3455 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +3406 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -43
  40. package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js +0 -75
  41. package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
  42. package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -131
  43. package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js +0 -3097
  44. package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
  45. package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -63
  46. package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +0 -465
  47. package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
  48. package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -255
  49. package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js +0 -385
  50. package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
  51. package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js +0 -378
  52. package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
  53. package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4726
  54. package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +0 -2453
  55. package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -43
  67. package/build/es/src/ecom-v1-draft-order-draft-orders.context.js +0 -43
  68. package/build/es/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
  69. package/build/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -131
  70. package/build/es/src/ecom-v1-draft-order-draft-orders.http.js +0 -3071
  71. package/build/es/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
  72. package/build/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -63
  73. package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js +0 -416
  74. package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
  75. package/build/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -255
  76. package/build/es/src/ecom-v1-draft-order-draft-orders.public.js +0 -330
  77. package/build/es/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
  78. package/build/es/src/ecom-v1-draft-order-draft-orders.types.js +0 -375
  79. package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
  80. package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4726
  81. package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +0 -2403
  82. package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -43
  93. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js +0 -75
  94. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
  95. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -131
  96. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js +0 -3097
  97. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
  98. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -63
  99. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +0 -465
  100. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
  101. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -255
  102. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js +0 -385
  103. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
  104. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js +0 -378
  105. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
  106. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4901
  107. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +0 -2453
  108. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -43
  119. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js +0 -43
  120. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
  121. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -131
  122. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js +0 -3071
  123. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
  124. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -63
  125. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js +0 -416
  126. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
  127. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -255
  128. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js +0 -330
  129. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
  130. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js +0 -375
  131. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
  132. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4901
  133. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +0 -2403
  134. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
@@ -0,0 +1,3140 @@
1
+ import { bE as CreateDraftOrderRequest$1, C as CreateDraftOrderResponse$1, bV as CreateEmptyDraftOrderRequest$1, a as CreateEmptyDraftOrderResponse$1, bW as AddLineItemsToDraftOrderRequest$1, b as AddLineItemsToDraftOrderResponse$1, b_ as UpdateLineItemsRequest$1, U as UpdateLineItemsResponse$1, b$ as SetDiscountsRequest$1, S as SetDiscountsResponse$1, c0 as CreateCustomDiscountsRequest$1, d as CreateCustomDiscountsResponse$1, c3 as DeleteCustomDiscountsRequest$1, D as DeleteCustomDiscountsResponse$1, c4 as SetAdditionalFeesRequest$1, e as SetAdditionalFeesResponse$1, c5 as CreateCustomAdditionalFeesRequest$1, g as CreateCustomAdditionalFeesResponse$1, c7 as DeleteCustomAdditionalFeesRequest$1, h as DeleteCustomAdditionalFeesResponse$1, c8 as SetShippingInfoRequest$1, j as SetShippingInfoResponse$1, c9 as SetBuyerInfoRequest$1, l as SetBuyerInfoResponse$1, ca as SetRecipientInfoRequest$1, n as SetRecipientInfoResponse$1, cb as SetBillingInfoRequest$1, p as SetBillingInfoResponse$1, ce as GetDraftOrderRequest$1, G as GetDraftOrderResponse$1, cf as GetOrderDraftabilityStatusRequest$1, q as GetOrderDraftabilityStatusResponse$1, cg as CommitDraftOrderRequest$1, s as CommitDraftOrderResponse$1, dd as CreateOrderFromDraftRequest$1, u as CreateOrderFromDraftResponse$1, dg as DeleteDraftOrderRequest$1, dh as DeleteDraftOrderResponse$1, di as QueryDraftOrdersRequest$1, dn as QueryDraftOrdersResponse$1, dr as UpdateExtendedFieldsRequest$1, x as UpdateExtendedFieldsResponse$1, ds as SetTaxExemptionRequest$1, z as SetTaxExemptionResponse$1, dt as SetBusinessLocationRequest$1, E as SetBusinessLocationResponse$1 } from './ecom-v1-draft-order-draft-orders.universal-CIHFdzik.js';
2
+
3
+ /**
4
+ * Draft Order main entity.
5
+ * A temporary version of an order, allowing modifications before finalization.
6
+ */
7
+ interface DraftOrder {
8
+ /**
9
+ * Draft order ID.
10
+ * @format GUID
11
+ * @readonly
12
+ */
13
+ id?: string | null;
14
+ /**
15
+ * ID of the order this draft commits to.
16
+ * @format GUID
17
+ */
18
+ orderId?: string | null;
19
+ /**
20
+ * Line items.
21
+ * Includes details about changes when relevant.
22
+ * @minSize 1
23
+ * @maxSize 300
24
+ */
25
+ lineItems?: ItemDetails[];
26
+ /**
27
+ * Shipping info.
28
+ * Includes details about changes when relevant.
29
+ */
30
+ shippingInfo?: ShippingDetails;
31
+ /**
32
+ * Buyer information.
33
+ * @deprecated Buyer information.
34
+ * @replacedBy buyer_details
35
+ * @targetRemovalDate 2024-08-30
36
+ */
37
+ buyerInfo?: BuyerInfo;
38
+ /**
39
+ * Billing address and contact details.
40
+ * @deprecated Billing address and contact details.
41
+ * @replacedBy billing_details
42
+ * @targetRemovalDate 2024-08-30
43
+ */
44
+ billingInfo?: AddressWithContact;
45
+ /**
46
+ * Additional fees.
47
+ *
48
+ * Includes details about the source, and whether the additional fee is applied to the order.
49
+ * @maxSize 100
50
+ */
51
+ additionalFees?: AdditionalFeeDetails[];
52
+ /**
53
+ * Discounts.
54
+ *
55
+ * Includes details about the source, and whether the discount is applied to the order.
56
+ * @maxSize 320
57
+ */
58
+ discounts?: DiscountDetails[];
59
+ /**
60
+ * Date and time the draft order was created.
61
+ * @readonly
62
+ */
63
+ createdDate?: Date | null;
64
+ /**
65
+ * Date and time the draft order was updated.
66
+ * @readonly
67
+ */
68
+ updatedDate?: Date | null;
69
+ /**
70
+ * Identity of the draft order's initiator.
71
+ * @readonly
72
+ */
73
+ createdBy?: CreatedBy;
74
+ /**
75
+ * Draft order status.
76
+ * @readonly
77
+ */
78
+ status?: EditingStatusWithLiterals;
79
+ /** Weight measurement unit. Defaults to the site's weight unit. */
80
+ weightUnit?: WeightUnitWithLiterals;
81
+ /**
82
+ * Currency used for pricing.
83
+ * @format CURRENCY
84
+ */
85
+ currency?: string | null;
86
+ /**
87
+ * Price summary.
88
+ * @readonly
89
+ */
90
+ priceSummary?: PriceSummary;
91
+ /**
92
+ * Deprecated. Use `taxInfo` instead.
93
+ * This field will be removed on September 30, 2024.
94
+ * Tax summary.
95
+ * @readonly
96
+ * @deprecated Deprecated. Use `taxInfo` instead.
97
+ * This field will be removed on September 30, 2024.
98
+ * Tax summary.
99
+ * @replacedBy tax_info
100
+ * @targetRemovalDate 2024-09-30
101
+ */
102
+ taxSummary?: TaxSummary;
103
+ /**
104
+ * Balance summary.
105
+ * @readonly
106
+ */
107
+ balanceSummary?: BalanceSummary;
108
+ /** Side effects to perform on commit. */
109
+ commitSettings?: DraftOrderCommitSettings;
110
+ /**
111
+ * Member ID (if order created by a member).
112
+ * @format GUID
113
+ */
114
+ memberId?: string | null;
115
+ /**
116
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
117
+ * @format GUID
118
+ */
119
+ purchaseFlowId?: string | null;
120
+ /**
121
+ * Order recipient address and contact details.
122
+ *
123
+ * This field may differ from the address in `shippingInfo.logistics` when:
124
+ * + The chosen shipping option is pickup point or store pickup.
125
+ * + No shipping option is selected.
126
+ */
127
+ recipientInfo?: RecipientInfoDetails;
128
+ /** Tax information. */
129
+ taxInfo?: OrderTaxInfo;
130
+ /**
131
+ * Custom field data for the draft order object.
132
+ *
133
+ * [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.
134
+ */
135
+ extendedFields?: ExtendedFields;
136
+ /**
137
+ * Buyer information.
138
+ *
139
+ * Includes details about changes when relevant.
140
+ */
141
+ buyerDetails?: BuyerDetails;
142
+ /**
143
+ * Billing address and contact details.
144
+ * Includes details about changes when relevant.
145
+ */
146
+ billingDetails?: BillingDetails;
147
+ /**
148
+ * Order business location.
149
+ *
150
+ * Includes details about changes when relevant.
151
+ */
152
+ businessLocationDetails?: BusinessLocationDetails;
153
+ }
154
+ interface ItemDetails extends ItemDetailsChangeTypeOneOf {
155
+ /** Whether the line item was added as part of the draft. */
156
+ added?: boolean;
157
+ /** Line item fields before the change. */
158
+ changedDetails?: ItemChangedDetails;
159
+ /** Whether the line item was removed as part of the draft. */
160
+ removed?: boolean;
161
+ /** Line item details after applied changes. */
162
+ lineItem?: OrderLineItem;
163
+ }
164
+ /** @oneof */
165
+ interface ItemDetailsChangeTypeOneOf {
166
+ /** Whether the line item was added as part of the draft. */
167
+ added?: boolean;
168
+ /** Line item fields before the change. */
169
+ changedDetails?: ItemChangedDetails;
170
+ /** Whether the line item was removed as part of the draft. */
171
+ removed?: boolean;
172
+ }
173
+ interface Price {
174
+ /**
175
+ * Amount.
176
+ * @decimalValue options { gte:0, lte:1000000000000000 }
177
+ */
178
+ amount?: string;
179
+ /**
180
+ * Amount formatted with currency symbol.
181
+ * @readonly
182
+ */
183
+ formattedAmount?: string;
184
+ }
185
+ interface PriceDescription {
186
+ /**
187
+ * __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
188
+ * @minLength 1
189
+ * @maxLength 100
190
+ */
191
+ original?: string;
192
+ /**
193
+ * Price description translated into the buyer's language.
194
+ *
195
+ * Default: Same as `original`.
196
+ * @minLength 1
197
+ * @maxLength 100
198
+ */
199
+ translated?: string | null;
200
+ }
201
+ interface OrderLineItem {
202
+ /**
203
+ * Line item ID.
204
+ * @immutable
205
+ */
206
+ id?: string;
207
+ /**
208
+ * Item name.
209
+ * + Stores - `product.name`
210
+ * + Bookings - `service.info.name`
211
+ * + Events - `ticket.name`
212
+ */
213
+ productName?: ProductName;
214
+ /**
215
+ * References to the line item's origin catalog.
216
+ * This field may be empty in the case of a custom line item.
217
+ */
218
+ catalogReference?: CatalogReference;
219
+ /**
220
+ * Line item quantity.
221
+ * @min 1
222
+ * @max 100000
223
+ */
224
+ quantity?: number;
225
+ /**
226
+ * Total discount for this line item's entire quantity.
227
+ * @readonly
228
+ */
229
+ totalDiscount?: Price;
230
+ /**
231
+ * Line item description lines. Used for display purposes for the cart, checkout and order.
232
+ * @maxSize 20
233
+ */
234
+ descriptionLines?: DescriptionLine[];
235
+ /** Line item image. */
236
+ image?: Image;
237
+ /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
238
+ physicalProperties?: PhysicalProperties;
239
+ /** Item type. Either a preset type or custom. */
240
+ itemType?: ItemType;
241
+ /**
242
+ * Fulfiller ID. Field is empty when the line item is self-fulfilled.
243
+ * 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).
244
+ * @format GUID
245
+ */
246
+ fulfillerId?: string | null;
247
+ /**
248
+ * Number of items that were refunded.
249
+ * @max 100000
250
+ */
251
+ refundQuantity?: number | null;
252
+ /**
253
+ * Number of items restocked.
254
+ * @max 100000
255
+ */
256
+ restockQuantity?: number | null;
257
+ /** Line item price after line item discounts for display purposes. */
258
+ price?: Price;
259
+ /**
260
+ * Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
261
+ * @readonly
262
+ */
263
+ priceBeforeDiscounts?: Price;
264
+ /**
265
+ * Total price after discounts, and before tax.
266
+ * @readonly
267
+ */
268
+ totalPriceBeforeTax?: Price;
269
+ /**
270
+ * Total price after all discounts and tax.
271
+ * @readonly
272
+ */
273
+ totalPriceAfterTax?: Price;
274
+ /**
275
+ * Type of selected payment option for current item.
276
+ *
277
+ * Default: `FULL_PAYMENT_ONLINE`
278
+ */
279
+ paymentOption?: PaymentOptionTypeWithLiterals;
280
+ /**
281
+ * Deprecated. Use `taxInfo` instead.
282
+ * This field will be removed on September 30, 2024.
283
+ * Tax details for this line item.
284
+ * @deprecated Deprecated. Use `taxInfo` instead.
285
+ * This field will be removed on September 30, 2024.
286
+ * Tax details for this line item.
287
+ * @replacedBy tax_info
288
+ * @targetRemovalDate 2024-09-30
289
+ */
290
+ taxDetails?: ItemTaxFullDetails;
291
+ /** Represents all the relevant tax details for a specific line item. */
292
+ taxInfo?: LineItemTaxInfo;
293
+ /** Digital file identifier, relevant only for items with type DIGITAL. */
294
+ digitalFile?: DigitalFile;
295
+ /** Subscription info. */
296
+ subscriptionInfo?: SubscriptionInfo;
297
+ /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
298
+ priceDescription?: PriceDescription;
299
+ /**
300
+ * Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
301
+ * @readonly
302
+ */
303
+ depositAmount?: Price;
304
+ /**
305
+ * Line item locations.
306
+ *
307
+ * The location's total quantity must not exceed the line item quantity.
308
+ * @maxSize 5
309
+ */
310
+ locations?: LocationAndQuantity[];
311
+ /** Address used for tax calculation. */
312
+ taxableAddress?: TaxableAddress;
313
+ /**
314
+ * Custom extended fields for the line item object.
315
+ *
316
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
317
+ */
318
+ extendedFields?: ExtendedFields;
319
+ }
320
+ interface ProductName {
321
+ /**
322
+ * __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
323
+ *
324
+ * Min: 1 character.
325
+ * Max: 200 characters.
326
+ * @minLength 1
327
+ * @maxLength 200
328
+ */
329
+ original?: string;
330
+ /**
331
+ * Item name translated into the buyer's language.
332
+ *
333
+ * Min: 1 character.
334
+ * Max: 400 characters.
335
+ * Default: Same as `original`.
336
+ * @minLength 1
337
+ * @maxLength 400
338
+ */
339
+ translated?: string | null;
340
+ }
341
+ /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
342
+ interface CatalogReference {
343
+ /**
344
+ * ID of the item within the catalog it belongs to.
345
+ * @minLength 1
346
+ * @maxLength 36
347
+ */
348
+ catalogItemId?: string;
349
+ /**
350
+ * ID of the app providing the catalog.
351
+ *
352
+ * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
353
+ *
354
+ * For items from Wix catalogs, the following values always apply:
355
+ * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
356
+ * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
357
+ * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
358
+ * @minLength 1
359
+ */
360
+ appId?: string;
361
+ /**
362
+ * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
363
+ *
364
+ * For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
365
+ */
366
+ options?: Record<string, any> | null;
367
+ }
368
+ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
369
+ /** Description line plain text value. */
370
+ plainText?: PlainTextValue;
371
+ /** Description line color value. */
372
+ colorInfo?: Color;
373
+ /** Description line name. */
374
+ name?: DescriptionLineName;
375
+ }
376
+ /** @oneof */
377
+ interface DescriptionLineValueOneOf {
378
+ /** Description line plain text value. */
379
+ plainText?: PlainTextValue;
380
+ /** Description line color value. */
381
+ colorInfo?: Color;
382
+ }
383
+ /** @oneof */
384
+ interface DescriptionLineDescriptionLineValueOneOf {
385
+ }
386
+ interface DescriptionLineName {
387
+ /**
388
+ * Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
389
+ * @maxLength 100
390
+ */
391
+ original?: string;
392
+ /**
393
+ * Description line name translated into the buyer's language.
394
+ *
395
+ * Default: Same as `original`.
396
+ * @maxLength 200
397
+ */
398
+ translated?: string | null;
399
+ }
400
+ interface PlainTextValue {
401
+ /**
402
+ * Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
403
+ * @maxLength 600
404
+ */
405
+ original?: string;
406
+ /**
407
+ * Description line plain text value translated into the buyer's language.
408
+ *
409
+ * Default: Same as `original`.
410
+ * @maxLength 600
411
+ */
412
+ translated?: string | null;
413
+ }
414
+ interface Color {
415
+ /**
416
+ * Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
417
+ * @maxLength 500
418
+ */
419
+ original?: string;
420
+ /**
421
+ * Description line color name translated into the buyer's language.
422
+ *
423
+ * Default: Same as `original`.
424
+ * @maxLength 500
425
+ */
426
+ translated?: string | null;
427
+ /** HEX or RGB color code for display. */
428
+ code?: string | null;
429
+ }
430
+ interface Image {
431
+ /** WixMedia image ID. */
432
+ id?: string;
433
+ /** Image URL. */
434
+ url?: string;
435
+ /**
436
+ * Original image height.
437
+ * @readonly
438
+ */
439
+ height?: number;
440
+ /**
441
+ * Original image width.
442
+ * @readonly
443
+ */
444
+ width?: number;
445
+ /** Image alt text. */
446
+ altText?: string | null;
447
+ /**
448
+ * Image filename.
449
+ * @readonly
450
+ */
451
+ filename?: string | null;
452
+ }
453
+ interface PhysicalProperties {
454
+ /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
455
+ weight?: number | null;
456
+ /**
457
+ * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
458
+ * @maxLength 40
459
+ */
460
+ sku?: string | null;
461
+ /** Whether this line item is shippable. */
462
+ shippable?: boolean;
463
+ }
464
+ interface ItemType extends ItemTypeItemTypeDataOneOf {
465
+ /** Preset item type. */
466
+ preset?: ItemTypeItemTypeWithLiterals;
467
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
468
+ custom?: string;
469
+ }
470
+ /** @oneof */
471
+ interface ItemTypeItemTypeDataOneOf {
472
+ /** Preset item type. */
473
+ preset?: ItemTypeItemTypeWithLiterals;
474
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
475
+ custom?: string;
476
+ }
477
+ declare enum ItemTypeItemType {
478
+ UNRECOGNISED = "UNRECOGNISED",
479
+ PHYSICAL = "PHYSICAL",
480
+ DIGITAL = "DIGITAL",
481
+ GIFT_CARD = "GIFT_CARD",
482
+ SERVICE = "SERVICE"
483
+ }
484
+ /** @enumType */
485
+ type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
486
+ /** Type of selected payment option for catalog item */
487
+ declare enum PaymentOptionType {
488
+ /** The entire payment for this item happens as part of the checkout. */
489
+ FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
490
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
491
+ FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
492
+ /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
493
+ MEMBERSHIP = "MEMBERSHIP",
494
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
495
+ DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
496
+ /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
497
+ MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
498
+ }
499
+ /** @enumType */
500
+ type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
501
+ interface ItemTaxFullDetails {
502
+ /** Taxable amount of this line item. */
503
+ taxableAmount?: Price;
504
+ /**
505
+ * Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
506
+ * @decimalValue options { gte:0, maxScale:6 }
507
+ */
508
+ taxRate?: string;
509
+ /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
510
+ totalTax?: Price;
511
+ }
512
+ interface LineItemTaxInfo {
513
+ /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
514
+ taxAmount?: Price;
515
+ /** Amount for which tax is calculated. */
516
+ taxableAmount?: Price;
517
+ /**
518
+ * Tax rate %, as a decimal point.
519
+ * @format DECIMAL_VALUE
520
+ * @decimalValue options { gte:0, maxScale:6 }
521
+ */
522
+ taxRate?: string | null;
523
+ /**
524
+ * Tax group ID.
525
+ * @format GUID
526
+ */
527
+ taxGroupId?: string | null;
528
+ /** Indicates whether the price already includes tax. */
529
+ taxIncludedInPrice?: boolean;
530
+ /**
531
+ * Tax information for a line item.
532
+ * @maxSize 7
533
+ */
534
+ taxBreakdown?: LineItemTaxBreakdown[];
535
+ }
536
+ /**
537
+ * TaxBreakdown represents tax information for a line item.
538
+ * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
539
+ */
540
+ interface LineItemTaxBreakdown {
541
+ /**
542
+ * Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
543
+ * @maxLength 200
544
+ */
545
+ jurisdiction?: string | null;
546
+ /**
547
+ * Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
548
+ * @format DECIMAL_VALUE
549
+ * @decimalValue options { gte:0, maxScale:6 }
550
+ */
551
+ rate?: string | null;
552
+ /** Amount of tax calculated for this line item. */
553
+ taxAmount?: Price;
554
+ /**
555
+ * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
556
+ * @maxLength 200
557
+ */
558
+ taxType?: string | null;
559
+ /**
560
+ * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
561
+ * This name should be explicit enough to allow the merchant to understand what tax was calculated.
562
+ * @maxLength 200
563
+ */
564
+ taxName?: string | null;
565
+ /** Type of jurisdiction that taxes were calculated for. */
566
+ jurisdictionType?: JurisdictionTypeWithLiterals;
567
+ /** Non-taxable amount of the line item price. */
568
+ nonTaxableAmount?: Price;
569
+ /** Taxable amount of the line item price. */
570
+ taxableAmount?: Price;
571
+ }
572
+ /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
573
+ declare enum JurisdictionType {
574
+ UNDEFINED = "UNDEFINED",
575
+ COUNTRY = "COUNTRY",
576
+ STATE = "STATE",
577
+ COUNTY = "COUNTY",
578
+ CITY = "CITY",
579
+ SPECIAL = "SPECIAL"
580
+ }
581
+ /** @enumType */
582
+ type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
583
+ interface DigitalFile {
584
+ /**
585
+ * ID of the secure file in media.
586
+ * @minLength 1
587
+ * @maxLength 100
588
+ */
589
+ fileId?: string;
590
+ /**
591
+ * Link will exist after the digital links have been generated on the order.
592
+ * @format WEB_URL
593
+ * @minLength 1
594
+ * @maxLength 2000
595
+ */
596
+ link?: string | null;
597
+ /**
598
+ * Link expiration time and date.
599
+ * @readonly
600
+ */
601
+ expirationDate?: Date | null;
602
+ }
603
+ interface SubscriptionInfo {
604
+ /**
605
+ * Subscription ID.
606
+ * @format GUID
607
+ */
608
+ id?: string | null;
609
+ /**
610
+ * Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
611
+ * @min 1
612
+ */
613
+ cycleNumber?: number;
614
+ /**
615
+ * Subscription option title. For example, `"Monthly coffee Subscription"`.
616
+ * @maxLength 20
617
+ * @deprecated Subscription option title. For example, `"Monthly coffee Subscription"`.
618
+ * @replacedBy title
619
+ * @targetRemovalDate 2025-10-01
620
+ */
621
+ subscriptionOptionTitle?: string;
622
+ /**
623
+ * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
624
+ * @maxLength 60
625
+ * @deprecated Subscription option description. For example, `"1kg of selected coffee, once a month"`.
626
+ * @replacedBy description
627
+ * @targetRemovalDate 2025-10-01
628
+ */
629
+ subscriptionOptionDescription?: string | null;
630
+ /**
631
+ * Subscription detailed information.
632
+ * @immutable
633
+ */
634
+ subscriptionSettings?: SubscriptionSettings;
635
+ /**
636
+ * Description of the charges that will be applied for subscription.
637
+ * @maxLength 1000
638
+ */
639
+ chargesDescription?: string | null;
640
+ }
641
+ interface SubscriptionSettings {
642
+ /** Frequency of recurring payment. */
643
+ frequency?: SubscriptionFrequencyWithLiterals;
644
+ /**
645
+ * Interval of recurring payment.
646
+ * @min 1
647
+ * @max 50
648
+ */
649
+ interval?: number | null;
650
+ /** Whether subscription is renewed automatically at the end of each period. */
651
+ autoRenewal?: boolean;
652
+ /**
653
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
654
+ * @min 1
655
+ */
656
+ billingCycles?: number | null;
657
+ /** Whether to allow the customer to cancel the subscription. */
658
+ enableCustomerCancellation?: boolean;
659
+ /** Period until first cycle starts. If None => no free trial */
660
+ freeTrialPeriod?: FreeTrialPeriod;
661
+ }
662
+ /** Frequency unit of recurring payment */
663
+ declare enum SubscriptionFrequency {
664
+ UNDEFINED = "UNDEFINED",
665
+ DAY = "DAY",
666
+ WEEK = "WEEK",
667
+ MONTH = "MONTH",
668
+ YEAR = "YEAR"
669
+ }
670
+ /** @enumType */
671
+ type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
672
+ interface FreeTrialPeriod {
673
+ /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
674
+ frequency?: SubscriptionFrequencyWithLiterals;
675
+ /**
676
+ * interval of period
677
+ * @min 1
678
+ * @max 999
679
+ */
680
+ interval?: number;
681
+ }
682
+ interface LocationAndQuantity {
683
+ /**
684
+ * Location id in the associated owner app.
685
+ * @format GUID
686
+ */
687
+ id?: string;
688
+ /**
689
+ * Location owner app, if not provided then the site business info locations will be used.
690
+ * @format GUID
691
+ * @deprecated Location owner app, if not provided then the site business info locations will be used.
692
+ * @targetRemovalDate 2025-03-01
693
+ */
694
+ appId?: string | null;
695
+ /**
696
+ * Quantity for specific location.
697
+ * @min 1
698
+ * @max 100000
699
+ */
700
+ quantity?: number;
701
+ /**
702
+ * Location name.
703
+ * @maxLength 500
704
+ * @readonly
705
+ */
706
+ name?: string | null;
707
+ }
708
+ interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
709
+ /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
710
+ addressType?: TaxableAddressTypeWithLiterals;
711
+ }
712
+ /** @oneof */
713
+ interface TaxableAddressTaxableAddressDataOneOf {
714
+ /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
715
+ addressType?: TaxableAddressTypeWithLiterals;
716
+ }
717
+ declare enum TaxableAddressType {
718
+ UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
719
+ BUSINESS = "BUSINESS",
720
+ BILLING = "BILLING",
721
+ SHIPPING = "SHIPPING"
722
+ }
723
+ /** @enumType */
724
+ type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
725
+ interface ExtendedFields {
726
+ /**
727
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
728
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
729
+ *
730
+ * You can only access fields for which you have the appropriate permissions.
731
+ *
732
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
733
+ */
734
+ namespaces?: Record<string, Record<string, any>>;
735
+ }
736
+ interface ItemChangedDetails {
737
+ /**
738
+ * Line item quantity before change.
739
+ * @min 1
740
+ * @max 1000000
741
+ */
742
+ quantityBeforeChange?: number | null;
743
+ /** Line item price before change. */
744
+ priceBeforeChange?: Price;
745
+ /** Line item price description before change. */
746
+ priceDescriptionBeforeChange?: PriceDescription;
747
+ }
748
+ interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
749
+ /** Whether shipping info was added as part of the draft. */
750
+ added?: boolean;
751
+ /** Shipping info before the change. */
752
+ changedDetails?: ShippingChangedDetails;
753
+ /** Whether shipping info was removed as part of the draft. */
754
+ removed?: boolean;
755
+ /** Selected Shipping details. */
756
+ shippingInfo?: V1ShippingInformation;
757
+ }
758
+ /** @oneof */
759
+ interface ShippingDetailsChangeTypeOneOf {
760
+ /** Whether shipping info was added as part of the draft. */
761
+ added?: boolean;
762
+ /** Shipping info before the change. */
763
+ changedDetails?: ShippingChangedDetails;
764
+ /** Whether shipping info was removed as part of the draft. */
765
+ removed?: boolean;
766
+ }
767
+ interface V1ShippingInformation {
768
+ /**
769
+ * App Def Id of external provider which was a source of shipping info
770
+ * @minLength 1
771
+ * @maxLength 100
772
+ */
773
+ carrierId?: string | null;
774
+ /**
775
+ * Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`.
776
+ * @minLength 1
777
+ * @maxLength 100
778
+ */
779
+ code?: string | null;
780
+ /**
781
+ * Shipping option title.
782
+ * For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
783
+ * @maxLength 250
784
+ */
785
+ title?: string;
786
+ /** Shipping logistics. */
787
+ logistics?: V1DeliveryLogistics;
788
+ /** Shipping costs. */
789
+ cost?: V1ShippingPrice;
790
+ /** Shipping region. */
791
+ region?: ShippingRegion;
792
+ }
793
+ interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
794
+ /** Shipping address and contact details. */
795
+ shippingDestination?: AddressWithContact;
796
+ /** Pickup details. */
797
+ pickupDetails?: V1PickupDetails;
798
+ /**
799
+ * Expected delivery time in free text. For example, `"3-5 business days"`.
800
+ * @maxLength 500
801
+ */
802
+ deliveryTime?: string | null;
803
+ /**
804
+ * Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
805
+ * @maxLength 1000
806
+ */
807
+ instructions?: string | null;
808
+ /**
809
+ * Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
810
+ * @deprecated
811
+ */
812
+ deliverByDate?: Date | null;
813
+ /** Expected delivery time. */
814
+ deliveryTimeSlot?: V1DeliveryTimeSlot;
815
+ }
816
+ /** @oneof */
817
+ interface V1DeliveryLogisticsAddressOneOf {
818
+ /** Shipping address and contact details. */
819
+ shippingDestination?: AddressWithContact;
820
+ /** Pickup details. */
821
+ pickupDetails?: V1PickupDetails;
822
+ }
823
+ /** Billing Info and shipping details */
824
+ interface AddressWithContact {
825
+ /** Address. */
826
+ address?: Address;
827
+ /** Contact details. */
828
+ contactDetails?: FullAddressContactDetails;
829
+ }
830
+ /** Physical address */
831
+ interface Address {
832
+ /**
833
+ * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
834
+ * @format COUNTRY
835
+ */
836
+ country?: string | null;
837
+ /**
838
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
839
+ * @maxLength 50
840
+ */
841
+ subdivision?: string | null;
842
+ /**
843
+ * City name.
844
+ * @maxLength 50
845
+ */
846
+ city?: string | null;
847
+ /**
848
+ * Postal or zip code.
849
+ * @maxLength 50
850
+ */
851
+ postalCode?: string | null;
852
+ /** Street address. */
853
+ streetAddress?: StreetAddress;
854
+ /**
855
+ * Main address line (usually street name and number).
856
+ * @maxLength 150
857
+ */
858
+ addressLine?: string | null;
859
+ /**
860
+ * Free text providing more detailed address info. Usually contains apt, suite, floor.
861
+ * @maxLength 100
862
+ */
863
+ addressLine2?: string | null;
864
+ /**
865
+ * Country's full name.
866
+ * @readonly
867
+ */
868
+ countryFullname?: string | null;
869
+ /**
870
+ * Subdivision full-name.
871
+ * @readonly
872
+ */
873
+ subdivisionFullname?: string | null;
874
+ }
875
+ interface StreetAddress {
876
+ /** Street number. */
877
+ number?: string;
878
+ /** Street name. */
879
+ name?: string;
880
+ }
881
+ /** Full contact details for an address */
882
+ interface FullAddressContactDetails {
883
+ /**
884
+ * First name.
885
+ * @maxLength 100
886
+ */
887
+ firstName?: string | null;
888
+ /**
889
+ * Last name.
890
+ * @maxLength 100
891
+ */
892
+ lastName?: string | null;
893
+ /**
894
+ * Phone number.
895
+ * @format PHONE
896
+ */
897
+ phone?: string | null;
898
+ /**
899
+ * Company name.
900
+ * @maxLength 1000
901
+ */
902
+ company?: string | null;
903
+ /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
904
+ vatId?: VatId;
905
+ }
906
+ interface VatId {
907
+ /** Customer's tax ID. */
908
+ id?: string;
909
+ /**
910
+ * Tax type.
911
+ *
912
+ * Supported values:
913
+ * + `CPF`: for individual tax payers
914
+ * + `CNPJ`: for corporations
915
+ */
916
+ type?: VatTypeWithLiterals;
917
+ }
918
+ /** tax info types */
919
+ declare enum VatType {
920
+ UNSPECIFIED = "UNSPECIFIED",
921
+ /** CPF - for individual tax payers. */
922
+ CPF = "CPF",
923
+ /** CNPJ - for corporations */
924
+ CNPJ = "CNPJ"
925
+ }
926
+ /** @enumType */
927
+ type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
928
+ interface V1PickupDetails {
929
+ /** Pickup address. */
930
+ address?: PickupAddress;
931
+ /** Pickup method */
932
+ pickupMethod?: PickupDetailsPickupMethodWithLiterals;
933
+ }
934
+ /** Physical address */
935
+ interface PickupAddress {
936
+ /**
937
+ * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
938
+ * @format COUNTRY
939
+ */
940
+ country?: string | null;
941
+ /**
942
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
943
+ * @maxLength 50
944
+ */
945
+ subdivision?: string | null;
946
+ /**
947
+ * City name.
948
+ * @maxLength 1000
949
+ */
950
+ city?: string | null;
951
+ /**
952
+ * Postal or zip code.
953
+ * @maxLength 1000
954
+ */
955
+ postalCode?: string | null;
956
+ /** Street address object, with number, name, and apartment number in separate fields. */
957
+ streetAddress?: StreetAddress;
958
+ /**
959
+ * Main address line (usually street name and number).
960
+ * @maxLength 1000
961
+ */
962
+ addressLine?: string | null;
963
+ /**
964
+ * Free text providing more detailed address info. Usually contains apt, suite, floor.
965
+ * @maxLength 1000
966
+ */
967
+ addressLine2?: string | null;
968
+ /**
969
+ * Country's full name.
970
+ * @readonly
971
+ */
972
+ countryFullname?: string | null;
973
+ /**
974
+ * Subdivision full-name.
975
+ * @readonly
976
+ */
977
+ subdivisionFullname?: string | null;
978
+ }
979
+ declare enum PickupDetailsPickupMethod {
980
+ UNKNOWN_METHOD = "UNKNOWN_METHOD",
981
+ STORE_PICKUP = "STORE_PICKUP",
982
+ PICKUP_POINT = "PICKUP_POINT"
983
+ }
984
+ /** @enumType */
985
+ type PickupDetailsPickupMethodWithLiterals = PickupDetailsPickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
986
+ interface V1DeliveryTimeSlot {
987
+ /** Delivery slot starting time. */
988
+ from?: Date | null;
989
+ /** Delivery slot ending time. */
990
+ to?: Date | null;
991
+ }
992
+ interface V1ShippingPrice {
993
+ /** Shipping price for display purposes. */
994
+ price?: Price;
995
+ /**
996
+ * Total price of shipping after discounts (when relevant), and before tax.
997
+ * @readonly
998
+ */
999
+ totalPriceBeforeTax?: Price;
1000
+ /**
1001
+ * Shipping price after all discounts (if any exist), and after tax.
1002
+ * @readonly
1003
+ */
1004
+ totalPriceAfterTax?: Price;
1005
+ /** Tax details. */
1006
+ taxDetails?: ItemTaxFullDetails;
1007
+ /**
1008
+ * Shipping discount before tax.
1009
+ * @readonly
1010
+ */
1011
+ discount?: Price;
1012
+ }
1013
+ interface ShippingRegion {
1014
+ /**
1015
+ * Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
1016
+ * @maxLength 100
1017
+ */
1018
+ name?: string | null;
1019
+ }
1020
+ interface ShippingChangedDetails {
1021
+ /** Shipping info before the change. */
1022
+ shippingInfoBeforeChange?: V1ShippingInformation;
1023
+ }
1024
+ /** Buyer Info */
1025
+ interface BuyerInfo extends BuyerInfoIdOneOf {
1026
+ /**
1027
+ * Visitor ID (if site visitor is not a member).
1028
+ * @format GUID
1029
+ */
1030
+ visitorId?: string;
1031
+ /**
1032
+ * Member ID (if site visitor is a site member).
1033
+ * @format GUID
1034
+ */
1035
+ memberId?: string;
1036
+ /**
1037
+ * Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).
1038
+ * @format GUID
1039
+ */
1040
+ contactId?: string | null;
1041
+ /**
1042
+ * Buyer email address.
1043
+ * @format EMAIL
1044
+ */
1045
+ email?: string | null;
1046
+ }
1047
+ /** @oneof */
1048
+ interface BuyerInfoIdOneOf {
1049
+ /**
1050
+ * Visitor ID (if site visitor is not a member).
1051
+ * @format GUID
1052
+ */
1053
+ visitorId?: string;
1054
+ /**
1055
+ * Member ID (if site visitor is a site member).
1056
+ * @format GUID
1057
+ */
1058
+ memberId?: string;
1059
+ }
1060
+ interface AdditionalFeeDetails {
1061
+ /** Additional fee. */
1062
+ additionalFee?: AdditionalFee;
1063
+ /** Tax details related to the additional fee. */
1064
+ taxDetails?: TaxDetails;
1065
+ /**
1066
+ * Source of the additional fee.
1067
+ *
1068
+ * Supported values:
1069
+ * + `ORIGINAL_ORDER`: This additional fee is part of the original order.
1070
+ * + `AUTOMATIC`: User added a catalog item which is configured to have an additional fee.
1071
+ * + `CUSTOM`: This additional fee was created by the Create Custom Additional Fees method.
1072
+ */
1073
+ source?: SourceTypeWithLiterals;
1074
+ /** Whether this additional fee is applied to the order. */
1075
+ applied?: boolean;
1076
+ }
1077
+ interface AdditionalFee {
1078
+ /**
1079
+ * Additional fee's unique code for future processing.
1080
+ * @minLength 1
1081
+ * @maxLength 100
1082
+ */
1083
+ code?: string | null;
1084
+ /**
1085
+ * Name of additional fee.
1086
+ * @minLength 1
1087
+ * @maxLength 50
1088
+ */
1089
+ name?: string;
1090
+ /** Additional fee's price. */
1091
+ price?: Price;
1092
+ /** Tax details. */
1093
+ taxDetails?: ItemTaxFullDetails;
1094
+ /**
1095
+ * SPI implementer's `appId`.
1096
+ * @format GUID
1097
+ */
1098
+ providerAppId?: string | null;
1099
+ /** Additional fee's price before tax. */
1100
+ priceBeforeTax?: Price;
1101
+ /** Additional fee's price after tax. */
1102
+ priceAfterTax?: Price;
1103
+ /**
1104
+ * Additional fee's id.
1105
+ * @format GUID
1106
+ * @immutable
1107
+ */
1108
+ id?: string;
1109
+ /**
1110
+ * Optional - Line items associated with this additional fee.
1111
+ * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
1112
+ * @format GUID
1113
+ */
1114
+ lineItemIds?: string[];
1115
+ }
1116
+ interface TaxDetails {
1117
+ /** Whether the additional fee is taxable. */
1118
+ taxable?: boolean;
1119
+ /**
1120
+ * Optional tax group ID to use when calculating tax for this additional fee.
1121
+ * @format GUID
1122
+ */
1123
+ taxGroupId?: string | null;
1124
+ }
1125
+ declare enum SourceType {
1126
+ /** Part of the original order. */
1127
+ ORIGINAL_ORDER = "ORIGINAL_ORDER",
1128
+ /** Added automatically, as the result of recalculation caused by changes in draft order. */
1129
+ AUTOMATIC = "AUTOMATIC",
1130
+ /** Added manually to draft order. */
1131
+ CUSTOM = "CUSTOM"
1132
+ }
1133
+ /** @enumType */
1134
+ type SourceTypeWithLiterals = SourceType | 'ORIGINAL_ORDER' | 'AUTOMATIC' | 'CUSTOM';
1135
+ interface DiscountDetails {
1136
+ /** Discount details. */
1137
+ discount?: AppliedDiscount;
1138
+ /**
1139
+ * Source of the discount.
1140
+ *
1141
+ * Supported values:
1142
+ * + `ORIGINAL_ORDER`: This discount is part of the original order.
1143
+ * + `CUSTOM`: This discount was created by the Create Custom Discounts method.
1144
+ */
1145
+ source?: SourceTypeWithLiterals;
1146
+ /** Whether this discount is applied to the order. */
1147
+ applied?: boolean;
1148
+ }
1149
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1150
+ /** Applied coupon info. */
1151
+ coupon?: Coupon;
1152
+ /** Merchant discount. */
1153
+ merchantDiscount?: MerchantDiscount;
1154
+ /** Automatic Discount */
1155
+ discountRule?: DiscountRule;
1156
+ /**
1157
+ * Discount type.
1158
+ * * `"GLOBAL"` - discount applies to entire order.
1159
+ * * `"SPECIFIC-ITEMS"` - discount applies to specific items.
1160
+ * * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
1161
+ */
1162
+ discountType?: AppliedDiscountDiscountTypeWithLiterals;
1163
+ /**
1164
+ * IDs of line items discount applies to.
1165
+ * Deprecated. Use `line_item_discounts` instead.
1166
+ * @format GUID
1167
+ * @maxSize 1
1168
+ * @deprecated IDs of line items discount applies to.
1169
+ * Deprecated. Use `line_item_discounts` instead.
1170
+ * @replacedBy line_item_discounts
1171
+ * @targetRemovalDate 2024-10-30
1172
+ */
1173
+ lineItemIds?: string[];
1174
+ /**
1175
+ * Discount id.
1176
+ * @format GUID
1177
+ * @immutable
1178
+ */
1179
+ id?: string | null;
1180
+ }
1181
+ /** @oneof */
1182
+ interface AppliedDiscountDiscountSourceOneOf {
1183
+ /** Applied coupon info. */
1184
+ coupon?: Coupon;
1185
+ /** Merchant discount. */
1186
+ merchantDiscount?: MerchantDiscount;
1187
+ /** Automatic Discount */
1188
+ discountRule?: DiscountRule;
1189
+ }
1190
+ declare enum AppliedDiscountDiscountType {
1191
+ GLOBAL = "GLOBAL",
1192
+ SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1193
+ SHIPPING = "SHIPPING"
1194
+ }
1195
+ /** @enumType */
1196
+ type AppliedDiscountDiscountTypeWithLiterals = AppliedDiscountDiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1197
+ /** Coupon */
1198
+ interface Coupon {
1199
+ /** Coupon ID. */
1200
+ id?: string;
1201
+ /** Coupon code. */
1202
+ code?: string;
1203
+ /** Coupon name. */
1204
+ name?: string;
1205
+ /** Coupon value. */
1206
+ amount?: Price;
1207
+ }
1208
+ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1209
+ /**
1210
+ * Pre-defined discount reason (optional).
1211
+ * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
1212
+ */
1213
+ discountReason?: DiscountReasonWithLiterals;
1214
+ /**
1215
+ * Discount description as free text (optional).
1216
+ * @maxLength 200
1217
+ */
1218
+ description?: string | null;
1219
+ /** Discount amount. */
1220
+ amount?: Price;
1221
+ }
1222
+ /** @oneof */
1223
+ interface MerchantDiscountMerchantDiscountReasonOneOf {
1224
+ /**
1225
+ * Pre-defined discount reason (optional).
1226
+ * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
1227
+ */
1228
+ discountReason?: DiscountReasonWithLiterals;
1229
+ /**
1230
+ * Discount description as free text (optional).
1231
+ * @maxLength 200
1232
+ */
1233
+ description?: string | null;
1234
+ }
1235
+ declare enum DiscountReason {
1236
+ UNSPECIFIED = "UNSPECIFIED",
1237
+ EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
1238
+ BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
1239
+ }
1240
+ /** @enumType */
1241
+ type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
1242
+ interface DiscountRule {
1243
+ /**
1244
+ * Discount rule ID
1245
+ * @format GUID
1246
+ */
1247
+ id?: string;
1248
+ /** Discount rule name */
1249
+ name?: DiscountRuleName;
1250
+ /** Discount value. */
1251
+ amount?: Price;
1252
+ }
1253
+ interface DiscountRuleName {
1254
+ /**
1255
+ * Original discount rule name (in site's default language).
1256
+ * @minLength 1
1257
+ * @maxLength 256
1258
+ */
1259
+ original?: string;
1260
+ /**
1261
+ * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
1262
+ * @minLength 1
1263
+ * @maxLength 500
1264
+ */
1265
+ translated?: string | null;
1266
+ }
1267
+ interface LineItemDiscount {
1268
+ /**
1269
+ * ID of line item the discount applies to.
1270
+ * @format GUID
1271
+ */
1272
+ id?: string;
1273
+ /** Total discount for this line item. */
1274
+ totalDiscount?: Price;
1275
+ }
1276
+ interface CreatedBy extends CreatedByStringOneOf {
1277
+ /**
1278
+ * User ID. When the draft order was created by a Wix user.
1279
+ * @format GUID
1280
+ */
1281
+ userId?: string;
1282
+ /**
1283
+ * App ID. When the draft order was created by an app.
1284
+ * @format GUID
1285
+ */
1286
+ appId?: string;
1287
+ }
1288
+ /** @oneof */
1289
+ interface CreatedByStringOneOf {
1290
+ /**
1291
+ * User ID. When the draft order was created by a Wix user.
1292
+ * @format GUID
1293
+ */
1294
+ userId?: string;
1295
+ /**
1296
+ * App ID. When the draft order was created by an app.
1297
+ * @format GUID
1298
+ */
1299
+ appId?: string;
1300
+ }
1301
+ declare enum EditingStatus {
1302
+ /** Draft order is being edited. */
1303
+ DRAFT = "DRAFT",
1304
+ /**
1305
+ * Draft order has been committed - No further modifications allowed.
1306
+ *
1307
+ * Draft orders with status 'COMMITTED' cannot be deleted.
1308
+ */
1309
+ COMMITTED = "COMMITTED"
1310
+ }
1311
+ /** @enumType */
1312
+ type EditingStatusWithLiterals = EditingStatus | 'DRAFT' | 'COMMITTED';
1313
+ declare enum WeightUnit {
1314
+ /** Weight unit can't be classified due to an error. */
1315
+ UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
1316
+ /** Kilograms. */
1317
+ KG = "KG",
1318
+ /** Pounds. */
1319
+ LB = "LB"
1320
+ }
1321
+ /** @enumType */
1322
+ type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
1323
+ interface PriceSummary {
1324
+ /** Subtotal of all the line items, before discounts and before tax. */
1325
+ subtotal?: Price;
1326
+ /** Total shipping price, before discounts and before tax. */
1327
+ shipping?: Price;
1328
+ /** Total tax on this order. */
1329
+ tax?: Price;
1330
+ /** Total calculated discount value. */
1331
+ discount?: Price;
1332
+ /** Order’s total price after discounts and tax. */
1333
+ total?: Price;
1334
+ /** Total price of additional fees before tax. */
1335
+ totalAdditionalFees?: Price;
1336
+ }
1337
+ interface TaxSummary {
1338
+ /**
1339
+ * Total tax.
1340
+ * @readonly
1341
+ */
1342
+ totalTax?: Price;
1343
+ }
1344
+ interface BalanceSummary {
1345
+ /**
1346
+ * Amount left to pay for the order to be considered paid.
1347
+ * @readonly
1348
+ */
1349
+ balance?: Balance;
1350
+ /**
1351
+ * Sum of all approved and successful payments.
1352
+ *
1353
+ * The value includes payments that have subsequently been fully or partially refunded.
1354
+ * @readonly
1355
+ */
1356
+ paid?: Price;
1357
+ /**
1358
+ * Sum of all successfully refunded payments.
1359
+ * @readonly
1360
+ */
1361
+ refunded?: Price;
1362
+ /**
1363
+ * Sum of all authorized payments.
1364
+ * @readonly
1365
+ */
1366
+ authorized?: Price;
1367
+ }
1368
+ /**
1369
+ * Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
1370
+ * `amount` field depends on order payment status:
1371
+ * + UNSPECIFIED, NOT_PAID: price_summary.total_price
1372
+ * + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
1373
+ * + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
1374
+ */
1375
+ interface Balance {
1376
+ /**
1377
+ * Balance amount.
1378
+ *
1379
+ * A negative `amount` represents the amount to be refunded. This can happen due to overcharging or the order being modified after a payment has been made.
1380
+ * @decimalValue options { }
1381
+ * @readonly
1382
+ */
1383
+ amount?: string;
1384
+ /**
1385
+ * Amount formatted with currency symbol.
1386
+ * @readonly
1387
+ */
1388
+ formattedAmount?: string;
1389
+ }
1390
+ /** Side-effects upon committing a draft order. */
1391
+ interface DraftOrderCommitSettings {
1392
+ /**
1393
+ * Whether to send notifications to the buyer.
1394
+ *
1395
+ * Default: `true`
1396
+ */
1397
+ sendNotificationsToBuyer?: boolean | null;
1398
+ /**
1399
+ * Whether to send notifications to the business.
1400
+ *
1401
+ * Default: `true`
1402
+ */
1403
+ sendNotificationsToBusiness?: boolean | null;
1404
+ /**
1405
+ * Whether to add activities to the order.
1406
+ *
1407
+ * Default: `true`
1408
+ */
1409
+ addActivitiesToOrder?: boolean | null;
1410
+ /**
1411
+ * Whether to send email notifications to custom fulfillers when there is a change in the shippable items they fulfill.
1412
+ *
1413
+ * Default: `true`
1414
+ */
1415
+ sendNotificationsToCustomFulfillers?: boolean | null;
1416
+ /**
1417
+ * Line item IDs for which to perform an inventory change.
1418
+ * When not provided, inventory will not change.
1419
+ * @maxSize 300
1420
+ */
1421
+ updateInventory?: InventoryUpdate[];
1422
+ }
1423
+ interface InventoryUpdate {
1424
+ /**
1425
+ * Line item ID.
1426
+ * @format GUID
1427
+ */
1428
+ lineItemId?: string;
1429
+ }
1430
+ interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
1431
+ /** Indicates that recipient information was added during draft. */
1432
+ added?: boolean;
1433
+ /** Indicates that recipient information was changed. Contains recipient information before draft. */
1434
+ changedDetails?: RecipientInfoChangedDetails;
1435
+ /** Indicates that recipient information was removed during draft. */
1436
+ removed?: boolean;
1437
+ /** Order recipient address and contact details. */
1438
+ recipientInfo?: AddressWithContact;
1439
+ }
1440
+ /** @oneof */
1441
+ interface RecipientInfoDetailsChangeTypeOneOf {
1442
+ /** Indicates that recipient information was added during draft. */
1443
+ added?: boolean;
1444
+ /** Indicates that recipient information was changed. Contains recipient information before draft. */
1445
+ changedDetails?: RecipientInfoChangedDetails;
1446
+ /** Indicates that recipient information was removed during draft. */
1447
+ removed?: boolean;
1448
+ }
1449
+ interface RecipientInfoChangedDetails {
1450
+ /** Order recipient address and contact details before draft. */
1451
+ recipientInfoBeforeChange?: AddressWithContact;
1452
+ }
1453
+ interface OrderTaxInfo {
1454
+ /** Calculated tax, added from line items. */
1455
+ totalTax?: Price;
1456
+ /**
1457
+ * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
1458
+ * @maxSize 50
1459
+ */
1460
+ taxBreakdown?: OrderTaxBreakdown[];
1461
+ /**
1462
+ * Whether the order is exempt from tax calculations.
1463
+ *
1464
+ * Default: `false`
1465
+ * @readonly
1466
+ */
1467
+ taxExempt?: boolean | null;
1468
+ }
1469
+ /**
1470
+ * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
1471
+ * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1472
+ */
1473
+ interface OrderTaxBreakdown {
1474
+ /**
1475
+ * The name of the tax against which this tax amount was calculated.
1476
+ * @maxLength 200
1477
+ */
1478
+ taxName?: string;
1479
+ /**
1480
+ * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
1481
+ * @maxLength 200
1482
+ */
1483
+ taxType?: string;
1484
+ /**
1485
+ * The name of the jurisdiction in which this tax detail applies.
1486
+ * @maxLength 200
1487
+ */
1488
+ jurisdiction?: string;
1489
+ /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1490
+ jurisdictionType?: JurisdictionTypeWithLiterals;
1491
+ /**
1492
+ * The rate at which this tax detail was calculated.
1493
+ * @format DECIMAL_VALUE
1494
+ * @decimalValue options { gte:0, maxScale:6 }
1495
+ */
1496
+ rate?: string;
1497
+ /** The sum of all the tax from line items that calculated by the tax identifiers. */
1498
+ aggregatedTaxAmount?: Price;
1499
+ }
1500
+ interface BuyerDetails extends BuyerDetailsChangeTypeOneOf {
1501
+ /** Indicates that buyer information was added during draft. */
1502
+ added?: boolean;
1503
+ /** Indicates that buyer information was changed. Contains billing information before draft. */
1504
+ changedDetails?: BuyerChangedDetails;
1505
+ /** Indicates that buyer information was removed during draft. */
1506
+ removed?: boolean;
1507
+ /** Buyer information. */
1508
+ buyerInfo?: BuyerInfo;
1509
+ }
1510
+ /** @oneof */
1511
+ interface BuyerDetailsChangeTypeOneOf {
1512
+ /** Indicates that buyer information was added during draft. */
1513
+ added?: boolean;
1514
+ /** Indicates that buyer information was changed. Contains billing information before draft. */
1515
+ changedDetails?: BuyerChangedDetails;
1516
+ /** Indicates that buyer information was removed during draft. */
1517
+ removed?: boolean;
1518
+ }
1519
+ interface BuyerChangedDetails {
1520
+ /** Buyer information before draft. */
1521
+ buyerInfoBeforeChange?: BuyerInfo;
1522
+ }
1523
+ interface BillingDetails extends BillingDetailsChangeTypeOneOf {
1524
+ /** Indicates that billing information was added during draft. */
1525
+ added?: boolean;
1526
+ /** Indicates that billing information was changed. Contains billing information before draft. */
1527
+ changedDetails?: BillingChangedDetails;
1528
+ /** Indicates that billing information was removed during draft. */
1529
+ removed?: boolean;
1530
+ /** Billing address and contact details. */
1531
+ billingInfo?: AddressWithContact;
1532
+ }
1533
+ /** @oneof */
1534
+ interface BillingDetailsChangeTypeOneOf {
1535
+ /** Indicates that billing information was added during draft. */
1536
+ added?: boolean;
1537
+ /** Indicates that billing information was changed. Contains billing information before draft. */
1538
+ changedDetails?: BillingChangedDetails;
1539
+ /** Indicates that billing information was removed during draft. */
1540
+ removed?: boolean;
1541
+ }
1542
+ interface BillingChangedDetails {
1543
+ /** Billing address and contact details before draft. */
1544
+ billingInfoBeforeChange?: AddressWithContact;
1545
+ }
1546
+ interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
1547
+ /** Indicates that business location was added during draft. */
1548
+ added?: boolean;
1549
+ /** Indicates that business location was changed. Contains business location before draft. */
1550
+ changedDetails?: BusinessLocationChangedDetails;
1551
+ /** Indicates that business location was removed during draft. */
1552
+ removed?: boolean;
1553
+ /** Business location. */
1554
+ businessLocation?: Location;
1555
+ }
1556
+ /** @oneof */
1557
+ interface BusinessLocationDetailsChangeTypeOneOf {
1558
+ /** Indicates that business location was added during draft. */
1559
+ added?: boolean;
1560
+ /** Indicates that business location was changed. Contains business location before draft. */
1561
+ changedDetails?: BusinessLocationChangedDetails;
1562
+ /** Indicates that business location was removed during draft. */
1563
+ removed?: boolean;
1564
+ }
1565
+ interface Location {
1566
+ /**
1567
+ * Location ID.
1568
+ * Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
1569
+ * @format GUID
1570
+ */
1571
+ id?: string;
1572
+ /**
1573
+ * Location name.
1574
+ * @minLength 1
1575
+ * @maxLength 500
1576
+ * @readonly
1577
+ */
1578
+ name?: string;
1579
+ }
1580
+ interface BusinessLocationChangedDetails {
1581
+ /** Business location before draft. */
1582
+ businessLocationBeforeChange?: Location;
1583
+ }
1584
+ interface CreateDraftOrderRequest {
1585
+ /**
1586
+ * ID of the order to create a draft for.
1587
+ * @format GUID
1588
+ */
1589
+ orderId: string | null;
1590
+ }
1591
+ interface CreateDraftOrderResponse {
1592
+ /** Draft order calculated with the latest changes. */
1593
+ calculatedDraftOrder?: CalculatedDraftOrder;
1594
+ /**
1595
+ * Whether the response contains a draft order that existed before request.
1596
+ *
1597
+ * `true`: The draft order already exists and is updated.
1598
+ * `false`: A new draft order is created.
1599
+ */
1600
+ preexistingDraftOrder?: boolean | null;
1601
+ }
1602
+ interface CalculatedDraftOrder {
1603
+ /** Draft order. */
1604
+ draftOrder?: DraftOrder;
1605
+ /** Shipping options. */
1606
+ shippingOptions?: ShippingOption[];
1607
+ /** Errors that occurred during calculation. */
1608
+ calculationErrors?: CalculationErrors;
1609
+ }
1610
+ interface ShippingOption {
1611
+ /**
1612
+ * Carrier ID.
1613
+ * @format GUID
1614
+ */
1615
+ carrierId?: string | null;
1616
+ /** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
1617
+ code?: string;
1618
+ /** Shipping rate title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"`, or `"First-Class Package International"`. */
1619
+ title?: string;
1620
+ /** Shipping logistics. */
1621
+ logistics?: DeliveryLogistics;
1622
+ /** Shipping cost. */
1623
+ cost?: ShippingPrice;
1624
+ }
1625
+ interface DeliveryLogistics {
1626
+ /** When the item is expected to be delivered in free text, e.g "3-5 business days" */
1627
+ deliveryTime?: string | null;
1628
+ /**
1629
+ * Instructions for delivery.
1630
+ *
1631
+ * For example, "Please arrive during business hours."
1632
+ */
1633
+ instructions?: string | null;
1634
+ /** Additional pickup details. */
1635
+ pickupDetails?: PickupDetails;
1636
+ /** Expected delivery time slot. */
1637
+ deliveryTimeSlot?: DeliveryTimeSlot;
1638
+ }
1639
+ interface PickupDetails {
1640
+ /** Pickup address. */
1641
+ address?: Address;
1642
+ /** Pickup method. */
1643
+ pickupMethod?: PickupMethodWithLiterals;
1644
+ }
1645
+ declare enum PickupMethod {
1646
+ UNKNOWN_METHOD = "UNKNOWN_METHOD",
1647
+ /** Store pickup. */
1648
+ STORE_PICKUP = "STORE_PICKUP",
1649
+ /** Pickup point. */
1650
+ PICKUP_POINT = "PICKUP_POINT"
1651
+ }
1652
+ /** @enumType */
1653
+ type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1654
+ interface DeliveryTimeSlot {
1655
+ /** Delivery time slot start time. */
1656
+ from?: Date | null;
1657
+ /** Delivery time slot end time. */
1658
+ to?: Date | null;
1659
+ }
1660
+ interface ShippingPrice {
1661
+ /** Shipping price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
1662
+ price?: Price;
1663
+ /**
1664
+ * Currency of the shipping price as a 3-letter [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217). Must align with the `currency` passed to the method.
1665
+ * @format CURRENCY
1666
+ */
1667
+ currency?: string;
1668
+ }
1669
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1670
+ /** General shipping calculation error. */
1671
+ generalShippingCalculationError?: Details;
1672
+ /** Carrier errors. */
1673
+ carrierErrors?: CarrierErrors;
1674
+ /** Tax calculation error. */
1675
+ taxCalculationError?: Details;
1676
+ /** Order validation errors. */
1677
+ orderValidationErrors?: ApplicationError[];
1678
+ }
1679
+ /** @oneof */
1680
+ interface CalculationErrorsShippingCalculationErrorOneOf {
1681
+ /** General shipping calculation error. */
1682
+ generalShippingCalculationError?: Details;
1683
+ /** Carrier errors. */
1684
+ carrierErrors?: CarrierErrors;
1685
+ }
1686
+ interface Details extends DetailsKindOneOf {
1687
+ applicationError?: ApplicationError;
1688
+ validationError?: ValidationError;
1689
+ systemError?: SystemError;
1690
+ /**
1691
+ * deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
1692
+ * @deprecated
1693
+ */
1694
+ tracing?: Record<string, string>;
1695
+ }
1696
+ /** @oneof */
1697
+ interface DetailsKindOneOf {
1698
+ applicationError?: ApplicationError;
1699
+ validationError?: ValidationError;
1700
+ systemError?: SystemError;
1701
+ }
1702
+ interface ApplicationError {
1703
+ /** Error code. */
1704
+ code?: string;
1705
+ /** Description of the error. */
1706
+ description?: string;
1707
+ /** Data related to the error. */
1708
+ data?: Record<string, any> | null;
1709
+ }
1710
+ /**
1711
+ * example result:
1712
+ * {
1713
+ * "fieldViolations": [
1714
+ * {
1715
+ * "field": "fieldA",
1716
+ * "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
1717
+ * "violatedRule": "OTHER",
1718
+ * "ruleName": "INVALID_NOTE",
1719
+ * "data": {
1720
+ * "value": "FI"
1721
+ * }
1722
+ * },
1723
+ * {
1724
+ * "field": "fieldB",
1725
+ * "description": "field value out of range. supported range: [0-20]",
1726
+ * "violatedRule": "MAX",
1727
+ * "data": {
1728
+ * "threshold": 20
1729
+ * }
1730
+ * },
1731
+ * {
1732
+ * "field": "fieldC",
1733
+ * "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
1734
+ * "violatedRule": "FORMAT",
1735
+ * "data": {
1736
+ * "type": "PHONE"
1737
+ * }
1738
+ * }
1739
+ * ]
1740
+ * }
1741
+ */
1742
+ interface ValidationError {
1743
+ fieldViolations?: FieldViolation[];
1744
+ }
1745
+ declare enum RuleType {
1746
+ VALIDATION = "VALIDATION",
1747
+ OTHER = "OTHER",
1748
+ MAX = "MAX",
1749
+ MIN = "MIN",
1750
+ MAX_LENGTH = "MAX_LENGTH",
1751
+ MIN_LENGTH = "MIN_LENGTH",
1752
+ MAX_SIZE = "MAX_SIZE",
1753
+ MIN_SIZE = "MIN_SIZE",
1754
+ FORMAT = "FORMAT",
1755
+ DECIMAL_LTE = "DECIMAL_LTE",
1756
+ DECIMAL_GTE = "DECIMAL_GTE",
1757
+ DECIMAL_LT = "DECIMAL_LT",
1758
+ DECIMAL_GT = "DECIMAL_GT",
1759
+ DECIMAL_MAX_SCALE = "DECIMAL_MAX_SCALE",
1760
+ INVALID_ENUM_VALUE = "INVALID_ENUM_VALUE",
1761
+ REQUIRED_FIELD = "REQUIRED_FIELD",
1762
+ FIELD_NOT_ALLOWED = "FIELD_NOT_ALLOWED",
1763
+ ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT",
1764
+ EXACT_LENGTH = "EXACT_LENGTH",
1765
+ EXACT_SIZE = "EXACT_SIZE",
1766
+ REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1767
+ }
1768
+ /** @enumType */
1769
+ type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
1770
+ interface FieldViolation {
1771
+ field?: string;
1772
+ description?: string;
1773
+ violatedRule?: RuleTypeWithLiterals;
1774
+ /** applicable when violated_rule=OTHER */
1775
+ ruleName?: string | null;
1776
+ data?: Record<string, any> | null;
1777
+ }
1778
+ interface SystemError {
1779
+ /** Error code. */
1780
+ errorCode?: string | null;
1781
+ }
1782
+ interface CarrierErrors {
1783
+ /** Carrier errors. */
1784
+ errors?: CarrierError[];
1785
+ }
1786
+ interface CarrierError {
1787
+ /** Carrier ID. */
1788
+ carrierId?: string;
1789
+ /** Error details. */
1790
+ error?: Details;
1791
+ }
1792
+ interface CreateEmptyDraftOrderRequest {
1793
+ }
1794
+ interface CreateEmptyDraftOrderResponse {
1795
+ /** Draft order calculated with the latest changes. */
1796
+ calculatedDraftOrder?: CalculatedDraftOrder;
1797
+ }
1798
+ interface AddLineItemsToDraftOrderRequest {
1799
+ /**
1800
+ * Draft order ID.
1801
+ * @format GUID
1802
+ */
1803
+ draftOrderId: string;
1804
+ /**
1805
+ * Catalog line items to add to draft order.
1806
+ * @maxSize 300
1807
+ */
1808
+ catalogLineItems?: CatalogReferenceLineItem[];
1809
+ /**
1810
+ * Custom line items to add to draft order.
1811
+ *
1812
+ * Custom line items do not trigger the Catalog Service Plugin.
1813
+ * @maxSize 300
1814
+ */
1815
+ customLineItems?: CustomLineItem[];
1816
+ }
1817
+ interface CatalogReferenceLineItem {
1818
+ /**
1819
+ * Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.
1820
+ * Optional for custom line items, which don't trigger the Catalog service plugin.
1821
+ */
1822
+ catalogReference?: CatalogReference;
1823
+ /**
1824
+ * Item quantity.
1825
+ * @min 1
1826
+ * @max 100000
1827
+ */
1828
+ quantity?: number;
1829
+ /** Item price override. */
1830
+ price?: Price;
1831
+ /**
1832
+ * Whether the price is not yet defined, and will be updated after the order is created.
1833
+ *
1834
+ * Default: `false`
1835
+ */
1836
+ priceUndetermined?: boolean;
1837
+ /**
1838
+ * Line item locations.
1839
+ *
1840
+ * The location's total quantity must not exceed the line item quantity.
1841
+ * @maxSize 5
1842
+ */
1843
+ locations?: LocationAndQuantity[];
1844
+ }
1845
+ interface CustomLineItem {
1846
+ /**
1847
+ * Line item ID.
1848
+ * @format GUID
1849
+ */
1850
+ id?: string | null;
1851
+ /**
1852
+ * Item quantity.
1853
+ *
1854
+ * Min: `"1"`
1855
+ * Max: `"100000"`
1856
+ * @min 1
1857
+ * @max 100000
1858
+ */
1859
+ quantity?: number;
1860
+ /**
1861
+ * Catalog and item reference.
1862
+ *
1863
+ * Includes IDs for the item and the catalog it came from, as well as further optional info.
1864
+ * Optional for custom line items, which don't trigger the Catalog service plugin.
1865
+ */
1866
+ catalogReference?: CatalogReference;
1867
+ /**
1868
+ * Item name.
1869
+ * + Stores - `product.name`
1870
+ * + Bookings - `service.info.name`
1871
+ * + Events - `ticket.name`
1872
+ */
1873
+ productName?: ProductName;
1874
+ /** URL to the item's page on the site. */
1875
+ url?: PageUrlV2;
1876
+ /** Item price **after** catalog-defined discount and line item discounts. */
1877
+ price?: Price;
1878
+ /** Total line item price **after** catalog-defined discount and line item discounts. */
1879
+ lineItemPrice?: Price;
1880
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
1881
+ fullPrice?: Price;
1882
+ /** Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided. */
1883
+ priceBeforeDiscounts?: Price;
1884
+ /** Line item description lines. Used for display purposes for order. */
1885
+ descriptionLines?: DescriptionLine[];
1886
+ /** Line item image details. */
1887
+ media?: Image;
1888
+ /** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
1889
+ physicalProperties?: PhysicalProperties;
1890
+ /** Item type. Either a preset type or custom. */
1891
+ itemType?: ItemType;
1892
+ /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1893
+ priceDescription?: PriceDescription;
1894
+ /**
1895
+ * Delivery Profile Id for the product
1896
+ * @format GUID
1897
+ */
1898
+ deliveryProfileId?: string | null;
1899
+ /**
1900
+ * Line item locations.
1901
+ *
1902
+ * The location's total quantity must not exceed the line item quantity.
1903
+ * @maxSize 5
1904
+ */
1905
+ locations?: LocationAndQuantity[];
1906
+ }
1907
+ interface PageUrlV2 {
1908
+ /** The relative path for the page within the site. For example, `/product-page/a-product`. */
1909
+ relativePath?: string;
1910
+ /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
1911
+ url?: string | null;
1912
+ }
1913
+ interface AddLineItemsToDraftOrderResponse {
1914
+ /** Draft order calculated with the latest changes. */
1915
+ calculatedDraftOrder?: CalculatedDraftOrder;
1916
+ }
1917
+ interface UpdateLineItemsRequest {
1918
+ /**
1919
+ * Draft order ID.
1920
+ * @format GUID
1921
+ */
1922
+ draftOrderId: string;
1923
+ /**
1924
+ * Details of changes to apply per line item.
1925
+ * @minSize 1
1926
+ * @maxSize 300
1927
+ */
1928
+ lineItemChanges: LineItemChangeDetails[];
1929
+ }
1930
+ interface LineItemChangeDetails {
1931
+ /**
1932
+ * Line item ID.
1933
+ * @format GUID
1934
+ */
1935
+ lineItemId?: string;
1936
+ /**
1937
+ * The line item's new quantity.
1938
+ *
1939
+ * > **Note:** Passing `0` will remove the line item.
1940
+ * @max 1000000
1941
+ */
1942
+ newQuantity?: number | null;
1943
+ /**
1944
+ * New price for 1 unit of the line item.
1945
+ * @decimalValue options { gte:0, lte:1000000000000000 }
1946
+ */
1947
+ newPrice?: string | null;
1948
+ /**
1949
+ * New description for the price.
1950
+ *
1951
+ * For example, when price is `0` but additional details about the actual price are needed - `"Starts at $67"`.
1952
+ */
1953
+ newPriceDescription?: PriceDescription;
1954
+ }
1955
+ interface UpdateLineItemsResponse {
1956
+ /** Draft order calculated with the latest changes. */
1957
+ calculatedDraftOrder?: CalculatedDraftOrder;
1958
+ }
1959
+ interface SetDiscountsRequest {
1960
+ /**
1961
+ * Draft order ID.
1962
+ * @format GUID
1963
+ */
1964
+ draftOrderId: string;
1965
+ /**
1966
+ * Discounts to set on the draft order.
1967
+ *
1968
+ * Any existing discounts that are not passed will not change.
1969
+ * @minSize 1
1970
+ * @maxSize 320
1971
+ */
1972
+ discounts: IdAndApplied[];
1973
+ }
1974
+ interface IdAndApplied {
1975
+ /**
1976
+ * Entity ID.
1977
+ *
1978
+ * Depending on the context, the value is either a discount ID or an additional fee ID.
1979
+ * @format GUID
1980
+ */
1981
+ id?: string;
1982
+ /** Whether the discount or additional fee should be applied to the draft order. */
1983
+ applied?: boolean;
1984
+ }
1985
+ interface SetDiscountsResponse {
1986
+ /** Draft order calculated with the latest changes. */
1987
+ calculatedDraftOrder?: CalculatedDraftOrder;
1988
+ }
1989
+ interface CreateCustomDiscountsRequest {
1990
+ /**
1991
+ * Draft order ID.
1992
+ * @format GUID
1993
+ */
1994
+ draftOrderId: string;
1995
+ /**
1996
+ * Custom discounts to create.
1997
+ *
1998
+ * Created discounts are not applied by default.
1999
+ * @minSize 1
2000
+ * @maxSize 100
2001
+ */
2002
+ discounts?: DiscountOption[];
2003
+ }
2004
+ interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
2005
+ /** Amount to discount from the line item price. */
2006
+ priceAmount?: Price;
2007
+ /**
2008
+ * Percentage to discount from the line item price.
2009
+ * @format DECIMAL_VALUE
2010
+ * @decimalValue options { gte:0, lte:100, maxScale:2 }
2011
+ */
2012
+ percentage?: string | null;
2013
+ /** Discount type. */
2014
+ discountType?: DiscountTypeWithLiterals;
2015
+ /**
2016
+ * ID of line item discount applies to.
2017
+ * @format GUID
2018
+ * @deprecated ID of line item discount applies to.
2019
+ * @replacedBy line_item_discounts
2020
+ * @targetRemovalDate 2024-10-30
2021
+ */
2022
+ lineItemId?: string | null;
2023
+ /**
2024
+ * Discount amount.
2025
+ * @deprecated Discount amount.
2026
+ * @replacedBy price_amount and percentage
2027
+ * @targetRemovalDate 2024-08-30
2028
+ */
2029
+ amount?: Price;
2030
+ /**
2031
+ * Discount description as free text (optional).
2032
+ * @maxLength 200
2033
+ */
2034
+ description?: string | null;
2035
+ /**
2036
+ * Whether to apply the discount to the draft order.
2037
+ *
2038
+ * Default: `false`
2039
+ */
2040
+ applyToDraftOrder?: boolean | null;
2041
+ /**
2042
+ * Line items the discount applies to.
2043
+ * @maxSize 1
2044
+ */
2045
+ lineItemDiscounts?: LineItemDiscount[];
2046
+ }
2047
+ /** @oneof */
2048
+ interface DiscountOptionDiscountAmountOneOf {
2049
+ /** Amount to discount from the line item price. */
2050
+ priceAmount?: Price;
2051
+ /**
2052
+ * Percentage to discount from the line item price.
2053
+ * @format DECIMAL_VALUE
2054
+ * @decimalValue options { gte:0, lte:100, maxScale:2 }
2055
+ */
2056
+ percentage?: string | null;
2057
+ }
2058
+ declare enum DiscountType {
2059
+ UNKNOWN_TYPE = "UNKNOWN_TYPE",
2060
+ /** Discount applies to the entire order. */
2061
+ GLOBAL = "GLOBAL",
2062
+ /** Discount applies to a specific item. */
2063
+ SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
2064
+ /** Discount applies to shipping fee. */
2065
+ SHIPPING = "SHIPPING"
2066
+ }
2067
+ /** @enumType */
2068
+ type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN_TYPE' | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
2069
+ interface CreateCustomDiscountsResponse {
2070
+ /** Draft order calculated with the latest changes. */
2071
+ calculatedDraftOrder?: CalculatedDraftOrder;
2072
+ }
2073
+ interface DeleteCustomDiscountsRequest {
2074
+ /**
2075
+ * Draft order ID.
2076
+ * @format GUID
2077
+ */
2078
+ draftOrderId: string;
2079
+ /**
2080
+ * IDs of the discounts to remove from the draft order.
2081
+ * @format GUID
2082
+ * @minSize 1
2083
+ * @maxSize 100
2084
+ */
2085
+ discountIds: string[];
2086
+ }
2087
+ interface DeleteCustomDiscountsResponse {
2088
+ /** Draft order calculated with the latest changes. */
2089
+ calculatedDraftOrder?: CalculatedDraftOrder;
2090
+ }
2091
+ interface SetAdditionalFeesRequest {
2092
+ /**
2093
+ * Draft order ID.
2094
+ * @format GUID
2095
+ */
2096
+ draftOrderId: string;
2097
+ /**
2098
+ * Additional fees to set on the draft order.
2099
+ *
2100
+ * Any existing additional fees that are not passed will not change.
2101
+ * @minSize 1
2102
+ * @maxSize 100
2103
+ */
2104
+ additionalFees: IdAndApplied[];
2105
+ }
2106
+ interface SetAdditionalFeesResponse {
2107
+ /** Draft order calculated with the latest changes. */
2108
+ calculatedDraftOrder?: CalculatedDraftOrder;
2109
+ }
2110
+ interface CreateCustomAdditionalFeesRequest {
2111
+ /**
2112
+ * Draft order ID.
2113
+ * @format GUID
2114
+ */
2115
+ draftOrderId: string;
2116
+ /**
2117
+ * Custom additional fees to create.
2118
+ *
2119
+ * Created additional fees are not applied by default.
2120
+ * @minSize 1
2121
+ * @maxSize 100
2122
+ */
2123
+ customAdditionalFees?: AdditionalFeeOption[];
2124
+ }
2125
+ interface AdditionalFeeOption {
2126
+ /**
2127
+ * Name of the additional fee.
2128
+ * @minLength 1
2129
+ * @maxLength 50
2130
+ */
2131
+ name?: string;
2132
+ /** Price of the additional fee. */
2133
+ price?: Price;
2134
+ /** Tax calculation details. */
2135
+ taxDetails?: TaxDetails;
2136
+ /**
2137
+ * Whether to apply the additional fee to the draft order.
2138
+ *
2139
+ * Default: `false`
2140
+ */
2141
+ applyToDraftOrder?: boolean | null;
2142
+ /**
2143
+ * Additional fee unique code (or ID) for future processing.
2144
+ * @minLength 1
2145
+ * @maxLength 100
2146
+ */
2147
+ code?: string | null;
2148
+ /**
2149
+ * IDs of the line items associated with this additional fee.
2150
+ *
2151
+ * If no `lineItemIds` are provided, the fee will be associated with the whole order.
2152
+ * @format GUID
2153
+ * @maxSize 300
2154
+ */
2155
+ lineItemIds?: string[];
2156
+ }
2157
+ interface CreateCustomAdditionalFeesResponse {
2158
+ /** Draft order calculated with the latest changes. */
2159
+ calculatedDraftOrder?: CalculatedDraftOrder;
2160
+ }
2161
+ interface DeleteCustomAdditionalFeesRequest {
2162
+ /**
2163
+ * Draft order ID.
2164
+ * @format GUID
2165
+ */
2166
+ draftOrderId: string;
2167
+ /**
2168
+ * IDs of the additional fees to remove from the draft order.
2169
+ * @format GUID
2170
+ * @minSize 1
2171
+ * @maxSize 100
2172
+ */
2173
+ customAdditionalFees: string[];
2174
+ }
2175
+ interface DeleteCustomAdditionalFeesResponse {
2176
+ /** Draft order calculated with the latest changes. */
2177
+ calculatedDraftOrder?: CalculatedDraftOrder;
2178
+ }
2179
+ interface SetShippingInfoRequest {
2180
+ /**
2181
+ * Draft order ID.
2182
+ * @format GUID
2183
+ */
2184
+ draftOrderId: string;
2185
+ /**
2186
+ * Shipping info to set on the draft order.
2187
+ *
2188
+ * > **Note:** Passing an empty object will remove the existing shipping info.
2189
+ */
2190
+ shippingInfo?: V1ShippingInformation;
2191
+ }
2192
+ interface SetShippingInfoResponse {
2193
+ /** Draft order calculated with the latest changes. */
2194
+ calculatedDraftOrder?: CalculatedDraftOrder;
2195
+ }
2196
+ interface SetBuyerInfoRequest {
2197
+ /**
2198
+ * Draft order ID.
2199
+ * @format GUID
2200
+ */
2201
+ draftOrderId: string;
2202
+ /**
2203
+ * Shipping info to set on the draft order.
2204
+ *
2205
+ * > **Note:** Passing an empty object will remove the existing shipping info.
2206
+ */
2207
+ buyerInfo?: BuyerInfo;
2208
+ }
2209
+ interface SetBuyerInfoResponse {
2210
+ /** Draft order calculated with the latest changes. */
2211
+ calculatedDraftOrder?: CalculatedDraftOrder;
2212
+ }
2213
+ interface SetRecipientInfoRequest {
2214
+ /**
2215
+ * Draft order ID.
2216
+ * @format GUID
2217
+ */
2218
+ draftOrderId: string;
2219
+ /**
2220
+ * Recipient address and contact details.
2221
+ *
2222
+ * > **Note:** Passing an empty object will remove the existing recipient info.
2223
+ */
2224
+ recipientInfo?: AddressWithContact;
2225
+ }
2226
+ interface SetRecipientInfoResponse {
2227
+ /** Draft order calculated with the latest changes. */
2228
+ calculatedDraftOrder?: CalculatedDraftOrder;
2229
+ }
2230
+ interface SetBillingInfoRequest {
2231
+ /**
2232
+ * Draft order ID.
2233
+ * @format GUID
2234
+ */
2235
+ draftOrderId: string;
2236
+ /**
2237
+ * Billing address and contact details.
2238
+ *
2239
+ * > **Note:** Passing an empty object will remove the existing billing info.
2240
+ */
2241
+ billingInfo?: AddressWithContact;
2242
+ }
2243
+ interface SetBillingInfoResponse {
2244
+ /** Draft order calculated with the latest changes. */
2245
+ calculatedDraftOrder?: CalculatedDraftOrder;
2246
+ }
2247
+ interface GetDraftOrderRequest {
2248
+ /**
2249
+ * Draft order ID.
2250
+ * @format GUID
2251
+ */
2252
+ draftOrderId: string;
2253
+ }
2254
+ interface GetDraftOrderResponse {
2255
+ /** Draft order calculated with the latest changes. */
2256
+ calculatedDraftOrder?: CalculatedDraftOrder;
2257
+ }
2258
+ interface GetOrderDraftabilityStatusRequest {
2259
+ /**
2260
+ * Order ID.
2261
+ * @format GUID
2262
+ */
2263
+ orderId: string;
2264
+ }
2265
+ interface GetOrderDraftabilityStatusResponse {
2266
+ /**
2267
+ * Order ID.
2268
+ * @format GUID
2269
+ */
2270
+ orderId?: string;
2271
+ /** Whether a draft can be created based on the order. */
2272
+ orderDraftable?: boolean;
2273
+ /**
2274
+ * Reasons why a draft order cannot be created from the order.
2275
+ * @maxSize 5
2276
+ */
2277
+ nonDraftableReasons?: NonDraftableReasonWithLiterals[];
2278
+ }
2279
+ declare enum NonDraftableReason {
2280
+ UNSPECIFIED = "UNSPECIFIED",
2281
+ /** Modifications of refunded orders are not supported. */
2282
+ PARTIALLY_OR_FULLY_REFUNDED = "PARTIALLY_OR_FULLY_REFUNDED",
2283
+ /**
2284
+ * Original order must be created via one of the following channel types:
2285
+ * + WEB
2286
+ * + POS
2287
+ * + BACKOFFICE_MERCHANT
2288
+ * + WIX_APP_STORE
2289
+ */
2290
+ UNSUPPORTED_CHANNEL_TYPE = "UNSUPPORTED_CHANNEL_TYPE",
2291
+ /** Order status is not APPROVED. */
2292
+ ORDER_STATUS_IS_NOT_SUPPORTED = "ORDER_STATUS_IS_NOT_SUPPORTED",
2293
+ /** Site and order currencies are different. */
2294
+ ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT = "ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT",
2295
+ /** Site and order weight units are different. */
2296
+ ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT = "ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT",
2297
+ /** Order not found. */
2298
+ ORDER_NOT_FOUND = "ORDER_NOT_FOUND",
2299
+ /** Modifications of orders with subscription items are not supported. */
2300
+ SUBSCRIPTION_LINE_ITEM_EXISTS = "SUBSCRIPTION_LINE_ITEM_EXISTS"
2301
+ }
2302
+ /** @enumType */
2303
+ type NonDraftableReasonWithLiterals = NonDraftableReason | 'UNSPECIFIED' | 'PARTIALLY_OR_FULLY_REFUNDED' | 'UNSUPPORTED_CHANNEL_TYPE' | 'ORDER_STATUS_IS_NOT_SUPPORTED' | 'ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT' | 'ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT' | 'ORDER_NOT_FOUND' | 'SUBSCRIPTION_LINE_ITEM_EXISTS';
2304
+ interface CommitDraftOrderRequest {
2305
+ /**
2306
+ * Draft order ID.
2307
+ * @format GUID
2308
+ */
2309
+ draftOrderId: string;
2310
+ /** Optional side effects to trigger. */
2311
+ commitSettings?: DraftOrderCommitSettings;
2312
+ /**
2313
+ * Reason for edit, provided by user (optional).
2314
+ * @maxLength 200
2315
+ */
2316
+ reason?: string | null;
2317
+ }
2318
+ interface CommitDraftOrderResponse {
2319
+ /** Draft order after commit. */
2320
+ committedDraftOrder?: DraftOrder;
2321
+ /** Updated order after commit. */
2322
+ orderAfterCommit?: Order;
2323
+ }
2324
+ interface Order {
2325
+ /**
2326
+ * Order ID.
2327
+ * @format GUID
2328
+ * @readonly
2329
+ */
2330
+ id?: string | null;
2331
+ /**
2332
+ * Order number displayed in the site owner's dashboard (auto-generated).
2333
+ * @readonly
2334
+ */
2335
+ number?: string;
2336
+ /**
2337
+ * Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
2338
+ * @readonly
2339
+ * @immutable
2340
+ */
2341
+ createdDate?: Date | null;
2342
+ /**
2343
+ * Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
2344
+ * @readonly
2345
+ */
2346
+ updatedDate?: Date | null;
2347
+ /**
2348
+ * Order line items.
2349
+ * @minSize 1
2350
+ * @maxSize 300
2351
+ * @readonly
2352
+ */
2353
+ lineItems?: OrderLineItem[];
2354
+ /** Buyer information. */
2355
+ buyerInfo?: BuyerInfo;
2356
+ /** Order payment status. */
2357
+ paymentStatus?: PaymentStatusWithLiterals;
2358
+ /**
2359
+ * Order fulfillment status.
2360
+ * @readonly
2361
+ */
2362
+ fulfillmentStatus?: FulfillmentStatusWithLiterals;
2363
+ /**
2364
+ * Language for communication with the buyer. Defaults to the site language.
2365
+ * For a site that supports multiple languages, this is the language the buyer selected.
2366
+ */
2367
+ buyerLanguage?: string | null;
2368
+ /** Weight measurement unit - defaults to site's weight unit. */
2369
+ weightUnit?: WeightUnitWithLiterals;
2370
+ /**
2371
+ * Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
2372
+ * @format CURRENCY
2373
+ */
2374
+ currency?: string | null;
2375
+ /** Currency conversion details. For use with multi-currency sites. */
2376
+ currencyConversionDetails?: CurrencyConversionDetails;
2377
+ /**
2378
+ * Whether tax is included in line item prices.
2379
+ * @immutable
2380
+ */
2381
+ taxIncludedInPrices?: boolean;
2382
+ /**
2383
+ * Site language in which original values are shown.
2384
+ * @readonly
2385
+ * @immutable
2386
+ */
2387
+ siteLanguage?: string | null;
2388
+ /**
2389
+ * Order price summary.
2390
+ * @readonly
2391
+ */
2392
+ priceSummary?: PriceSummary;
2393
+ /** Billing address and contact details. */
2394
+ billingInfo?: AddressWithContact;
2395
+ /** Shipping info and selected shipping option details. */
2396
+ shippingInfo?: V1ShippingInformation;
2397
+ /**
2398
+ * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
2399
+ * @maxLength 1000
2400
+ */
2401
+ buyerNote?: string | null;
2402
+ /** Order status. */
2403
+ status?: OrderStatusWithLiterals;
2404
+ /** Whether order is archived. */
2405
+ archived?: boolean | null;
2406
+ /**
2407
+ * Tax summary.
2408
+ * Deprecated. Use `taxInfo` instead.
2409
+ * This field will be removed on September 30, 2024.
2410
+ * @deprecated Tax summary.
2411
+ * Deprecated. Use `taxInfo` instead.
2412
+ * This field will be removed on September 30, 2024.
2413
+ * @replacedBy tax_info
2414
+ * @targetRemovalDate 2024-09-30
2415
+ */
2416
+ taxSummary?: TaxSummary;
2417
+ /** Tax information. */
2418
+ taxInfo?: OrderTaxInfo;
2419
+ /**
2420
+ * Applied discounts.
2421
+ * @maxSize 320
2422
+ */
2423
+ appliedDiscounts?: AppliedDiscount[];
2424
+ /**
2425
+ * Order activities.
2426
+ * @readonly
2427
+ * @maxSize 1000
2428
+ */
2429
+ activities?: Activity[];
2430
+ /** Order attribution source. */
2431
+ attributionSource?: AttributionSourceWithLiterals;
2432
+ /**
2433
+ * ID of the order's initiator.
2434
+ * @readonly
2435
+ */
2436
+ createdBy?: V1CreatedBy;
2437
+ /** Information about the sales channel that submitted this order. */
2438
+ channelInfo?: ChannelInfo;
2439
+ /** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */
2440
+ seenByAHuman?: boolean | null;
2441
+ /**
2442
+ * Checkout ID.
2443
+ * @format GUID
2444
+ */
2445
+ checkoutId?: string | null;
2446
+ /** Custom fields. */
2447
+ customFields?: CustomField[];
2448
+ /**
2449
+ * Balance summary.
2450
+ * @readonly
2451
+ */
2452
+ balanceSummary?: V1BalanceSummary;
2453
+ /**
2454
+ * Additional fees applied to the order.
2455
+ * @maxSize 100
2456
+ */
2457
+ additionalFees?: AdditionalFee[];
2458
+ /**
2459
+ * Custom field data for the order object.
2460
+ *
2461
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
2462
+ */
2463
+ extendedFields?: ExtendedFields;
2464
+ /**
2465
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
2466
+ * @format GUID
2467
+ */
2468
+ purchaseFlowId?: string | null;
2469
+ /**
2470
+ * Order recipient address and contact details.
2471
+ *
2472
+ * This field may differ from the address in `shippingInfo.logistics` when:
2473
+ * + The chosen shipping option is pickup point or store pickup.
2474
+ * + No shipping option is selected.
2475
+ */
2476
+ recipientInfo?: AddressWithContact;
2477
+ /**
2478
+ * Order tags.
2479
+ *
2480
+ * [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction) are labels attached to entities, allowing for flexible categorization and data management.
2481
+ */
2482
+ tags?: Tags;
2483
+ /**
2484
+ * Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
2485
+ * Used for migration from external systems.
2486
+ * @immutable
2487
+ */
2488
+ purchasedDate?: Date | null;
2489
+ /** Order Location */
2490
+ businessLocation?: Location;
2491
+ /**
2492
+ * Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
2493
+ * @readonly
2494
+ */
2495
+ payAfterFreeTrial?: PriceSummary;
2496
+ }
2497
+ declare enum PaymentStatus {
2498
+ UNSPECIFIED = "UNSPECIFIED",
2499
+ /**
2500
+ * `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
2501
+ * This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`.
2502
+ */
2503
+ NOT_PAID = "NOT_PAID",
2504
+ /** All required payments associated with this order are paid. */
2505
+ PAID = "PAID",
2506
+ /** Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details. */
2507
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
2508
+ /** Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details. */
2509
+ FULLY_REFUNDED = "FULLY_REFUNDED",
2510
+ /**
2511
+ * All payments pending.
2512
+ *
2513
+ * This can happen with two-step payments, when a payment requires manual review, or when a payment is in progress and will be concluded shortly.
2514
+ * Learn more about [pending orders](https://support.wix.com/en/article/pending-orders).
2515
+ */
2516
+ PENDING = "PENDING",
2517
+ /** At least one payment received and approved, but it covers less than the order's total price. See `order.balanceSummary` for more details. */
2518
+ PARTIALLY_PAID = "PARTIALLY_PAID",
2519
+ /**
2520
+ * Payment received, but not yet confirmed by the payment provider.
2521
+ *
2522
+ * In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner.
2523
+ * To solve this, the merchant/site owner should log in to the payment provider's dashboard and make sure their account is set up correctly, or contact their support for further assistance.
2524
+ * @documentationMaturity preview
2525
+ */
2526
+ PENDING_MERCHANT = "PENDING_MERCHANT",
2527
+ /**
2528
+ * One or more payments canceled.
2529
+ * @documentationMaturity preview
2530
+ */
2531
+ CANCELED = "CANCELED",
2532
+ /**
2533
+ * One or more payments declined.
2534
+ * @documentationMaturity preview
2535
+ */
2536
+ DECLINED = "DECLINED"
2537
+ }
2538
+ /** @enumType */
2539
+ type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PENDING' | 'PARTIALLY_PAID' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED';
2540
+ declare enum FulfillmentStatus {
2541
+ /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
2542
+ NOT_FULFILLED = "NOT_FULFILLED",
2543
+ /**
2544
+ * All of the order items are fulfilled or the order was manually marked as fulfilled.
2545
+ * Orders without shipping info are fulfilled automatically.
2546
+ */
2547
+ FULFILLED = "FULFILLED",
2548
+ /** Some, but not all, of the order items are fulfilled. */
2549
+ PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
2550
+ }
2551
+ /** @enumType */
2552
+ type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'PARTIALLY_FULFILLED';
2553
+ interface CurrencyConversionDetails {
2554
+ /**
2555
+ * Currency used for the pricing of this order, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
2556
+ *
2557
+ * This currency is used to calculate the pricing before conversion to the buyer's payment currency.
2558
+ * @readonly
2559
+ * @immutable
2560
+ * @format CURRENCY
2561
+ */
2562
+ originalCurrency?: string | null;
2563
+ /**
2564
+ * The rate used for converting the original currency to the currency used for payment.
2565
+ * @readonly
2566
+ * @immutable
2567
+ * @decimalValue options { gt:0, lte:1000000000000000 }
2568
+ */
2569
+ conversionRate?: string | null;
2570
+ }
2571
+ declare enum OrderStatus {
2572
+ /** Order created, but not yet approved or canceled. */
2573
+ INITIALIZED = "INITIALIZED",
2574
+ /**
2575
+ * Order approved.
2576
+ *
2577
+ * This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order).
2578
+ * Offline orders (cash payment) are automatically approved.
2579
+ */
2580
+ APPROVED = "APPROVED",
2581
+ /** Order canceled by the user. */
2582
+ CANCELED = "CANCELED",
2583
+ /**
2584
+ * Order pending.
2585
+ * @documentationMaturity preview
2586
+ */
2587
+ PENDING = "PENDING",
2588
+ /**
2589
+ * Order rejected.
2590
+ *
2591
+ * This happens when pending payments fail.
2592
+ * @documentationMaturity preview
2593
+ */
2594
+ REJECTED = "REJECTED"
2595
+ }
2596
+ /** @enumType */
2597
+ type OrderStatusWithLiterals = OrderStatus | 'INITIALIZED' | 'APPROVED' | 'CANCELED' | 'PENDING' | 'REJECTED';
2598
+ interface Activity extends ActivityContentOneOf {
2599
+ /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
2600
+ customActivity?: CustomActivity;
2601
+ /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
2602
+ merchantComment?: MerchantComment;
2603
+ /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
2604
+ orderRefunded?: OrderRefunded;
2605
+ /**
2606
+ * Activity ID.
2607
+ * @format GUID
2608
+ * @readonly
2609
+ */
2610
+ id?: string | null;
2611
+ /**
2612
+ * Activity author's email.
2613
+ * @format EMAIL
2614
+ * @readonly
2615
+ */
2616
+ authorEmail?: string | null;
2617
+ /**
2618
+ * Activity creation date and time.
2619
+ * @readonly
2620
+ */
2621
+ createdDate?: Date | null;
2622
+ /** Activity type. */
2623
+ type?: ActivityTypeWithLiterals;
2624
+ }
2625
+ /** @oneof */
2626
+ interface ActivityContentOneOf {
2627
+ /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
2628
+ customActivity?: CustomActivity;
2629
+ /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
2630
+ merchantComment?: MerchantComment;
2631
+ /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
2632
+ orderRefunded?: OrderRefunded;
2633
+ }
2634
+ interface CustomActivity {
2635
+ /**
2636
+ * ID of the app that created the custom activity.
2637
+ * @format GUID
2638
+ */
2639
+ appId?: string;
2640
+ /**
2641
+ * Custom activity type. For example, `"Ticket number set"`.
2642
+ * @maxLength 100
2643
+ */
2644
+ type?: string;
2645
+ /** Additional data in key-value form. For example, `{ "Ticket number": "123456" }`. */
2646
+ additionalData?: Record<string, string>;
2647
+ }
2648
+ /** Store owner added a comment */
2649
+ interface MerchantComment {
2650
+ /**
2651
+ * Merchant comment message.
2652
+ * @minLength 1
2653
+ * @maxLength 5000
2654
+ */
2655
+ message?: string;
2656
+ }
2657
+ interface OrderRefunded {
2658
+ /** Whether order was refunded manually. For example, via payment provider or using cash. */
2659
+ manual?: boolean;
2660
+ /** Refund amount. */
2661
+ amount?: Price;
2662
+ /**
2663
+ * Reason for refund.
2664
+ * @maxLength 200
2665
+ */
2666
+ reason?: string;
2667
+ }
2668
+ declare enum ActivityType {
2669
+ ORDER_REFUNDED = "ORDER_REFUNDED",
2670
+ ORDER_PLACED = "ORDER_PLACED",
2671
+ ORDER_PAID = "ORDER_PAID",
2672
+ ORDER_FULFILLED = "ORDER_FULFILLED",
2673
+ ORDER_NOT_FULFILLED = "ORDER_NOT_FULFILLED",
2674
+ ORDER_CANCELED = "ORDER_CANCELED",
2675
+ DOWNLOAD_LINK_SENT = "DOWNLOAD_LINK_SENT",
2676
+ TRACKING_NUMBER_ADDED = "TRACKING_NUMBER_ADDED",
2677
+ TRACKING_NUMBER_EDITED = "TRACKING_NUMBER_EDITED",
2678
+ TRACKING_LINK_ADDED = "TRACKING_LINK_ADDED",
2679
+ SHIPPING_CONFIRMATION_EMAIL_SENT = "SHIPPING_CONFIRMATION_EMAIL_SENT",
2680
+ INVOICE_ADDED = "INVOICE_ADDED",
2681
+ INVOICE_REMOVED = "INVOICE_REMOVED",
2682
+ INVOICE_SENT = "INVOICE_SENT",
2683
+ FULFILLER_EMAIL_SENT = "FULFILLER_EMAIL_SENT",
2684
+ SHIPPING_ADDRESS_EDITED = "SHIPPING_ADDRESS_EDITED",
2685
+ EMAIL_EDITED = "EMAIL_EDITED",
2686
+ PICKUP_READY_EMAIL_SENT = "PICKUP_READY_EMAIL_SENT",
2687
+ CUSTOM_ACTIVITY = "CUSTOM_ACTIVITY",
2688
+ MERCHANT_COMMENT = "MERCHANT_COMMENT",
2689
+ ORDER_CREATED_FROM_EXCHANGE = "ORDER_CREATED_FROM_EXCHANGE",
2690
+ NEW_EXCHANGE_ORDER_CREATED = "NEW_EXCHANGE_ORDER_CREATED",
2691
+ ORDER_PARTIALLY_PAID = "ORDER_PARTIALLY_PAID",
2692
+ DRAFT_ORDER_CHANGES_APPLIED = "DRAFT_ORDER_CHANGES_APPLIED",
2693
+ SAVED_PAYMENT_METHOD = "SAVED_PAYMENT_METHOD",
2694
+ /** @documentationMaturity preview */
2695
+ PAYMENT_PENDING = "PAYMENT_PENDING",
2696
+ /** @documentationMaturity preview */
2697
+ PAYMENT_CANCELED = "PAYMENT_CANCELED",
2698
+ /** @documentationMaturity preview */
2699
+ PAYMENT_DECLINED = "PAYMENT_DECLINED",
2700
+ /** @documentationMaturity preview */
2701
+ ORDER_PENDING = "ORDER_PENDING",
2702
+ /** @documentationMaturity preview */
2703
+ ORDER_REJECTED = "ORDER_REJECTED"
2704
+ }
2705
+ /** @enumType */
2706
+ type ActivityTypeWithLiterals = ActivityType | 'ORDER_REFUNDED' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'ORDER_CANCELED' | 'DOWNLOAD_LINK_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_ADDED' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_ADDED' | 'INVOICE_REMOVED' | 'INVOICE_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'PICKUP_READY_EMAIL_SENT' | 'CUSTOM_ACTIVITY' | 'MERCHANT_COMMENT' | 'ORDER_CREATED_FROM_EXCHANGE' | 'NEW_EXCHANGE_ORDER_CREATED' | 'ORDER_PARTIALLY_PAID' | 'DRAFT_ORDER_CHANGES_APPLIED' | 'SAVED_PAYMENT_METHOD' | 'PAYMENT_PENDING' | 'PAYMENT_CANCELED' | 'PAYMENT_DECLINED' | 'ORDER_PENDING' | 'ORDER_REJECTED';
2707
+ declare enum AttributionSource {
2708
+ UNSPECIFIED = "UNSPECIFIED",
2709
+ FACEBOOK_ADS = "FACEBOOK_ADS"
2710
+ }
2711
+ /** @enumType */
2712
+ type AttributionSourceWithLiterals = AttributionSource | 'UNSPECIFIED' | 'FACEBOOK_ADS';
2713
+ interface V1CreatedBy extends V1CreatedByStringOneOf {
2714
+ /**
2715
+ * User ID - when the order was created by a Wix user on behalf of a buyer.
2716
+ * For example, via POS (point of service).
2717
+ * @format GUID
2718
+ */
2719
+ userId?: string;
2720
+ /**
2721
+ * Member ID - when the order was created by a **logged in** site visitor.
2722
+ * @format GUID
2723
+ */
2724
+ memberId?: string;
2725
+ /**
2726
+ * Visitor ID - when the order was created by a site visitor that was **not** logged in.
2727
+ * @format GUID
2728
+ */
2729
+ visitorId?: string;
2730
+ /**
2731
+ * App ID - when the order was created by an external application.
2732
+ * @format GUID
2733
+ */
2734
+ appId?: string;
2735
+ }
2736
+ /** @oneof */
2737
+ interface V1CreatedByStringOneOf {
2738
+ /**
2739
+ * User ID - when the order was created by a Wix user on behalf of a buyer.
2740
+ * For example, via POS (point of service).
2741
+ * @format GUID
2742
+ */
2743
+ userId?: string;
2744
+ /**
2745
+ * Member ID - when the order was created by a **logged in** site visitor.
2746
+ * @format GUID
2747
+ */
2748
+ memberId?: string;
2749
+ /**
2750
+ * Visitor ID - when the order was created by a site visitor that was **not** logged in.
2751
+ * @format GUID
2752
+ */
2753
+ visitorId?: string;
2754
+ /**
2755
+ * App ID - when the order was created by an external application.
2756
+ * @format GUID
2757
+ */
2758
+ appId?: string;
2759
+ }
2760
+ interface ChannelInfo {
2761
+ /** Sales channel that submitted the order. */
2762
+ type?: ChannelTypeWithLiterals;
2763
+ /**
2764
+ * Reference to an order ID from an external system.
2765
+ * @maxLength 100
2766
+ */
2767
+ externalOrderId?: string | null;
2768
+ /**
2769
+ * URL to the order in the external system.
2770
+ * @maxLength 300
2771
+ */
2772
+ externalOrderUrl?: string | null;
2773
+ }
2774
+ declare enum ChannelType {
2775
+ /** Unspecified sales channel. This value is not supported. */
2776
+ UNSPECIFIED = "UNSPECIFIED",
2777
+ /** A web client. */
2778
+ WEB = "WEB",
2779
+ /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */
2780
+ POS = "POS",
2781
+ /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */
2782
+ EBAY = "EBAY",
2783
+ /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */
2784
+ AMAZON = "AMAZON",
2785
+ /** Other sales platform. */
2786
+ OTHER_PLATFORM = "OTHER_PLATFORM",
2787
+ /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */
2788
+ WIX_APP_STORE = "WIX_APP_STORE",
2789
+ /** Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings) */
2790
+ WIX_INVOICES = "WIX_INVOICES",
2791
+ /** Wix merchant backoffice. */
2792
+ BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
2793
+ /** Wish sales channel. */
2794
+ WISH = "WISH",
2795
+ /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */
2796
+ CLASS_PASS = "CLASS_PASS",
2797
+ /** Global-E sales channel. */
2798
+ GLOBAL_E = "GLOBAL_E",
2799
+ /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */
2800
+ FACEBOOK = "FACEBOOK",
2801
+ /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */
2802
+ ETSY = "ETSY",
2803
+ /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */
2804
+ TIKTOK = "TIKTOK",
2805
+ /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
2806
+ FAIRE_COM = "FAIRE_COM"
2807
+ }
2808
+ /** @enumType */
2809
+ type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
2810
+ interface CustomField {
2811
+ /** Custom field value. */
2812
+ value?: any;
2813
+ /**
2814
+ * Custom field title.
2815
+ * @minLength 1
2816
+ * @maxLength 500
2817
+ */
2818
+ title?: string;
2819
+ /**
2820
+ * Translated custom field title.
2821
+ * @minLength 1
2822
+ * @maxLength 500
2823
+ */
2824
+ translatedTitle?: string | null;
2825
+ }
2826
+ interface V1BalanceSummary {
2827
+ /**
2828
+ * Current amount left to pay.
2829
+ * @readonly
2830
+ */
2831
+ balance?: Balance;
2832
+ /**
2833
+ * Sum of all approved and successful payments.
2834
+ *
2835
+ * The value includes payments that have subsequently been fully or partially refunded.
2836
+ * @readonly
2837
+ */
2838
+ paid?: Price;
2839
+ /**
2840
+ * Sum of all successfully refunded payments.
2841
+ * @readonly
2842
+ */
2843
+ refunded?: Price;
2844
+ /**
2845
+ * Sum of all authorized payments.
2846
+ * @readonly
2847
+ */
2848
+ authorized?: Price;
2849
+ /**
2850
+ * Sum of all pending transactions.
2851
+ * @readonly
2852
+ */
2853
+ pending?: Price;
2854
+ }
2855
+ /**
2856
+ * Common object for tags.
2857
+ * Should be use as in this example:
2858
+ * message Foo {
2859
+ * string id = 1;
2860
+ * ...
2861
+ * Tags tags = 5
2862
+ * }
2863
+ *
2864
+ * example of taggable entity
2865
+ * {
2866
+ * id: "123"
2867
+ * tags: {
2868
+ * tags: {
2869
+ * tag_ids:["11","22"]
2870
+ * },
2871
+ * private_tags: {
2872
+ * tag_ids: ["33", "44"]
2873
+ * }
2874
+ * }
2875
+ * }
2876
+ */
2877
+ interface Tags {
2878
+ /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
2879
+ privateTags?: TagList;
2880
+ /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
2881
+ tags?: TagList;
2882
+ }
2883
+ interface TagList {
2884
+ /**
2885
+ * List of tag IDs
2886
+ * @maxSize 100
2887
+ * @maxLength 5
2888
+ */
2889
+ tagIds?: string[];
2890
+ }
2891
+ interface CreateOrderFromDraftRequest {
2892
+ /**
2893
+ * Draft order ID.
2894
+ * @format GUID
2895
+ */
2896
+ draftOrderId: string;
2897
+ /** Optional side effects to trigger. */
2898
+ createSettings?: OrderCreateSettings;
2899
+ /**
2900
+ * Reason for order creation, provided by user (optional).
2901
+ * @maxLength 200
2902
+ */
2903
+ reason?: string | null;
2904
+ /** Information about the sales channel that submitted this order. */
2905
+ channelInfo?: ChannelInfo;
2906
+ }
2907
+ interface OrderCreateSettings {
2908
+ /** Notification settings to be applied on order creation */
2909
+ notifications?: OrderCreateNotifications;
2910
+ }
2911
+ interface OrderCreateNotifications {
2912
+ /**
2913
+ * Whether to send notification to the buyer.
2914
+ *
2915
+ * Default: `true`
2916
+ */
2917
+ sendNotificationToBuyer?: boolean | null;
2918
+ /**
2919
+ * Whether to send notifications to the business.
2920
+ *
2921
+ * Default: `true`
2922
+ */
2923
+ sendNotificationsToBusiness?: boolean | null;
2924
+ }
2925
+ interface CreateOrderFromDraftResponse {
2926
+ /** Draft order after commit. */
2927
+ committedDraftOrder?: DraftOrder;
2928
+ /** Created order. */
2929
+ createdOrder?: Order;
2930
+ }
2931
+ interface DeleteDraftOrderRequest {
2932
+ /**
2933
+ * Draft order ID.
2934
+ * @format GUID
2935
+ */
2936
+ draftOrderId: string;
2937
+ }
2938
+ interface DeleteDraftOrderResponse {
2939
+ }
2940
+ interface QueryDraftOrdersRequest {
2941
+ /** Query options. */
2942
+ query?: CursorQuery;
2943
+ }
2944
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
2945
+ /**
2946
+ * Cursor paging options.
2947
+ *
2948
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2949
+ */
2950
+ cursorPaging?: CursorPaging;
2951
+ /**
2952
+ * Filter object.
2953
+ *
2954
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2955
+ */
2956
+ filter?: Record<string, any> | null;
2957
+ /**
2958
+ * Sort object.
2959
+ *
2960
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2961
+ * @maxSize 5
2962
+ */
2963
+ sort?: Sorting[];
2964
+ }
2965
+ /** @oneof */
2966
+ interface CursorQueryPagingMethodOneOf {
2967
+ /**
2968
+ * Cursor paging options.
2969
+ *
2970
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2971
+ */
2972
+ cursorPaging?: CursorPaging;
2973
+ }
2974
+ interface Sorting {
2975
+ /**
2976
+ * Name of the field to sort by.
2977
+ * @maxLength 512
2978
+ */
2979
+ fieldName?: string;
2980
+ /** Sort order. */
2981
+ order?: SortOrderWithLiterals;
2982
+ }
2983
+ declare enum SortOrder {
2984
+ ASC = "ASC",
2985
+ DESC = "DESC"
2986
+ }
2987
+ /** @enumType */
2988
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
2989
+ interface CursorPaging {
2990
+ /**
2991
+ * Maximum number of items to return in the results.
2992
+ * @max 100
2993
+ */
2994
+ limit?: number | null;
2995
+ /**
2996
+ * Pointer to the next or previous page in the list of results.
2997
+ *
2998
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2999
+ * Not relevant for the first request.
3000
+ * @maxLength 16000
3001
+ */
3002
+ cursor?: string | null;
3003
+ }
3004
+ interface QueryDraftOrdersResponse {
3005
+ /** Draft orders, found by query. */
3006
+ draftOrders?: DraftOrder[];
3007
+ /** Paging metadata. */
3008
+ pagingMetadata?: CursorPagingMetadata;
3009
+ }
3010
+ interface CursorPagingMetadata {
3011
+ /** Number of items returned in current page. */
3012
+ count?: number | null;
3013
+ /** Cursor strings that point to the next page, previous page, or both. */
3014
+ cursors?: Cursors;
3015
+ /**
3016
+ * Whether there are more pages to retrieve following the current page.
3017
+ *
3018
+ * + `true`: Another page of results can be retrieved.
3019
+ * + `false`: This is the last page.
3020
+ */
3021
+ hasNext?: boolean | null;
3022
+ }
3023
+ interface Cursors {
3024
+ /**
3025
+ * Cursor string pointing to the next page in the list of results.
3026
+ * @maxLength 16000
3027
+ */
3028
+ next?: string | null;
3029
+ /**
3030
+ * Cursor pointing to the previous page in the list of results.
3031
+ * @maxLength 16000
3032
+ */
3033
+ prev?: string | null;
3034
+ }
3035
+ interface UpdateExtendedFieldsRequest {
3036
+ /** ID of the entity to update. */
3037
+ id: string;
3038
+ /** Identifier for the app whose extended fields are being updated. */
3039
+ namespace: string;
3040
+ /** 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. */
3041
+ namespaceData: Record<string, any> | null;
3042
+ }
3043
+ interface UpdateExtendedFieldsResponse {
3044
+ /** Updated draft order. */
3045
+ draftOrder?: DraftOrder;
3046
+ }
3047
+ interface SetTaxExemptionRequest {
3048
+ /**
3049
+ * Draft order ID.
3050
+ * @format GUID
3051
+ */
3052
+ draftOrderId: string;
3053
+ /**
3054
+ * Whether the draft order is exempt from tax calculations.
3055
+ *
3056
+ * Default: `false`
3057
+ */
3058
+ taxExempt: boolean | null;
3059
+ }
3060
+ interface SetTaxExemptionResponse {
3061
+ /** Draft order calculated with the latest changes. */
3062
+ calculatedDraftOrder?: CalculatedDraftOrder;
3063
+ }
3064
+ interface SetBusinessLocationRequest {
3065
+ /**
3066
+ * Draft order ID.
3067
+ * @format GUID
3068
+ */
3069
+ draftOrderId: string;
3070
+ /** Business location. */
3071
+ businessLocation?: Location;
3072
+ }
3073
+ interface SetBusinessLocationResponse {
3074
+ /** Draft order calculated with the latest changes. */
3075
+ calculatedDraftOrder?: CalculatedDraftOrder;
3076
+ }
3077
+
3078
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
3079
+ getUrl: (context: any) => string;
3080
+ httpMethod: K;
3081
+ path: string;
3082
+ pathParams: M;
3083
+ __requestType: T;
3084
+ __originalRequestType: S;
3085
+ __responseType: Q;
3086
+ __originalResponseType: R;
3087
+ };
3088
+ declare function createDraftOrder(): __PublicMethodMetaInfo<'POST', {}, CreateDraftOrderRequest$1, CreateDraftOrderRequest, CreateDraftOrderResponse$1, CreateDraftOrderResponse>;
3089
+ declare function createEmptyDraftOrder(): __PublicMethodMetaInfo<'POST', {}, CreateEmptyDraftOrderRequest$1, CreateEmptyDraftOrderRequest, CreateEmptyDraftOrderResponse$1, CreateEmptyDraftOrderResponse>;
3090
+ declare function addLineItemsToDraftOrder(): __PublicMethodMetaInfo<'POST', {
3091
+ draftOrderId: string;
3092
+ }, AddLineItemsToDraftOrderRequest$1, AddLineItemsToDraftOrderRequest, AddLineItemsToDraftOrderResponse$1, AddLineItemsToDraftOrderResponse>;
3093
+ declare function updateLineItems(): __PublicMethodMetaInfo<'POST', {
3094
+ draftOrderId: string;
3095
+ }, UpdateLineItemsRequest$1, UpdateLineItemsRequest, UpdateLineItemsResponse$1, UpdateLineItemsResponse>;
3096
+ declare function setDiscounts(): __PublicMethodMetaInfo<'POST', {
3097
+ draftOrderId: string;
3098
+ }, SetDiscountsRequest$1, SetDiscountsRequest, SetDiscountsResponse$1, SetDiscountsResponse>;
3099
+ declare function createCustomDiscounts(): __PublicMethodMetaInfo<'POST', {
3100
+ draftOrderId: string;
3101
+ }, CreateCustomDiscountsRequest$1, CreateCustomDiscountsRequest, CreateCustomDiscountsResponse$1, CreateCustomDiscountsResponse>;
3102
+ declare function deleteCustomDiscounts(): __PublicMethodMetaInfo<'POST', {
3103
+ draftOrderId: string;
3104
+ }, DeleteCustomDiscountsRequest$1, DeleteCustomDiscountsRequest, DeleteCustomDiscountsResponse$1, DeleteCustomDiscountsResponse>;
3105
+ declare function setAdditionalFees(): __PublicMethodMetaInfo<'POST', {
3106
+ draftOrderId: string;
3107
+ }, SetAdditionalFeesRequest$1, SetAdditionalFeesRequest, SetAdditionalFeesResponse$1, SetAdditionalFeesResponse>;
3108
+ declare function createCustomAdditionalFees(): __PublicMethodMetaInfo<'POST', {
3109
+ draftOrderId: string;
3110
+ }, CreateCustomAdditionalFeesRequest$1, CreateCustomAdditionalFeesRequest, CreateCustomAdditionalFeesResponse$1, CreateCustomAdditionalFeesResponse>;
3111
+ declare function deleteCustomAdditionalFees(): __PublicMethodMetaInfo<'POST', {
3112
+ draftOrderId: string;
3113
+ }, DeleteCustomAdditionalFeesRequest$1, DeleteCustomAdditionalFeesRequest, DeleteCustomAdditionalFeesResponse$1, DeleteCustomAdditionalFeesResponse>;
3114
+ declare function setShippingInfo(): __PublicMethodMetaInfo<'PUT', {}, SetShippingInfoRequest$1, SetShippingInfoRequest, SetShippingInfoResponse$1, SetShippingInfoResponse>;
3115
+ declare function setBuyerInfo(): __PublicMethodMetaInfo<'PUT', {}, SetBuyerInfoRequest$1, SetBuyerInfoRequest, SetBuyerInfoResponse$1, SetBuyerInfoResponse>;
3116
+ declare function setRecipientInfo(): __PublicMethodMetaInfo<'PUT', {}, SetRecipientInfoRequest$1, SetRecipientInfoRequest, SetRecipientInfoResponse$1, SetRecipientInfoResponse>;
3117
+ declare function setBillingInfo(): __PublicMethodMetaInfo<'PUT', {}, SetBillingInfoRequest$1, SetBillingInfoRequest, SetBillingInfoResponse$1, SetBillingInfoResponse>;
3118
+ declare function getDraftOrder(): __PublicMethodMetaInfo<'GET', {
3119
+ draftOrderId: string;
3120
+ }, GetDraftOrderRequest$1, GetDraftOrderRequest, GetDraftOrderResponse$1, GetDraftOrderResponse>;
3121
+ declare function getOrderDraftabilityStatus(): __PublicMethodMetaInfo<'GET', {
3122
+ orderId: string;
3123
+ }, GetOrderDraftabilityStatusRequest$1, GetOrderDraftabilityStatusRequest, GetOrderDraftabilityStatusResponse$1, GetOrderDraftabilityStatusResponse>;
3124
+ declare function commitDraftOrder(): __PublicMethodMetaInfo<'POST', {
3125
+ draftOrderId: string;
3126
+ }, CommitDraftOrderRequest$1, CommitDraftOrderRequest, CommitDraftOrderResponse$1, CommitDraftOrderResponse>;
3127
+ declare function createOrderFromDraft(): __PublicMethodMetaInfo<'POST', {
3128
+ draftOrderId: string;
3129
+ }, CreateOrderFromDraftRequest$1, CreateOrderFromDraftRequest, CreateOrderFromDraftResponse$1, CreateOrderFromDraftResponse>;
3130
+ declare function deleteDraftOrder(): __PublicMethodMetaInfo<'DELETE', {
3131
+ draftOrderId: string;
3132
+ }, DeleteDraftOrderRequest$1, DeleteDraftOrderRequest, DeleteDraftOrderResponse$1, DeleteDraftOrderResponse>;
3133
+ declare function queryDraftOrders(): __PublicMethodMetaInfo<'POST', {}, QueryDraftOrdersRequest$1, QueryDraftOrdersRequest, QueryDraftOrdersResponse$1, QueryDraftOrdersResponse>;
3134
+ declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', {
3135
+ id: string;
3136
+ }, UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse$1, UpdateExtendedFieldsResponse>;
3137
+ declare function setTaxExemption(): __PublicMethodMetaInfo<'PUT', {}, SetTaxExemptionRequest$1, SetTaxExemptionRequest, SetTaxExemptionResponse$1, SetTaxExemptionResponse>;
3138
+ declare function setBusinessLocation(): __PublicMethodMetaInfo<'PUT', {}, SetBusinessLocationRequest$1, SetBusinessLocationRequest, SetBusinessLocationResponse$1, SetBusinessLocationResponse>;
3139
+
3140
+ export { type __PublicMethodMetaInfo, addLineItemsToDraftOrder, commitDraftOrder, createCustomAdditionalFees, createCustomDiscounts, createDraftOrder, createEmptyDraftOrder, createOrderFromDraft, deleteCustomAdditionalFees, deleteCustomDiscounts, deleteDraftOrder, getDraftOrder, getOrderDraftabilityStatus, queryDraftOrders, setAdditionalFees, setBillingInfo, setBusinessLocation, setBuyerInfo, setDiscounts, setRecipientInfo, setShippingInfo, setTaxExemption, updateExtendedFields, updateLineItems };