@wix/auto_sdk_ecom_draft-orders 1.0.17 → 1.0.19

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-Ch0BEnrn.d.mts} +423 -831
  2. package/build/{cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-Ch0BEnrn.d.ts} +423 -831
  3. package/build/index.d.mts +232 -0
  4. package/build/index.d.ts +232 -0
  5. package/build/index.js +4593 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +4520 -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-B5CD1SEk.d.mts} +885 -1096
  10. package/build/internal/{es/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-B5CD1SEk.d.ts} +885 -1096
  11. package/build/internal/index.d.mts +232 -0
  12. package/build/internal/index.d.ts +232 -0
  13. package/build/internal/index.js +4593 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +4520 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +2751 -0
  18. package/build/internal/meta.d.ts +2751 -0
  19. package/build/internal/meta.js +3323 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +3275 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +2751 -0
  24. package/build/meta.d.ts +2751 -0
  25. package/build/meta.js +3323 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +3275 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  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 -26
  40. package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js +0 -57
  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 -97
  43. package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js +0 -2951
  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 -60
  46. package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +0 -446
  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 -209
  49. package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js +0 -168
  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 -360
  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 -4562
  54. package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1943
  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 -26
  67. package/build/es/src/ecom-v1-draft-order-draft-orders.context.js +0 -26
  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 -97
  70. package/build/es/src/ecom-v1-draft-order-draft-orders.http.js +0 -2926
  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 -60
  73. package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js +0 -398
  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 -209
  76. package/build/es/src/ecom-v1-draft-order-draft-orders.public.js +0 -114
  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 -357
  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 -4562
  81. package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1895
  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 -26
  93. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js +0 -57
  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 -97
  96. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js +0 -2951
  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 -60
  99. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +0 -446
  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 -209
  102. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js +0 -168
  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 -360
  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 -5285
  107. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1943
  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 -26
  119. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js +0 -26
  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 -97
  122. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js +0 -2926
  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 -60
  125. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js +0 -398
  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 -209
  128. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js +0 -114
  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 -357
  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 -5285
  133. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1895
  134. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
@@ -1,4562 +0,0 @@
1
- /** DraftOrder is the main entity of DraftOrders service. It represents a single edit order. */
2
- export interface DraftOrder {
3
- /**
4
- * Draft order ID.
5
- * @format GUID
6
- * @readonly
7
- */
8
- _id?: string | null;
9
- /**
10
- * ID of the order this draft commits to.
11
- * @format GUID
12
- */
13
- orderId?: string | null;
14
- /**
15
- * Line items.
16
- * Includes details about changes when relevant.
17
- * @minSize 1
18
- * @maxSize 300
19
- */
20
- lineItems?: ItemDetails[];
21
- /**
22
- * Shipping info.
23
- * Includes details about changes when relevant.
24
- */
25
- shippingInfo?: ShippingDetails;
26
- /**
27
- * Buyer information.
28
- * @deprecated Buyer information.
29
- * @replacedBy buyer_info_details
30
- * @targetRemovalDate 2024-08-30
31
- */
32
- buyerInfo?: BuyerInfo;
33
- /**
34
- * Billing address and contact details.
35
- * @deprecated Billing address and contact details.
36
- * @replacedBy billing_info_details
37
- * @targetRemovalDate 2024-08-30
38
- */
39
- billingInfo?: AddressWithContact;
40
- /**
41
- * Additional fees.
42
- * Includes details about the source, and whether the additional fee is applied to the order.
43
- * @maxSize 100
44
- */
45
- additionalFees?: AdditionalFeeDetails[];
46
- /**
47
- * Discounts.
48
- * Includes details about the source, and whether the discount is applied to the order.
49
- * @maxSize 320
50
- */
51
- discounts?: DiscountDetails[];
52
- /**
53
- * Date and time the draft order was created.
54
- * @readonly
55
- */
56
- _createdDate?: Date | null;
57
- /**
58
- * Date and time the draft order was updated.
59
- * @readonly
60
- */
61
- _updatedDate?: Date | null;
62
- /**
63
- * Identity of the draft order's initiator.
64
- * @readonly
65
- */
66
- createdBy?: CreatedBy;
67
- /**
68
- * Draft order status.
69
- * @readonly
70
- */
71
- status?: EditingStatus;
72
- /** Weight measurement unit. Defaults to the site's weight unit. */
73
- weightUnit?: WeightUnit;
74
- /**
75
- * Currency used for pricing.
76
- * @format CURRENCY
77
- */
78
- currency?: string | null;
79
- /**
80
- * Price summary.
81
- * @readonly
82
- */
83
- priceSummary?: PriceSummary;
84
- /**
85
- * Deprecated. Use `taxInfo` instead.
86
- * This field will be removed on September 30, 2024.
87
- * Tax summary.
88
- * @readonly
89
- * @deprecated Deprecated. Use `taxInfo` instead.
90
- * This field will be removed on September 30, 2024.
91
- * Tax summary.
92
- * @replacedBy tax_info
93
- * @targetRemovalDate 2024-09-30
94
- */
95
- taxSummary?: TaxSummary;
96
- /**
97
- * Balance summary.
98
- * @readonly
99
- */
100
- balanceSummary?: BalanceSummary;
101
- /** Side effects to perform on commit. */
102
- commitSettings?: DraftOrderCommitSettings;
103
- /**
104
- * Member ID (if order created by a member).
105
- * @format GUID
106
- */
107
- memberId?: string | null;
108
- /**
109
- * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
110
- * @format GUID
111
- */
112
- purchaseFlowId?: string | null;
113
- recipientInfo?: RecipientInfoDetails;
114
- /**
115
- * Custom field data for the draft order object.
116
- * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
117
- */
118
- extendedFields?: ExtendedFields;
119
- /**
120
- * Order business location
121
- * Includes details about changes when relevant.
122
- */
123
- businessLocationDetails?: BusinessLocationDetails;
124
- }
125
- export interface ItemDetails extends ItemDetailsChangeTypeOneOf {
126
- /** Whether the line item was added as part of the draft. */
127
- added?: boolean;
128
- /** Line item fields before the change. */
129
- changedDetails?: ItemChangedDetails;
130
- /** Whether the line item was removed as part of the draft. */
131
- removed?: boolean;
132
- /** Line item details after applied changes. */
133
- lineItem?: OrderLineItem;
134
- }
135
- /** @oneof */
136
- export interface ItemDetailsChangeTypeOneOf {
137
- /** Whether the line item was added as part of the draft. */
138
- added?: boolean;
139
- /** Line item fields before the change. */
140
- changedDetails?: ItemChangedDetails;
141
- /** Whether the line item was removed as part of the draft. */
142
- removed?: boolean;
143
- }
144
- export interface Price {
145
- /**
146
- * Amount.
147
- * @decimalValue options { gte:0, lte:1000000000000000 }
148
- */
149
- amount?: string;
150
- /**
151
- * Amount formatted with currency symbol.
152
- * @readonly
153
- */
154
- formattedAmount?: string;
155
- }
156
- export interface PriceDescription {
157
- /**
158
- * __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).
159
- * @minLength 1
160
- * @maxLength 100
161
- */
162
- original?: string;
163
- /**
164
- * Price description translated into the buyer's language.
165
- *
166
- * Default: Same as `original`.
167
- * @minLength 1
168
- * @maxLength 100
169
- */
170
- translated?: string | null;
171
- }
172
- export interface OrderLineItem {
173
- /**
174
- * Line item ID.
175
- * @immutable
176
- */
177
- _id?: string;
178
- /**
179
- * Item name.
180
- * + Stores - `product.name`
181
- * + Bookings - `service.info.name`
182
- * + Events - `ticket.name`
183
- */
184
- productName?: ProductName;
185
- /**
186
- * References to the line item's origin catalog.
187
- * This field may be empty in the case of a custom line item.
188
- */
189
- catalogReference?: CatalogReference;
190
- /**
191
- * Line item quantity.
192
- * @min 1
193
- * @max 100000
194
- */
195
- quantity?: number;
196
- /**
197
- * Total discount for this line item's entire quantity.
198
- * @readonly
199
- */
200
- totalDiscount?: Price;
201
- /**
202
- * Line item description lines. Used for display purposes for the cart, checkout and order.
203
- * @maxSize 20
204
- */
205
- descriptionLines?: DescriptionLine[];
206
- /** Line item image. */
207
- image?: string;
208
- /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
209
- physicalProperties?: PhysicalProperties;
210
- /** Item type. Either a preset type or custom. */
211
- itemType?: ItemType;
212
- /**
213
- * Fulfiller ID. Field is empty when the line item is self-fulfilled.
214
- * 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).
215
- * @format GUID
216
- */
217
- fulfillerId?: string | null;
218
- /**
219
- * Number of items that were refunded.
220
- * @max 100000
221
- */
222
- refundQuantity?: number | null;
223
- /**
224
- * Number of items restocked.
225
- * @max 100000
226
- */
227
- restockQuantity?: number | null;
228
- /** Line item price after line item discounts for display purposes. */
229
- price?: Price;
230
- /**
231
- * Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
232
- * @readonly
233
- */
234
- priceBeforeDiscounts?: Price;
235
- /**
236
- * Total price after discounts, and before tax.
237
- * @readonly
238
- */
239
- totalPriceBeforeTax?: Price;
240
- /**
241
- * Total price after all discounts and tax.
242
- * @readonly
243
- */
244
- totalPriceAfterTax?: Price;
245
- /**
246
- * Type of selected payment option for current item.
247
- *
248
- * Default: `FULL_PAYMENT_ONLINE`
249
- */
250
- paymentOption?: PaymentOptionType;
251
- /**
252
- * Deprecated. Use `taxInfo` instead.
253
- * This field will be removed on September 30, 2024.
254
- * Tax details for this line item.
255
- * @deprecated Deprecated. Use `taxInfo` instead.
256
- * This field will be removed on September 30, 2024.
257
- * Tax details for this line item.
258
- * @replacedBy tax_info
259
- * @targetRemovalDate 2024-09-30
260
- */
261
- taxDetails?: ItemTaxFullDetails;
262
- /** Represents all the relevant tax details for a specific line item. */
263
- taxInfo?: LineItemTaxInfo;
264
- /** Digital file identifier, relevant only for items with type DIGITAL. */
265
- digitalFile?: DigitalFile;
266
- /** Subscription info. */
267
- subscriptionInfo?: SubscriptionInfo;
268
- /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
269
- priceDescription?: PriceDescription;
270
- /**
271
- * Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
272
- * @readonly
273
- */
274
- depositAmount?: Price;
275
- /**
276
- * Line item locations.
277
- *
278
- * The location's total quantity must not exceed the line item quantity.
279
- * @maxSize 5
280
- */
281
- locations?: LocationAndQuantity[];
282
- /**
283
- * Custom extended fields for the line item object.
284
- *
285
- * [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.
286
- */
287
- extendedFields?: ExtendedFields;
288
- }
289
- export interface ProductName {
290
- /**
291
- * __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).
292
- *
293
- * Min: 1 character.
294
- * Max: 200 characters.
295
- * @minLength 1
296
- * @maxLength 200
297
- */
298
- original?: string;
299
- /**
300
- * Item name translated into the buyer's language.
301
- *
302
- * Min: 1 character.
303
- * Max: 400 characters.
304
- * Default: Same as `original`.
305
- * @minLength 1
306
- * @maxLength 400
307
- */
308
- translated?: string | null;
309
- }
310
- /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
311
- export interface CatalogReference {
312
- /**
313
- * ID of the item within the catalog it belongs to.
314
- * @minLength 1
315
- * @maxLength 36
316
- */
317
- catalogItemId?: string;
318
- /**
319
- * ID of the app providing the catalog.
320
- *
321
- * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
322
- *
323
- * For items from Wix catalogs, the following values always apply:
324
- * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
325
- * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
326
- * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
327
- * @minLength 1
328
- */
329
- appId?: string;
330
- /**
331
- * 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.
332
- *
333
- * 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)).
334
- */
335
- options?: Record<string, any> | null;
336
- }
337
- export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
338
- /** Description line plain text value. */
339
- plainText?: PlainTextValue;
340
- /** Description line color value. */
341
- colorInfo?: Color;
342
- /** Description line name. */
343
- name?: DescriptionLineName;
344
- }
345
- /** @oneof */
346
- export interface DescriptionLineValueOneOf {
347
- /** Description line plain text value. */
348
- plainText?: PlainTextValue;
349
- /** Description line color value. */
350
- colorInfo?: Color;
351
- }
352
- /** @oneof */
353
- export interface DescriptionLineDescriptionLineValueOneOf {
354
- }
355
- export interface DescriptionLineName {
356
- /**
357
- * 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).
358
- * @maxLength 100
359
- */
360
- original?: string;
361
- /**
362
- * Description line name translated into the buyer's language.
363
- *
364
- * Default: Same as `original`.
365
- * @maxLength 200
366
- */
367
- translated?: string | null;
368
- }
369
- export interface PlainTextValue {
370
- /**
371
- * 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).
372
- * @maxLength 600
373
- */
374
- original?: string;
375
- /**
376
- * Description line plain text value translated into the buyer's language.
377
- *
378
- * Default: Same as `original`.
379
- * @maxLength 600
380
- */
381
- translated?: string | null;
382
- }
383
- export interface Color {
384
- /**
385
- * 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).
386
- * @maxLength 500
387
- */
388
- original?: string;
389
- /**
390
- * Description line color name translated into the buyer's language.
391
- *
392
- * Default: Same as `original`.
393
- * @maxLength 500
394
- */
395
- translated?: string | null;
396
- /** HEX or RGB color code for display. */
397
- code?: string | null;
398
- }
399
- export declare enum DescriptionLineType {
400
- /** Unrecognized type. */
401
- UNRECOGNISED = "UNRECOGNISED",
402
- /** Plain text type. */
403
- PLAIN_TEXT = "PLAIN_TEXT",
404
- /** Color type. */
405
- COLOR = "COLOR"
406
- }
407
- export interface FocalPoint {
408
- /** X-coordinate of the focal point. */
409
- x?: number;
410
- /** Y-coordinate of the focal point. */
411
- y?: number;
412
- /** crop by height */
413
- height?: number | null;
414
- /** crop by width */
415
- width?: number | null;
416
- }
417
- export interface PhysicalProperties {
418
- /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
419
- weight?: number | null;
420
- /**
421
- * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
422
- * @maxLength 40
423
- */
424
- sku?: string | null;
425
- /** Whether this line item is shippable. */
426
- shippable?: boolean;
427
- }
428
- export interface ItemType extends ItemTypeItemTypeDataOneOf {
429
- /** Preset item type. */
430
- preset?: ItemTypeItemType;
431
- /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
432
- custom?: string;
433
- }
434
- /** @oneof */
435
- export interface ItemTypeItemTypeDataOneOf {
436
- /** Preset item type. */
437
- preset?: ItemTypeItemType;
438
- /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
439
- custom?: string;
440
- }
441
- export declare enum ItemTypeItemType {
442
- UNRECOGNISED = "UNRECOGNISED",
443
- PHYSICAL = "PHYSICAL",
444
- DIGITAL = "DIGITAL",
445
- GIFT_CARD = "GIFT_CARD",
446
- SERVICE = "SERVICE"
447
- }
448
- /** Type of selected payment option for catalog item */
449
- export declare enum PaymentOptionType {
450
- /** The entire payment for this item happens as part of the checkout. */
451
- FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
452
- /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
453
- FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
454
- /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
455
- MEMBERSHIP = "MEMBERSHIP",
456
- /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
457
- DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
458
- /** 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`. */
459
- MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
460
- }
461
- export interface ItemTaxFullDetails {
462
- /** Taxable amount of this line item. */
463
- taxableAmount?: Price;
464
- /**
465
- * Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
466
- * @decimalValue options { gte:0, maxScale:6 }
467
- */
468
- taxRate?: string;
469
- /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
470
- totalTax?: Price;
471
- }
472
- export interface LineItemTaxInfo {
473
- /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
474
- taxAmount?: Price;
475
- /** Amount for which tax is calculated. */
476
- taxableAmount?: Price;
477
- /**
478
- * Tax rate %, as a decimal point.
479
- * @format DECIMAL_VALUE
480
- * @decimalValue options { gte:0, maxScale:6 }
481
- */
482
- taxRate?: string | null;
483
- /**
484
- * Tax group ID.
485
- * @format GUID
486
- */
487
- taxGroupId?: string | null;
488
- /** Indicates whether the price already includes tax. */
489
- taxIncludedInPrice?: boolean;
490
- /**
491
- * Tax information for a line item.
492
- * @maxSize 7
493
- */
494
- taxBreakdown?: LineItemTaxBreakdown[];
495
- }
496
- /**
497
- * TaxBreakdown represents tax information for a line item.
498
- * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
499
- */
500
- export interface LineItemTaxBreakdown {
501
- /**
502
- * Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
503
- * @maxLength 200
504
- */
505
- jurisdiction?: string | null;
506
- /**
507
- * Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
508
- * @format DECIMAL_VALUE
509
- * @decimalValue options { gte:0, maxScale:6 }
510
- */
511
- rate?: string | null;
512
- /** Amount of tax calculated for this line item. */
513
- taxAmount?: Price;
514
- /**
515
- * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
516
- * @maxLength 200
517
- */
518
- taxType?: string | null;
519
- /**
520
- * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
521
- * This name should be explicit enough to allow the merchant to understand what tax was calculated.
522
- * @maxLength 200
523
- */
524
- taxName?: string | null;
525
- /** Type of jurisdiction that taxes were calculated for. */
526
- jurisdictionType?: JurisdictionType;
527
- /** Non-taxable amount of the line item price. */
528
- nonTaxableAmount?: Price;
529
- /** Taxable amount of the line item price. */
530
- taxableAmount?: Price;
531
- }
532
- /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
533
- export declare enum JurisdictionType {
534
- UNDEFINED = "UNDEFINED",
535
- COUNTRY = "COUNTRY",
536
- STATE = "STATE",
537
- COUNTY = "COUNTY",
538
- CITY = "CITY",
539
- SPECIAL = "SPECIAL"
540
- }
541
- export interface DigitalFile {
542
- /**
543
- * ID of the secure file in media.
544
- * @minLength 1
545
- * @maxLength 100
546
- */
547
- fileId?: string;
548
- /**
549
- * Link will exist after the digital links have been generated on the order.
550
- * @format WEB_URL
551
- * @minLength 1
552
- * @maxLength 2000
553
- */
554
- link?: string | null;
555
- /**
556
- * Link expiration time and date.
557
- * @readonly
558
- */
559
- expirationDate?: Date | null;
560
- }
561
- export interface SubscriptionInfo {
562
- /**
563
- * Subscription ID.
564
- * @format GUID
565
- */
566
- _id?: string | null;
567
- /**
568
- * Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
569
- * @min 1
570
- */
571
- cycleNumber?: number;
572
- /**
573
- * Subscription option title. For example, `"Monthly coffee Subscription"`.
574
- * @maxLength 20
575
- * @deprecated Subscription option title. For example, `"Monthly coffee Subscription"`.
576
- * @replacedBy title
577
- * @targetRemovalDate 2025-10-01
578
- */
579
- subscriptionOptionTitle?: string;
580
- /**
581
- * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
582
- * @maxLength 60
583
- * @deprecated Subscription option description. For example, `"1kg of selected coffee, once a month"`.
584
- * @replacedBy description
585
- * @targetRemovalDate 2025-10-01
586
- */
587
- subscriptionOptionDescription?: string | null;
588
- /**
589
- * Subscription detailed information.
590
- * @immutable
591
- */
592
- subscriptionSettings?: SubscriptionSettings;
593
- }
594
- export interface SubscriptionTitle {
595
- /**
596
- * Subscription option 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).
597
- * @minLength 1
598
- * @maxLength 150
599
- */
600
- original?: string;
601
- /**
602
- * Subscription option name translated into the buyer's language.
603
- *
604
- * Default: Same as `original`.
605
- * @minLength 1
606
- * @maxLength 150
607
- */
608
- translated?: string | null;
609
- }
610
- export interface SubscriptionDescription {
611
- /**
612
- * Subscription option description.
613
- * @maxLength 500
614
- */
615
- original?: string;
616
- /**
617
- * Translated subscription option description.
618
- * @maxLength 500
619
- */
620
- translated?: string | null;
621
- }
622
- export interface SubscriptionSettings {
623
- /** Frequency of recurring payment. */
624
- frequency?: SubscriptionFrequency;
625
- /**
626
- * Interval of recurring payment.
627
- * @min 1
628
- * @max 50
629
- */
630
- interval?: number | null;
631
- /** Whether subscription is renewed automatically at the end of each period. */
632
- autoRenewal?: boolean;
633
- /**
634
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
635
- * @min 1
636
- */
637
- billingCycles?: number | null;
638
- }
639
- /** Frequency unit of recurring payment */
640
- export declare enum SubscriptionFrequency {
641
- UNDEFINED = "UNDEFINED",
642
- DAY = "DAY",
643
- WEEK = "WEEK",
644
- MONTH = "MONTH",
645
- YEAR = "YEAR"
646
- }
647
- export interface FreeTrialPeriod {
648
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
649
- frequency?: SubscriptionFrequency;
650
- /**
651
- * interval of period
652
- * @min 1
653
- * @max 999
654
- */
655
- interval?: number;
656
- }
657
- export interface BillingAdjustment {
658
- /** The type of adjustment. */
659
- type?: AdjustmentType;
660
- /** Summary of the prorated adjustment amount. */
661
- priceSummary?: BillingAdjustmentPriceSummary;
662
- }
663
- export declare enum AdjustmentType {
664
- UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
665
- /** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
666
- EXTRA_CHARGE = "EXTRA_CHARGE",
667
- /** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
668
- CREDIT = "CREDIT"
669
- }
670
- export interface BillingAdjustmentPriceSummary {
671
- /** Subtotal of adjustment, before tax. */
672
- subtotal?: Price;
673
- /** Tax on adjustment. */
674
- tax?: Price;
675
- /** Total price after tax. */
676
- total?: Price;
677
- }
678
- export interface LocationAndQuantity {
679
- /**
680
- * Location id in the associated owner app.
681
- * @format GUID
682
- */
683
- _id?: string;
684
- /**
685
- * Location owner app, if not provided then the site business info locations will be used.
686
- * @format GUID
687
- * @deprecated Location owner app, if not provided then the site business info locations will be used.
688
- * @targetRemovalDate 2025-03-01
689
- */
690
- appId?: string | null;
691
- /**
692
- * Quantity for specific location.
693
- * @min 1
694
- * @max 100000
695
- */
696
- quantity?: number;
697
- /**
698
- * Location name.
699
- * @maxLength 500
700
- * @readonly
701
- */
702
- name?: string | null;
703
- }
704
- export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
705
- /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
706
- addressType?: TaxableAddressType;
707
- }
708
- /** @oneof */
709
- export interface TaxableAddressTaxableAddressDataOneOf {
710
- /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
711
- addressType?: TaxableAddressType;
712
- }
713
- export declare enum TaxableAddressType {
714
- UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
715
- BUSINESS = "BUSINESS",
716
- BILLING = "BILLING",
717
- SHIPPING = "SHIPPING"
718
- }
719
- export interface ExtendedFields {
720
- /**
721
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
722
- * The value of each key is structured according to the schema defined when the extended fields were configured.
723
- *
724
- * You can only access fields for which you have the appropriate permissions.
725
- *
726
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
727
- */
728
- namespaces?: Record<string, Record<string, any>>;
729
- }
730
- export interface ItemChangedDetails {
731
- /**
732
- * Line item quantity before change.
733
- * @min 1
734
- * @max 1000000
735
- */
736
- quantityBeforeChange?: number | null;
737
- /** Line item price before change. */
738
- priceBeforeChange?: Price;
739
- /** Line item price description before change. */
740
- priceDescriptionBeforeChange?: PriceDescription;
741
- }
742
- export interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
743
- /** Whether shipping info was added as part of the draft. */
744
- added?: boolean;
745
- /** Shipping info before the change. */
746
- changedDetails?: ShippingChangedDetails;
747
- /** Whether shipping info was removed as part of the draft. */
748
- removed?: boolean;
749
- /** Selected Shipping details. */
750
- shippingInfo?: V1ShippingInformation;
751
- }
752
- /** @oneof */
753
- export interface ShippingDetailsChangeTypeOneOf {
754
- /** Whether shipping info was added as part of the draft. */
755
- added?: boolean;
756
- /** Shipping info before the change. */
757
- changedDetails?: ShippingChangedDetails;
758
- /** Whether shipping info was removed as part of the draft. */
759
- removed?: boolean;
760
- }
761
- export interface V1ShippingInformation {
762
- /**
763
- * App Def Id of external provider which was a source of shipping info
764
- * @minLength 1
765
- * @maxLength 100
766
- */
767
- carrierId?: string | null;
768
- /**
769
- * Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`.
770
- * @minLength 1
771
- * @maxLength 100
772
- */
773
- code?: string | null;
774
- /**
775
- * Shipping option title.
776
- * For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
777
- * @maxLength 250
778
- */
779
- title?: string;
780
- /** Shipping logistics. */
781
- logistics?: V1DeliveryLogistics;
782
- /** Shipping costs. */
783
- cost?: V1ShippingPrice;
784
- /** Shipping region. */
785
- region?: ShippingRegion;
786
- }
787
- export interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {
788
- /** Shipping address and contact details. */
789
- shippingDestination?: AddressWithContact;
790
- /** Pickup details. */
791
- pickupDetails?: V1PickupDetails;
792
- /**
793
- * Expected delivery time in free text. For example, `"3-5 business days"`.
794
- * @maxLength 500
795
- */
796
- deliveryTime?: string | null;
797
- /**
798
- * Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
799
- * @maxLength 1000
800
- */
801
- instructions?: string | null;
802
- /**
803
- * Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
804
- * @deprecated
805
- */
806
- deliverByDate?: Date | null;
807
- /** Expected delivery time. */
808
- deliveryTimeSlot?: V1DeliveryTimeSlot;
809
- }
810
- /** @oneof */
811
- export interface V1DeliveryLogisticsAddressOneOf {
812
- /** Shipping address and contact details. */
813
- shippingDestination?: AddressWithContact;
814
- /** Pickup details. */
815
- pickupDetails?: V1PickupDetails;
816
- }
817
- /** Billing Info and shipping details */
818
- export interface AddressWithContact {
819
- /** Address. */
820
- address?: Address;
821
- /** Contact details. */
822
- contactDetails?: FullAddressContactDetails;
823
- }
824
- /** Physical address */
825
- export interface Address {
826
- /**
827
- * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
828
- * @format COUNTRY
829
- */
830
- country?: string | null;
831
- /**
832
- * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
833
- * @maxLength 50
834
- */
835
- subdivision?: string | null;
836
- /**
837
- * City name.
838
- * @maxLength 50
839
- */
840
- city?: string | null;
841
- /**
842
- * Postal or zip code.
843
- * @maxLength 50
844
- */
845
- postalCode?: string | null;
846
- /** Street address. */
847
- streetAddress?: StreetAddress;
848
- /**
849
- * Main address line (usually street name and number).
850
- * @maxLength 150
851
- */
852
- addressLine1?: string | null;
853
- /**
854
- * Free text providing more detailed address info. Usually contains apt, suite, floor.
855
- * @maxLength 100
856
- */
857
- addressLine2?: string | null;
858
- /**
859
- * Country's full name.
860
- * @readonly
861
- */
862
- countryFullname?: string | null;
863
- /**
864
- * Subdivision full-name.
865
- * @readonly
866
- */
867
- subdivisionFullname?: string | null;
868
- }
869
- export interface StreetAddress {
870
- /** Street number. */
871
- number?: string;
872
- /** Street name. */
873
- name?: string;
874
- }
875
- export interface AddressLocation {
876
- /** Address latitude. */
877
- latitude?: number | null;
878
- /** Address longitude. */
879
- longitude?: number | null;
880
- }
881
- /** Full contact details for an address */
882
- export 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
- export 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?: VatType;
917
- }
918
- /** tax info types */
919
- export declare enum VatType {
920
- UNSPECIFIED = "UNSPECIFIED",
921
- /** CPF - for individual tax payers. */
922
- CPF = "CPF",
923
- /** CNPJ - for corporations */
924
- CNPJ = "CNPJ"
925
- }
926
- export interface V1PickupDetails {
927
- /** Pickup address. */
928
- address?: PickupAddress;
929
- /** Pickup method */
930
- pickupMethod?: PickupDetailsPickupMethod;
931
- }
932
- /** Physical address */
933
- export interface PickupAddress {
934
- /**
935
- * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
936
- * @format COUNTRY
937
- */
938
- country?: string | null;
939
- /**
940
- * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
941
- * @maxLength 50
942
- */
943
- subdivision?: string | null;
944
- /**
945
- * City name.
946
- * @maxLength 1000
947
- */
948
- city?: string | null;
949
- /**
950
- * Postal or zip code.
951
- * @maxLength 1000
952
- */
953
- postalCode?: string | null;
954
- /** Street address object, with number, name, and apartment number in separate fields. */
955
- streetAddress?: StreetAddress;
956
- /**
957
- * Main address line (usually street name and number).
958
- * @maxLength 1000
959
- */
960
- addressLine1?: string | null;
961
- /**
962
- * Free text providing more detailed address info. Usually contains apt, suite, floor.
963
- * @maxLength 1000
964
- */
965
- addressLine2?: string | null;
966
- /**
967
- * Country's full name.
968
- * @readonly
969
- */
970
- countryFullname?: string | null;
971
- /**
972
- * Subdivision full-name.
973
- * @readonly
974
- */
975
- subdivisionFullname?: string | null;
976
- }
977
- export declare enum PickupDetailsPickupMethod {
978
- UNKNOWN_METHOD = "UNKNOWN_METHOD",
979
- STORE_PICKUP = "STORE_PICKUP",
980
- PICKUP_POINT = "PICKUP_POINT"
981
- }
982
- export interface V1DeliveryTimeSlot {
983
- /** Delivery slot starting time. */
984
- from?: Date | null;
985
- /** Delivery slot ending time. */
986
- to?: Date | null;
987
- }
988
- export interface V1ShippingPrice {
989
- /** Shipping price for display purposes. */
990
- price?: Price;
991
- /**
992
- * Total price of shipping after discounts (when relevant), and before tax.
993
- * @readonly
994
- */
995
- totalPriceBeforeTax?: Price;
996
- /**
997
- * Shipping price after all discounts (if any exist), and after tax.
998
- * @readonly
999
- */
1000
- totalPriceAfterTax?: Price;
1001
- /** Tax details. */
1002
- taxDetails?: ItemTaxFullDetails;
1003
- /**
1004
- * Shipping discount before tax.
1005
- * @readonly
1006
- */
1007
- discount?: Price;
1008
- }
1009
- export interface ShippingRegion {
1010
- /**
1011
- * Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
1012
- * @maxLength 100
1013
- */
1014
- name?: string | null;
1015
- }
1016
- export interface ShippingChangedDetails {
1017
- /** Shipping info before the change. */
1018
- shippingInfoBeforeChange?: V1ShippingInformation;
1019
- }
1020
- /** Buyer Info */
1021
- export interface BuyerInfo extends BuyerInfoIdOneOf {
1022
- /**
1023
- * Visitor ID (if site visitor is not a member).
1024
- * @format GUID
1025
- */
1026
- visitorId?: string;
1027
- /**
1028
- * Member ID (if site visitor is a site member).
1029
- * @format GUID
1030
- */
1031
- memberId?: string;
1032
- /**
1033
- * 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).
1034
- * @format GUID
1035
- */
1036
- contactId?: string | null;
1037
- /**
1038
- * Buyer email address.
1039
- * @format EMAIL
1040
- */
1041
- email?: string | null;
1042
- }
1043
- /** @oneof */
1044
- export interface BuyerInfoIdOneOf {
1045
- /**
1046
- * Visitor ID (if site visitor is not a member).
1047
- * @format GUID
1048
- */
1049
- visitorId?: string;
1050
- /**
1051
- * Member ID (if site visitor is a site member).
1052
- * @format GUID
1053
- */
1054
- memberId?: string;
1055
- }
1056
- export interface AdditionalFeeDetails {
1057
- /** Additional fee. */
1058
- additionalFee?: AdditionalFee;
1059
- /** Tax details related to the additional fee. */
1060
- taxDetails?: TaxDetails;
1061
- /**
1062
- * Source of the additional fee.
1063
- *
1064
- * Supported values:
1065
- * + `ORIGINAL_ORDER`: This additional fee is part of the original order.
1066
- * + `CUSTOM`: This additional fee was created by the [Create Custom Additional Fees](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/draft-orders/create-custom-additional-fees) API.
1067
- */
1068
- source?: SourceType;
1069
- /** Whether this additional fee is applied to the order. */
1070
- applied?: boolean;
1071
- }
1072
- export interface AdditionalFee {
1073
- /**
1074
- * Additional fee's unique code for future processing.
1075
- * @minLength 1
1076
- * @maxLength 100
1077
- */
1078
- code?: string | null;
1079
- /**
1080
- * Name of additional fee.
1081
- * @minLength 1
1082
- * @maxLength 50
1083
- */
1084
- name?: string;
1085
- /** Additional fee's price. */
1086
- price?: Price;
1087
- /** Tax details. */
1088
- taxDetails?: ItemTaxFullDetails;
1089
- /**
1090
- * SPI implementer's `appId`.
1091
- * @format GUID
1092
- */
1093
- providerAppId?: string | null;
1094
- /** Additional fee's price before tax. */
1095
- priceBeforeTax?: Price;
1096
- /** Additional fee's price after tax. */
1097
- priceAfterTax?: Price;
1098
- /**
1099
- * Additional fee's id.
1100
- * @format GUID
1101
- * @immutable
1102
- */
1103
- _id?: string;
1104
- /**
1105
- * Optional - Line items associated with this additional fee.
1106
- * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
1107
- * @format GUID
1108
- */
1109
- lineItemIds?: string[];
1110
- }
1111
- export interface TaxDetails {
1112
- /** Indication if additional fee is taxable or not */
1113
- taxable?: boolean;
1114
- /**
1115
- * Optional tax group ID to use when calculating tax for this additional fee
1116
- * @format GUID
1117
- */
1118
- taxGroupId?: string | null;
1119
- }
1120
- export declare enum SourceType {
1121
- /** Part of the original order */
1122
- ORIGINAL_ORDER = "ORIGINAL_ORDER",
1123
- /** Added by estimate * */
1124
- AUTOMATIC = "AUTOMATIC",
1125
- /** Added manually to current draft order */
1126
- CUSTOM = "CUSTOM"
1127
- }
1128
- export interface DiscountDetails {
1129
- /** Discount details. */
1130
- discount?: AppliedDiscount;
1131
- /**
1132
- * Source of the discount.
1133
- *
1134
- * Supported values:
1135
- * + `ORIGINAL_ORDER`: This discount is part of the original order.
1136
- * + `CUSTOM`: This discount was created by the [Create Custom Discounts](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/draft-orders/create-custom-discounts) API.
1137
- */
1138
- source?: SourceType;
1139
- /** Whether this discount is applied to the order. */
1140
- applied?: boolean;
1141
- }
1142
- export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1143
- /** Applied coupon info. */
1144
- coupon?: Coupon;
1145
- /** Merchant discount. */
1146
- merchantDiscount?: MerchantDiscount;
1147
- /** Automatic Discount */
1148
- discountRule?: DiscountRule;
1149
- /**
1150
- * Discount type.
1151
- * * `"GLOBAL"` - discount applies to entire order.
1152
- * * `"SPECIFIC-ITEMS"` - discount applies to specific items.
1153
- * * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
1154
- */
1155
- discountType?: AppliedDiscountDiscountType;
1156
- /**
1157
- * IDs of line items discount applies to.
1158
- * Deprecated. Use `line_item_discounts` instead.
1159
- * @format GUID
1160
- * @maxSize 1
1161
- * @deprecated IDs of line items discount applies to.
1162
- * Deprecated. Use `line_item_discounts` instead.
1163
- * @replacedBy line_item_discounts
1164
- * @targetRemovalDate 2024-10-30
1165
- */
1166
- lineItemIds?: string[];
1167
- /**
1168
- * Discount id.
1169
- * @format GUID
1170
- * @immutable
1171
- */
1172
- _id?: string | null;
1173
- }
1174
- /** @oneof */
1175
- export interface AppliedDiscountDiscountSourceOneOf {
1176
- /** Applied coupon info. */
1177
- coupon?: Coupon;
1178
- /** Merchant discount. */
1179
- merchantDiscount?: MerchantDiscount;
1180
- /** Automatic Discount */
1181
- discountRule?: DiscountRule;
1182
- }
1183
- export declare enum AppliedDiscountDiscountType {
1184
- GLOBAL = "GLOBAL",
1185
- SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1186
- SHIPPING = "SHIPPING"
1187
- }
1188
- /** Coupon */
1189
- export interface Coupon {
1190
- /** Coupon ID. */
1191
- _id?: string;
1192
- /** Coupon code. */
1193
- code?: string;
1194
- /** Coupon name. */
1195
- name?: string;
1196
- /** Coupon value. */
1197
- amount?: Price;
1198
- }
1199
- export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
1200
- /**
1201
- * Pre-defined discount reason (optional).
1202
- * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
1203
- */
1204
- discountReason?: DiscountReason;
1205
- /**
1206
- * Discount description as free text (optional).
1207
- * @maxLength 200
1208
- */
1209
- description?: string | null;
1210
- /** Discount amount. */
1211
- amount?: Price;
1212
- }
1213
- /** @oneof */
1214
- export interface MerchantDiscountMerchantDiscountReasonOneOf {
1215
- /**
1216
- * Pre-defined discount reason (optional).
1217
- * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
1218
- */
1219
- discountReason?: DiscountReason;
1220
- /**
1221
- * Discount description as free text (optional).
1222
- * @maxLength 200
1223
- */
1224
- description?: string | null;
1225
- }
1226
- export declare enum DiscountReason {
1227
- UNSPECIFIED = "UNSPECIFIED",
1228
- EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
1229
- BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
1230
- }
1231
- export interface DiscountRule {
1232
- /**
1233
- * Discount rule ID
1234
- * @format GUID
1235
- */
1236
- _id?: string;
1237
- /** Discount rule name */
1238
- name?: DiscountRuleName;
1239
- /** Discount value. */
1240
- amount?: Price;
1241
- }
1242
- export interface DiscountRuleName {
1243
- /**
1244
- * Original discount rule name (in site's default language).
1245
- * @minLength 1
1246
- * @maxLength 256
1247
- */
1248
- original?: string;
1249
- /**
1250
- * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
1251
- * @minLength 1
1252
- * @maxLength 500
1253
- */
1254
- translated?: string | null;
1255
- }
1256
- export interface LineItemDiscount {
1257
- /**
1258
- * ID of line item the discount applies to.
1259
- * @format GUID
1260
- */
1261
- _id?: string;
1262
- /** Total discount for this line item. */
1263
- totalDiscount?: Price;
1264
- }
1265
- export interface CreatedBy extends CreatedByStringOneOf {
1266
- /**
1267
- * User ID. When the draft order was created by a Wix user.
1268
- * @format GUID
1269
- */
1270
- userId?: string;
1271
- /**
1272
- * App ID. When the draft order was created by an app.
1273
- * @format GUID
1274
- */
1275
- appId?: string;
1276
- }
1277
- /** @oneof */
1278
- export interface CreatedByStringOneOf {
1279
- /**
1280
- * User ID. When the draft order was created by a Wix user.
1281
- * @format GUID
1282
- */
1283
- userId?: string;
1284
- /**
1285
- * App ID. When the draft order was created by an app.
1286
- * @format GUID
1287
- */
1288
- appId?: string;
1289
- }
1290
- export declare enum EditingStatus {
1291
- /** DraftOrder is in draft state. */
1292
- DRAFT = "DRAFT",
1293
- /** DraftOrder is in committed state. */
1294
- COMMITTED = "COMMITTED"
1295
- }
1296
- export declare enum WeightUnit {
1297
- /** Weight unit can't be classified due to an error. */
1298
- UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
1299
- /** Kilograms. */
1300
- KG = "KG",
1301
- /** Pounds. */
1302
- LB = "LB"
1303
- }
1304
- export interface PriceSummary {
1305
- /** Subtotal of all the line items, before discounts and before tax. */
1306
- subtotal?: Price;
1307
- /** Total shipping price, before discounts and before tax. */
1308
- shipping?: Price;
1309
- /** Total tax on this order. */
1310
- tax?: Price;
1311
- /** Total calculated discount value. */
1312
- discount?: Price;
1313
- /** Order’s total price after discounts and tax. */
1314
- total?: Price;
1315
- /** Total price of additional fees before tax. */
1316
- totalAdditionalFees?: Price;
1317
- }
1318
- export interface TaxSummary {
1319
- /**
1320
- * Total tax.
1321
- * @readonly
1322
- */
1323
- totalTax?: Price;
1324
- }
1325
- export interface BalanceSummary {
1326
- /**
1327
- * Amount left to pay for order to be considered paid.
1328
- * @readonly
1329
- */
1330
- balance?: Balance;
1331
- /**
1332
- * Sum of all authorized payments.
1333
- * @readonly
1334
- */
1335
- authorized?: Price;
1336
- }
1337
- /**
1338
- * Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
1339
- * `amount` field depends on order payment status:
1340
- * + UNSPECIFIED, NOT_PAID: price_summary.total_price
1341
- * + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
1342
- * + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
1343
- */
1344
- export interface Balance {
1345
- /**
1346
- * Balance amount.
1347
- *
1348
- * 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.
1349
- * @decimalValue options { }
1350
- * @readonly
1351
- */
1352
- amount?: string;
1353
- /**
1354
- * Amount formatted with currency symbol.
1355
- * @readonly
1356
- */
1357
- formattedAmount?: string;
1358
- }
1359
- /** Side-effects upon committing a draft order. */
1360
- export interface DraftOrderCommitSettings {
1361
- /**
1362
- * Whether to send notifications to the buyer.
1363
- *
1364
- * Default: `true`
1365
- */
1366
- sendNotificationsToBuyer?: boolean | null;
1367
- /**
1368
- * Whether to send notifications to the business.
1369
- *
1370
- * Default: `true`
1371
- */
1372
- sendNotificationsToBusiness?: boolean | null;
1373
- /**
1374
- * Whether to add activities to the order.
1375
- *
1376
- * Default: `true`
1377
- */
1378
- addActivitiesToOrder?: boolean | null;
1379
- /**
1380
- * Whether to send email notifications to custom fulfillers when there is a change in the shippable items they fulfill.
1381
- *
1382
- * Default: `true`
1383
- */
1384
- sendNotificationsToCustomFulfillers?: boolean | null;
1385
- /**
1386
- * Line item IDs for which to perform an inventory change.
1387
- * When not provided, inventory will not change.
1388
- * @maxSize 300
1389
- */
1390
- updateInventory?: InventoryUpdate[];
1391
- }
1392
- export interface InventoryUpdate {
1393
- /**
1394
- * Line item ID.
1395
- * @format GUID
1396
- */
1397
- lineItemId?: string;
1398
- }
1399
- export interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {
1400
- /** Indicates that recipient information was added during draft. */
1401
- added?: boolean;
1402
- /** Indicates that recipient information was changed. Contains recipient information before draft. */
1403
- changedDetails?: RecipientInfoChangedDetails;
1404
- /** Indicates that recipient information was removed during draft. */
1405
- removed?: boolean;
1406
- /** Order recipient address and contact details. */
1407
- recipientInfo?: AddressWithContact;
1408
- }
1409
- /** @oneof */
1410
- export interface RecipientInfoDetailsChangeTypeOneOf {
1411
- /** Indicates that recipient information was added during draft. */
1412
- added?: boolean;
1413
- /** Indicates that recipient information was changed. Contains recipient information before draft. */
1414
- changedDetails?: RecipientInfoChangedDetails;
1415
- /** Indicates that recipient information was removed during draft. */
1416
- removed?: boolean;
1417
- }
1418
- export interface RecipientInfoChangedDetails {
1419
- /** Order recipient address and contact details before draft. */
1420
- recipientInfoBeforeChange?: AddressWithContact;
1421
- }
1422
- export interface OrderTaxInfo {
1423
- /** Calculated tax, added from line items. */
1424
- totalTax?: Price;
1425
- /**
1426
- * 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.
1427
- * @maxSize 50
1428
- */
1429
- taxBreakdown?: OrderTaxBreakdown[];
1430
- /**
1431
- * Whether the order is exempt from tax calculations.
1432
- *
1433
- * Default: `false`
1434
- * @readonly
1435
- */
1436
- taxExempt?: boolean | null;
1437
- }
1438
- /**
1439
- * 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.
1440
- * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1441
- */
1442
- export interface OrderTaxBreakdown {
1443
- /**
1444
- * The name of the tax against which this tax amount was calculated.
1445
- * @maxLength 200
1446
- */
1447
- taxName?: string;
1448
- /**
1449
- * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
1450
- * @maxLength 200
1451
- */
1452
- taxType?: string;
1453
- /**
1454
- * The name of the jurisdiction in which this tax detail applies.
1455
- * @maxLength 200
1456
- */
1457
- jurisdiction?: string;
1458
- /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1459
- jurisdictionType?: JurisdictionType;
1460
- /**
1461
- * The rate at which this tax detail was calculated.
1462
- * @format DECIMAL_VALUE
1463
- * @decimalValue options { gte:0, maxScale:6 }
1464
- */
1465
- rate?: string;
1466
- /** The sum of all the tax from line items that calculated by the tax identifiers. */
1467
- aggregatedTaxAmount?: Price;
1468
- }
1469
- export interface BuyerDetails extends BuyerDetailsChangeTypeOneOf {
1470
- }
1471
- /** @oneof */
1472
- export interface BuyerDetailsChangeTypeOneOf {
1473
- }
1474
- export interface BuyerChangedDetails {
1475
- }
1476
- export interface BillingDetails extends BillingDetailsChangeTypeOneOf {
1477
- }
1478
- /** @oneof */
1479
- export interface BillingDetailsChangeTypeOneOf {
1480
- }
1481
- export interface BillingChangedDetails {
1482
- }
1483
- export interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {
1484
- /** Indicates that business location was added during draft. */
1485
- added?: boolean;
1486
- /** Indicates that business location was changed. Contains business location before draft. */
1487
- changedDetails?: BusinessLocationChangedDetails;
1488
- /** Indicates that business location was removed during draft. */
1489
- removed?: boolean;
1490
- /** Business location. */
1491
- businessLocation?: Location;
1492
- }
1493
- /** @oneof */
1494
- export interface BusinessLocationDetailsChangeTypeOneOf {
1495
- /** Indicates that business location was added during draft. */
1496
- added?: boolean;
1497
- /** Indicates that business location was changed. Contains business location before draft. */
1498
- changedDetails?: BusinessLocationChangedDetails;
1499
- /** Indicates that business location was removed during draft. */
1500
- removed?: boolean;
1501
- }
1502
- export interface Location {
1503
- /**
1504
- * Location ID.
1505
- * Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
1506
- * @format GUID
1507
- */
1508
- _id?: string;
1509
- /**
1510
- * Location name.
1511
- * @minLength 1
1512
- * @maxLength 500
1513
- * @readonly
1514
- */
1515
- name?: string;
1516
- }
1517
- export interface BusinessLocationChangedDetails {
1518
- /** Business location before draft. */
1519
- businessLocationBeforeChange?: Location;
1520
- }
1521
- export interface CreateDraftOrderRequest {
1522
- /**
1523
- * To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
1524
- * @format GUID
1525
- */
1526
- orderId: string | null;
1527
- }
1528
- export interface CreateDraftOrderResponse {
1529
- /** The draft order details calculated with latest content */
1530
- calculatedDraftOrder?: CalculatedDraftOrder;
1531
- }
1532
- export interface CalculatedDraftOrder {
1533
- /**
1534
- * The draft order full details with calculations based on it's content.
1535
- * Discount and additional fee options are also included.
1536
- */
1537
- draftOrder?: DraftOrder;
1538
- /** Shipping options for the order. */
1539
- shippingOptions?: ShippingOption[];
1540
- /** Errors that occurred during calculation. */
1541
- calculationErrors?: CalculationErrors;
1542
- }
1543
- export interface ShippingOption {
1544
- /**
1545
- * This carrier's unique ID
1546
- * @format GUID
1547
- */
1548
- carrierId?: string | null;
1549
- /** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
1550
- code?: string;
1551
- /** Shipping rate title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"`, or `"First-Class Package International"`. */
1552
- title?: string;
1553
- /** Shipping logistics. */
1554
- logistics?: DeliveryLogistics;
1555
- /** Shipping cost. */
1556
- cost?: ShippingPrice;
1557
- }
1558
- export interface DeliveryLogistics {
1559
- /** When the item is expected to be delivered in free text, e.g "3-5 business days" */
1560
- deliveryTime?: string | null;
1561
- /** Instructions for caller, e.g for pickup: "Ensure to come during Opening Hours, and please don't park in disabled-spot" */
1562
- instructions?: string | null;
1563
- /** Additional pickup details if it's a pickup */
1564
- pickupDetails?: PickupDetails;
1565
- /** Expected delivery time slot (from and to time stamps representation) */
1566
- deliveryTimeSlot?: DeliveryTimeSlot;
1567
- }
1568
- export interface PickupDetails {
1569
- /** Pickup address */
1570
- address?: Address;
1571
- /**
1572
- * Pickup method.
1573
- *
1574
- * Supported values:
1575
- * + `"STORE_PICKUP"`
1576
- * + `"PICKUP_POINT"`
1577
- */
1578
- pickupMethod?: PickupMethod;
1579
- }
1580
- export declare enum PickupMethod {
1581
- UNKNOWN_METHOD = "UNKNOWN_METHOD",
1582
- STORE_PICKUP = "STORE_PICKUP",
1583
- PICKUP_POINT = "PICKUP_POINT"
1584
- }
1585
- export interface DeliveryTimeSlot {
1586
- /** starting time of the delivery time slot */
1587
- from?: Date | null;
1588
- /** ending time of the delivery time slot */
1589
- to?: Date | null;
1590
- }
1591
- export interface ShippingPrice {
1592
- /** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
1593
- price?: Price;
1594
- /**
1595
- * Currency of the shipping rate price as a 3-letter [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217). Must align with the `currency` passed to the function.
1596
- * @format CURRENCY
1597
- */
1598
- currency?: string;
1599
- }
1600
- export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1601
- /** General shipping calculation error. */
1602
- generalShippingCalculationError?: Details;
1603
- /** Carrier errors. */
1604
- carrierErrors?: CarrierErrors;
1605
- /** Tax calculation error. */
1606
- taxCalculationError?: Details;
1607
- /** Order validation errors. */
1608
- orderValidationErrors?: ApplicationError[];
1609
- }
1610
- /** @oneof */
1611
- export interface CalculationErrorsShippingCalculationErrorOneOf {
1612
- /** General shipping calculation error. */
1613
- generalShippingCalculationError?: Details;
1614
- /** Carrier errors. */
1615
- carrierErrors?: CarrierErrors;
1616
- }
1617
- export interface Details extends DetailsKindOneOf {
1618
- applicationError?: ApplicationError;
1619
- validationError?: ValidationError;
1620
- systemError?: SystemError;
1621
- /**
1622
- * deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
1623
- * @deprecated
1624
- */
1625
- tracing?: Record<string, string>;
1626
- }
1627
- /** @oneof */
1628
- export interface DetailsKindOneOf {
1629
- applicationError?: ApplicationError;
1630
- validationError?: ValidationError;
1631
- systemError?: SystemError;
1632
- }
1633
- export interface ApplicationError {
1634
- /** Error code. */
1635
- code?: string;
1636
- /** Description of the error. */
1637
- description?: string;
1638
- /** Data related to the error. */
1639
- data?: Record<string, any> | null;
1640
- }
1641
- /**
1642
- * example result:
1643
- * {
1644
- * "fieldViolations": [
1645
- * {
1646
- * "field": "fieldA",
1647
- * "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
1648
- * "violatedRule": "OTHER",
1649
- * "ruleName": "INVALID_NOTE",
1650
- * "data": {
1651
- * "value": "FI"
1652
- * }
1653
- * },
1654
- * {
1655
- * "field": "fieldB",
1656
- * "description": "field value out of range. supported range: [0-20]",
1657
- * "violatedRule": "MAX",
1658
- * "data": {
1659
- * "threshold": 20
1660
- * }
1661
- * },
1662
- * {
1663
- * "field": "fieldC",
1664
- * "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
1665
- * "violatedRule": "FORMAT",
1666
- * "data": {
1667
- * "type": "PHONE"
1668
- * }
1669
- * }
1670
- * ]
1671
- * }
1672
- */
1673
- export interface ValidationError {
1674
- fieldViolations?: FieldViolation[];
1675
- }
1676
- export declare enum RuleType {
1677
- VALIDATION = "VALIDATION",
1678
- OTHER = "OTHER",
1679
- MAX = "MAX",
1680
- MIN = "MIN",
1681
- MAX_LENGTH = "MAX_LENGTH",
1682
- MIN_LENGTH = "MIN_LENGTH",
1683
- MAX_SIZE = "MAX_SIZE",
1684
- MIN_SIZE = "MIN_SIZE",
1685
- FORMAT = "FORMAT",
1686
- DECIMAL_LTE = "DECIMAL_LTE",
1687
- DECIMAL_GTE = "DECIMAL_GTE",
1688
- DECIMAL_LT = "DECIMAL_LT",
1689
- DECIMAL_GT = "DECIMAL_GT",
1690
- DECIMAL_MAX_SCALE = "DECIMAL_MAX_SCALE",
1691
- INVALID_ENUM_VALUE = "INVALID_ENUM_VALUE",
1692
- REQUIRED_FIELD = "REQUIRED_FIELD",
1693
- FIELD_NOT_ALLOWED = "FIELD_NOT_ALLOWED",
1694
- ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT",
1695
- EXACT_LENGTH = "EXACT_LENGTH",
1696
- EXACT_SIZE = "EXACT_SIZE",
1697
- REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1698
- }
1699
- export interface FieldViolation {
1700
- field?: string;
1701
- description?: string;
1702
- violatedRule?: RuleType;
1703
- /** applicable when violated_rule=OTHER */
1704
- ruleName?: string | null;
1705
- data?: Record<string, any> | null;
1706
- }
1707
- export interface SystemError {
1708
- /** Error code. */
1709
- errorCode?: string | null;
1710
- }
1711
- export interface CarrierErrors {
1712
- /** Carrier errors. */
1713
- errors?: CarrierError[];
1714
- }
1715
- export interface CarrierError {
1716
- /** Carrier ID. */
1717
- carrierId?: string;
1718
- /** Error details. */
1719
- error?: Details;
1720
- }
1721
- export interface CreateEmptyDraftOrderRequest {
1722
- }
1723
- export interface CreateEmptyDraftOrderResponse {
1724
- /** The draft order details calculated with latest content */
1725
- calculatedDraftOrder?: CalculatedDraftOrder;
1726
- }
1727
- export interface AddLineItemsToDraftOrderRequest {
1728
- /**
1729
- * The draft order id
1730
- * @format GUID
1731
- */
1732
- draftOrderId: string;
1733
- /**
1734
- * Catalog line items to add to draft order.
1735
- * @maxSize 300
1736
- */
1737
- catalogLineItems?: CatalogReferenceLineItem[];
1738
- /**
1739
- * Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
1740
- * @maxSize 300
1741
- */
1742
- customLineItems?: CustomLineItem[];
1743
- }
1744
- export interface CatalogReferenceLineItem {
1745
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
1746
- catalogReference?: CatalogReference;
1747
- /**
1748
- * Item quantity.
1749
- * @min 1
1750
- * @max 100000
1751
- */
1752
- quantity?: number;
1753
- /** Item price override. */
1754
- price?: Price;
1755
- /**
1756
- * Line item locations.
1757
- *
1758
- * The location's total quantity must not exceed the line item quantity.
1759
- * @maxSize 5
1760
- */
1761
- locations?: LocationAndQuantity[];
1762
- }
1763
- export interface CustomLineItem {
1764
- /**
1765
- * Line item ID.
1766
- * @format GUID
1767
- */
1768
- _id?: string | null;
1769
- /**
1770
- * Item quantity.
1771
- *
1772
- * Min: `"1"`
1773
- * Max: `"100000"`
1774
- * @min 1
1775
- * @max 100000
1776
- */
1777
- quantity?: number;
1778
- /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
1779
- catalogReference?: CatalogReference;
1780
- /**
1781
- * Item name.
1782
- * + Stores - `product.name`
1783
- * + Bookings - `service.info.name`
1784
- * + Events - `ticket.name`
1785
- */
1786
- productName?: ProductName;
1787
- /** URL to the item's page on the site. */
1788
- url?: string;
1789
- /** Item price **after** catalog-defined discount and line item discounts. */
1790
- price?: Price;
1791
- /** Total line item price **after** catalog-defined discount and line item discounts. */
1792
- lineItemPrice?: Price;
1793
- /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
1794
- fullPrice?: Price;
1795
- /** Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided. */
1796
- priceBeforeDiscounts?: Price;
1797
- /** Line item description lines. Used for display purposes for order. */
1798
- descriptionLines?: DescriptionLine[];
1799
- /** Line item image details. */
1800
- media?: string;
1801
- /** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
1802
- physicalProperties?: PhysicalProperties;
1803
- /** Item type. Either a preset type or custom. */
1804
- itemType?: ItemType;
1805
- /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1806
- priceDescription?: PriceDescription;
1807
- /**
1808
- * Delivery Profile Id for the product
1809
- * @format GUID
1810
- */
1811
- deliveryProfileId?: string | null;
1812
- /**
1813
- * Line item locations.
1814
- *
1815
- * The location's total quantity must not exceed the line item quantity.
1816
- * @maxSize 5
1817
- */
1818
- locations?: LocationAndQuantity[];
1819
- }
1820
- export interface SecuredMedia {
1821
- /**
1822
- * Media ID in Wix Media Manager.
1823
- * @minLength 1
1824
- * @maxLength 100
1825
- */
1826
- _id?: string;
1827
- /**
1828
- * Original filename.
1829
- * @minLength 1
1830
- * @maxLength 1000
1831
- */
1832
- fileName?: string;
1833
- /** File type. */
1834
- fileType?: FileType;
1835
- }
1836
- export declare enum FileType {
1837
- UNSPECIFIED = "UNSPECIFIED",
1838
- SECURE_PICTURE = "SECURE_PICTURE",
1839
- SECURE_VIDEO = "SECURE_VIDEO",
1840
- SECURE_DOCUMENT = "SECURE_DOCUMENT",
1841
- SECURE_MUSIC = "SECURE_MUSIC",
1842
- SECURE_ARCHIVE = "SECURE_ARCHIVE"
1843
- }
1844
- export interface AddLineItemsToDraftOrderResponse {
1845
- /** The draft order details calculated with latest content */
1846
- calculatedDraftOrder?: CalculatedDraftOrder;
1847
- }
1848
- export interface UpdateLineItemsRequest {
1849
- /**
1850
- * The draft order id
1851
- * @format GUID
1852
- */
1853
- draftOrderId: string;
1854
- /**
1855
- * Details of changes to apply per line item
1856
- * @minSize 1
1857
- * @maxSize 300
1858
- */
1859
- lineItemChanges?: LineItemChangeDetails[];
1860
- }
1861
- export interface LineItemChangeDetails {
1862
- /**
1863
- * The line item id to change
1864
- * @format GUID
1865
- */
1866
- lineItemId?: string;
1867
- /**
1868
- * The new quantity for the line item. quantity zero means to remove the line item.
1869
- * @max 1000000
1870
- */
1871
- newQuantity?: number | null;
1872
- /**
1873
- * The new price for 1 unit of the line item
1874
- * @decimalValue options { gte:0, lte:1000000000000000 }
1875
- */
1876
- newPrice?: string | null;
1877
- /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1878
- newPriceDescription?: PriceDescription;
1879
- }
1880
- export interface UpdateLineItemsResponse {
1881
- /** The draft order details calculated with latest content */
1882
- calculatedDraftOrder?: CalculatedDraftOrder;
1883
- }
1884
- export interface SetDiscountsRequest {
1885
- /**
1886
- * The draft order id
1887
- * @format GUID
1888
- */
1889
- draftOrderId: string;
1890
- /**
1891
- * The discount ids to opt-in. all existing discounts not listed are to be opted-out.
1892
- * @minSize 1
1893
- */
1894
- discounts: IdAndApplied[];
1895
- }
1896
- export interface IdAndApplied {
1897
- /** Discount ID. */
1898
- _id?: string;
1899
- /** Whether to apply the discount to the draft order. */
1900
- applied?: boolean;
1901
- }
1902
- export interface SetDiscountsResponse {
1903
- /** The draft order details calculated with latest content */
1904
- calculatedDraftOrder?: CalculatedDraftOrder;
1905
- }
1906
- export interface CreateCustomDiscountsRequest {
1907
- /**
1908
- * The draft order id
1909
- * @format GUID
1910
- */
1911
- draftOrderId: string;
1912
- /**
1913
- * The discounts to add.
1914
- * @minSize 1
1915
- * @maxSize 100
1916
- */
1917
- discounts?: DiscountOption[];
1918
- }
1919
- export interface DiscountOption extends DiscountOptionDiscountAmountOneOf {
1920
- /**
1921
- * Discount type.
1922
- * * `"GLOBAL"` - discount applies to entire order.
1923
- * * `"SPECIFIC-ITEMS"` - discount applies to a specific item.
1924
- * * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
1925
- */
1926
- discountType?: DiscountType;
1927
- /**
1928
- * ID of line item discount applies to.
1929
- * @format GUID
1930
- * @deprecated ID of line item discount applies to.
1931
- * @replacedBy line_item_discounts
1932
- * @targetRemovalDate 2024-10-30
1933
- */
1934
- lineItemId?: string | null;
1935
- /**
1936
- * Discount amount.
1937
- * @deprecated Discount amount.
1938
- * @replacedBy price_amount and percentage
1939
- * @targetRemovalDate 2024-08-30
1940
- */
1941
- amount?: Price;
1942
- /**
1943
- * Discount description as free text (optional).
1944
- * @maxLength 200
1945
- */
1946
- description?: string | null;
1947
- /**
1948
- * Should opt-in the added discount. default = false.
1949
- * if not set or false, then to opt-in them, please call SetDiscounts with the added discounts ids
1950
- */
1951
- applyToDraftOrder?: boolean | null;
1952
- }
1953
- /** @oneof */
1954
- export interface DiscountOptionDiscountAmountOneOf {
1955
- }
1956
- export declare enum DiscountType {
1957
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
1958
- GLOBAL = "GLOBAL",
1959
- SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1960
- SHIPPING = "SHIPPING"
1961
- }
1962
- export interface CreateCustomDiscountsResponse {
1963
- /** The draft order details with the added discounts */
1964
- calculatedDraftOrder?: CalculatedDraftOrder;
1965
- }
1966
- export interface DeleteCustomDiscountsRequest {
1967
- /**
1968
- * The draft order id
1969
- * @format GUID
1970
- */
1971
- draftOrderId: string;
1972
- /**
1973
- * The discounts to remove
1974
- * @format GUID
1975
- * @minSize 1
1976
- * @maxSize 100
1977
- */
1978
- discountIds: string[];
1979
- }
1980
- export interface DeleteCustomDiscountsResponse {
1981
- /** The draft order details calculated with latest content */
1982
- calculatedDraftOrder?: CalculatedDraftOrder;
1983
- }
1984
- export interface SetAdditionalFeesRequest {
1985
- /**
1986
- * The draft order id
1987
- * @format GUID
1988
- */
1989
- draftOrderId: string;
1990
- /**
1991
- * The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out
1992
- * @minSize 1
1993
- * @maxSize 100
1994
- */
1995
- additionalFees: IdAndApplied[];
1996
- }
1997
- export interface SetAdditionalFeesResponse {
1998
- /** The draft order details calculated with modified additional fees */
1999
- calculatedDraftOrder?: CalculatedDraftOrder;
2000
- }
2001
- export interface CreateCustomAdditionalFeesRequest {
2002
- /**
2003
- * The draft order id
2004
- * @format GUID
2005
- */
2006
- draftOrderId: string;
2007
- /**
2008
- * The additional fees to add. added with opted-out setting
2009
- * @minSize 1
2010
- * @maxSize 100
2011
- */
2012
- customAdditionalFees?: AdditionalFeeOption[];
2013
- }
2014
- export interface AdditionalFeeOption {
2015
- /**
2016
- * Translated additional fee's name
2017
- * @minLength 1
2018
- * @maxLength 50
2019
- */
2020
- name?: string;
2021
- /** Additional fee's price */
2022
- price?: Price;
2023
- /** Tax calculation details */
2024
- taxDetails?: TaxDetails;
2025
- /**
2026
- * Should apply the additional fee. default = false.
2027
- * if not set or false, then to apply them, please call ApplyAdditionalFees with the added additional fee ids
2028
- */
2029
- applyToDraftOrder?: boolean | null;
2030
- /**
2031
- * Additional fee's unique code (or ID) for future processing
2032
- * @minLength 1
2033
- * @maxLength 100
2034
- */
2035
- code?: string | null;
2036
- }
2037
- export interface CreateCustomAdditionalFeesResponse {
2038
- /** The draft order details with added custom additional fees */
2039
- calculatedDraftOrder?: CalculatedDraftOrder;
2040
- }
2041
- export interface DeleteCustomAdditionalFeesRequest {
2042
- /**
2043
- * The draft order id
2044
- * @format GUID
2045
- */
2046
- draftOrderId: string;
2047
- /**
2048
- * The additional fees to remove
2049
- * @format GUID
2050
- * @minSize 1
2051
- * @maxSize 100
2052
- */
2053
- customAdditionalFees: string[];
2054
- }
2055
- export interface DeleteCustomAdditionalFeesResponse {
2056
- /** The draft order details calculated with latest content */
2057
- calculatedDraftOrder?: CalculatedDraftOrder;
2058
- }
2059
- export interface SetShippingInfoRequest {
2060
- }
2061
- export interface SetShippingInfoResponse {
2062
- }
2063
- export interface SetBuyerInfoRequest {
2064
- }
2065
- export interface SetBuyerInfoResponse {
2066
- }
2067
- export interface SetRecipientInfoRequest {
2068
- }
2069
- export interface SetRecipientInfoResponse {
2070
- }
2071
- export interface SetBillingInfoRequest {
2072
- }
2073
- export interface SetBillingInfoResponse {
2074
- }
2075
- export interface UpdateShippingInfoRequest {
2076
- /**
2077
- * The draft order id
2078
- * @format GUID
2079
- */
2080
- draftOrderId?: string;
2081
- /** update the shipping option on the order. if not set then the selected shipping is removed */
2082
- shippingOption?: ShippingOption;
2083
- }
2084
- export interface UpdateShippingInfoResponse {
2085
- /** The draft order details calculated with de/selected shipping info */
2086
- calculatedDraftOrder?: CalculatedDraftOrder;
2087
- }
2088
- export interface GetDraftOrderRequest {
2089
- /**
2090
- * The draft order id
2091
- * @format GUID
2092
- */
2093
- draftOrderId: string;
2094
- }
2095
- export interface GetDraftOrderResponse {
2096
- /** The draft order details calculated with latest content */
2097
- calculatedDraftOrder?: CalculatedDraftOrder;
2098
- }
2099
- export interface GetOrderDraftabilityStatusRequest {
2100
- /**
2101
- * Order ID.
2102
- * @minLength 1
2103
- * @maxLength 100
2104
- */
2105
- orderId: string;
2106
- }
2107
- export interface GetOrderDraftabilityStatusResponse {
2108
- /**
2109
- * Order ID.
2110
- * @minLength 1
2111
- * @maxLength 100
2112
- */
2113
- orderId?: string;
2114
- /** Whether a draft can be created from this order */
2115
- orderDraftable?: boolean;
2116
- /**
2117
- * Reasons why the order is not draftable
2118
- * @maxSize 5
2119
- */
2120
- nonDraftableReasons?: NonDraftableReason[];
2121
- }
2122
- export declare enum NonDraftableReason {
2123
- UNSPECIFIED = "UNSPECIFIED",
2124
- PARTIALLY_OR_FULLY_REFUNDED = "PARTIALLY_OR_FULLY_REFUNDED",
2125
- UNSUPPORTED_CHANNEL_TYPE = "UNSUPPORTED_CHANNEL_TYPE",
2126
- ORDER_STATUS_IS_NOT_SUPPORTED = "ORDER_STATUS_IS_NOT_SUPPORTED",
2127
- ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT = "ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT",
2128
- ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT = "ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT",
2129
- AMOUNTS_DO_NOT_ADD_UP = "AMOUNTS_DO_NOT_ADD_UP",
2130
- /** remove - this is not a reason, it's an error */
2131
- ORDER_NOT_FOUND = "ORDER_NOT_FOUND",
2132
- SUBSCRIPTION_LINE_ITEM_EXISTS = "SUBSCRIPTION_LINE_ITEM_EXISTS",
2133
- UNSUPPORTED_CATALOG_ITEM = "UNSUPPORTED_CATALOG_ITEM",
2134
- TAXABLE_EXISTING_ADDITIONAL_FEE = "TAXABLE_EXISTING_ADDITIONAL_FEE"
2135
- }
2136
- export interface CommitDraftOrderRequest {
2137
- /**
2138
- * The draft order id
2139
- * @format GUID
2140
- */
2141
- draftOrderId: string;
2142
- /** Optional side effects to trigger */
2143
- commitSettings?: DraftOrderCommitSettings;
2144
- /**
2145
- * Reason for edit, given by user (optional).
2146
- * @maxLength 200
2147
- */
2148
- reason?: string | null;
2149
- }
2150
- export interface CommitDraftOrderResponse {
2151
- /** The draft order after commit. */
2152
- committedDraftOrder?: DraftOrder;
2153
- /** The updated order after commit. */
2154
- orderAfterCommit?: Order;
2155
- }
2156
- export interface Order {
2157
- /**
2158
- * Order ID.
2159
- * @format GUID
2160
- * @readonly
2161
- */
2162
- _id?: string | null;
2163
- /**
2164
- * Order number displayed in the site owner's dashboard (auto-generated).
2165
- * @readonly
2166
- */
2167
- number?: string;
2168
- /**
2169
- * Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
2170
- * @readonly
2171
- * @immutable
2172
- */
2173
- _createdDate?: Date | null;
2174
- /**
2175
- * Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
2176
- * @readonly
2177
- */
2178
- _updatedDate?: Date | null;
2179
- /**
2180
- * Order line items.
2181
- * @minSize 1
2182
- * @maxSize 300
2183
- * @readonly
2184
- */
2185
- lineItems?: OrderLineItem[];
2186
- /** Buyer information. */
2187
- buyerInfo?: BuyerInfo;
2188
- /** Order payment status. */
2189
- paymentStatus?: PaymentStatus;
2190
- /**
2191
- * Order fulfillment status.
2192
- * @readonly
2193
- */
2194
- fulfillmentStatus?: FulfillmentStatus;
2195
- /**
2196
- * Language for communication with the buyer. Defaults to the site language.
2197
- * For a site that supports multiple languages, this is the language the buyer selected.
2198
- */
2199
- buyerLanguage?: string | null;
2200
- /** Weight measurement unit - defaults to site's weight unit. */
2201
- weightUnit?: WeightUnit;
2202
- /**
2203
- * 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.
2204
- * @format CURRENCY
2205
- */
2206
- currency?: string | null;
2207
- /** Multi-currency information of the order. */
2208
- currencyConversionDetails?: CurrencyConversionDetails;
2209
- /**
2210
- * Whether tax is included in line item prices.
2211
- * @immutable
2212
- */
2213
- taxIncludedInPrices?: boolean;
2214
- /**
2215
- * Site language in which original values are shown.
2216
- * @readonly
2217
- * @immutable
2218
- */
2219
- siteLanguage?: string | null;
2220
- /**
2221
- * Order price summary.
2222
- * @readonly
2223
- */
2224
- priceSummary?: PriceSummary;
2225
- /** Billing address and contact details. */
2226
- billingInfo?: AddressWithContact;
2227
- /** Shipping info and selected shipping option details. */
2228
- shippingInfo?: V1ShippingInformation;
2229
- /**
2230
- * [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
2231
- * @maxLength 1000
2232
- */
2233
- buyerNote?: string | null;
2234
- /** Order status. */
2235
- status?: OrderStatus;
2236
- /** Whether order is archived. */
2237
- archived?: boolean | null;
2238
- /**
2239
- * Tax summary.
2240
- * Deprecated. Use `taxInfo` instead.
2241
- * This field will be removed on September 30, 2024.
2242
- * @deprecated Tax summary.
2243
- * Deprecated. Use `taxInfo` instead.
2244
- * This field will be removed on September 30, 2024.
2245
- * @replacedBy tax_info
2246
- * @targetRemovalDate 2024-09-30
2247
- */
2248
- taxSummary?: TaxSummary;
2249
- /** Tax information. */
2250
- taxInfo?: OrderTaxInfo;
2251
- /**
2252
- * Applied discounts.
2253
- * @maxSize 320
2254
- */
2255
- appliedDiscounts?: AppliedDiscount[];
2256
- /**
2257
- * Order activities.
2258
- * @readonly
2259
- * @maxSize 1000
2260
- */
2261
- activities?: Activity[];
2262
- /** Order attribution source. */
2263
- attributionSource?: AttributionSource;
2264
- /**
2265
- * ID of the order's initiator.
2266
- * @readonly
2267
- */
2268
- createdBy?: V1CreatedBy;
2269
- /** Information about the sales channel that submitted this order. */
2270
- channelInfo?: ChannelInfo;
2271
- /** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */
2272
- seenByAHuman?: boolean | null;
2273
- /**
2274
- * Checkout ID.
2275
- * @format GUID
2276
- */
2277
- checkoutId?: string | null;
2278
- /** Custom fields. */
2279
- customFields?: CustomField[];
2280
- /**
2281
- * Balance summary.
2282
- * @readonly
2283
- */
2284
- balanceSummary?: V1BalanceSummary;
2285
- /**
2286
- * Additional fees applied to the order.
2287
- * @maxSize 100
2288
- */
2289
- additionalFees?: AdditionalFee[];
2290
- /**
2291
- * Custom field data for the order object.
2292
- *
2293
- * [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.
2294
- */
2295
- extendedFields?: ExtendedFields;
2296
- /**
2297
- * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
2298
- * @format GUID
2299
- */
2300
- purchaseFlowId?: string | null;
2301
- /**
2302
- * Order recipient address and contact details.
2303
- *
2304
- * This field may differ from the address in `shippingInfo.logistics` when:
2305
- * + The chosen shipping option is pickup point or store pickup.
2306
- * + No shipping option is selected.
2307
- */
2308
- recipientInfo?: AddressWithContact;
2309
- /**
2310
- * Order tags.
2311
- *
2312
- * [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction) are labels attached to entities, allowing for flexible categorization and data management.
2313
- */
2314
- tags?: Tags;
2315
- /**
2316
- * Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
2317
- * Used for migration from external systems.
2318
- * @immutable
2319
- */
2320
- purchasedDate?: Date | null;
2321
- /** Order Location */
2322
- businessLocation?: Location;
2323
- }
2324
- export declare enum PaymentStatus {
2325
- UNSPECIFIED = "UNSPECIFIED",
2326
- /**
2327
- * `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
2328
- * This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`.
2329
- */
2330
- NOT_PAID = "NOT_PAID",
2331
- /** All required payments associated with this order are paid. */
2332
- PAID = "PAID",
2333
- /** Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details. */
2334
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
2335
- /** Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details. */
2336
- FULLY_REFUNDED = "FULLY_REFUNDED",
2337
- /**
2338
- * All payments pending.
2339
- *
2340
- * 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.
2341
- * Learn more about [pending orders](https://support.wix.com/en/article/pending-orders).
2342
- */
2343
- PENDING = "PENDING",
2344
- /** At least one payment received and approved, but it covers less than the order's total price. See `order.balanceSummary` for more details. */
2345
- PARTIALLY_PAID = "PARTIALLY_PAID",
2346
- /**
2347
- * Payment received, but not yet confirmed by the payment provider.
2348
- *
2349
- * In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner.
2350
- * 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.
2351
- * @documentationMaturity preview
2352
- */
2353
- PENDING_MERCHANT = "PENDING_MERCHANT",
2354
- /**
2355
- * One or more payments canceled.
2356
- * @documentationMaturity preview
2357
- */
2358
- CANCELED = "CANCELED",
2359
- /**
2360
- * One or more payments declined.
2361
- * @documentationMaturity preview
2362
- */
2363
- DECLINED = "DECLINED"
2364
- }
2365
- export declare enum FulfillmentStatus {
2366
- /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
2367
- NOT_FULFILLED = "NOT_FULFILLED",
2368
- /**
2369
- * All of the order items are fulfilled or the order was manually marked as fulfilled.
2370
- * Orders without shipping info are fulfilled automatically.
2371
- */
2372
- FULFILLED = "FULFILLED",
2373
- /** Some, but not all, of the order items are fulfilled. */
2374
- PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
2375
- }
2376
- export interface CurrencyConversionDetails {
2377
- /**
2378
- * Original currency used to calculate the pricing before conversion to payment currency set on the order [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
2379
- * @readonly
2380
- * @immutable
2381
- * @format CURRENCY
2382
- */
2383
- originalCurrency?: string | null;
2384
- /**
2385
- * The rate used when converting from the original currency to the payment currency.
2386
- * @readonly
2387
- * @immutable
2388
- * @decimalValue options { gt:0, lte:1000000000000000 }
2389
- */
2390
- conversionRate?: string | null;
2391
- }
2392
- export declare enum OrderStatus {
2393
- /** Order created, but not yet approved or canceled. */
2394
- INITIALIZED = "INITIALIZED",
2395
- /**
2396
- * Order approved.
2397
- *
2398
- * This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order).
2399
- * Offline orders (cash payment) are automatically approved.
2400
- */
2401
- APPROVED = "APPROVED",
2402
- /** Order canceled by the user. */
2403
- CANCELED = "CANCELED",
2404
- /**
2405
- * Order pending.
2406
- * @documentationMaturity preview
2407
- */
2408
- PENDING = "PENDING",
2409
- /**
2410
- * Order rejected.
2411
- *
2412
- * This happens when pending payments fail.
2413
- * @documentationMaturity preview
2414
- */
2415
- REJECTED = "REJECTED"
2416
- }
2417
- export interface Activity extends ActivityContentOneOf {
2418
- /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
2419
- customActivity?: CustomActivity;
2420
- /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
2421
- merchantComment?: MerchantComment;
2422
- /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
2423
- orderRefunded?: OrderRefunded;
2424
- /**
2425
- * Activity ID.
2426
- * @format GUID
2427
- * @readonly
2428
- */
2429
- _id?: string | null;
2430
- /**
2431
- * Activity author's email.
2432
- * @format EMAIL
2433
- * @readonly
2434
- */
2435
- authorEmail?: string | null;
2436
- /**
2437
- * Activity creation date and time.
2438
- * @readonly
2439
- */
2440
- _createdDate?: Date | null;
2441
- /** Activity type. */
2442
- type?: ActivityType;
2443
- }
2444
- /** @oneof */
2445
- export interface ActivityContentOneOf {
2446
- /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
2447
- customActivity?: CustomActivity;
2448
- /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
2449
- merchantComment?: MerchantComment;
2450
- /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
2451
- orderRefunded?: OrderRefunded;
2452
- }
2453
- export interface CustomActivity {
2454
- /**
2455
- * ID of the app that created the custom activity.
2456
- * @format GUID
2457
- */
2458
- appId?: string;
2459
- /**
2460
- * Custom activity type. For example, `"Ticket number set"`.
2461
- * @maxLength 100
2462
- */
2463
- type?: string;
2464
- /** Additional data in key-value form. For example, `{ "Ticket number": "123456" }`. */
2465
- additionalData?: Record<string, string>;
2466
- }
2467
- /** Store owner added a comment */
2468
- export interface MerchantComment {
2469
- /**
2470
- * Merchant comment message.
2471
- * @minLength 1
2472
- * @maxLength 5000
2473
- */
2474
- message?: string;
2475
- }
2476
- export interface OrderRefunded {
2477
- /** Whether order was refunded manually. For example, via payment provider or using cash. */
2478
- manual?: boolean;
2479
- /** Refund amount. */
2480
- amount?: Price;
2481
- /**
2482
- * Reason for refund.
2483
- * @maxLength 200
2484
- */
2485
- reason?: string;
2486
- }
2487
- export interface OrderCreatedFromExchange {
2488
- /**
2489
- * ID of the original order for which the exchange happened.
2490
- * @format GUID
2491
- */
2492
- originalOrderId?: string;
2493
- }
2494
- export interface NewExchangeOrderCreated {
2495
- /**
2496
- * ID of the new order created as a result of an exchange of items.
2497
- * @format GUID
2498
- */
2499
- exchangeOrderId?: string;
2500
- /**
2501
- * IDs of the items that were exchanged.
2502
- * @minSize 1
2503
- * @maxSize 300
2504
- */
2505
- lineItems?: LineItemExchangeData[];
2506
- }
2507
- export interface LineItemExchangeData {
2508
- /**
2509
- * ID of the exchanged line item.
2510
- * @format GUID
2511
- */
2512
- lineItemId?: string;
2513
- /**
2514
- * Line item quantity being exchanged.
2515
- * @min 1
2516
- * @max 100000
2517
- */
2518
- quantity?: number;
2519
- }
2520
- export interface DraftOrderChangesApplied {
2521
- /** Draft order id. */
2522
- draftOrderId?: string;
2523
- /**
2524
- * Reason for edit, given by user (optional).
2525
- * @maxLength 200
2526
- */
2527
- reason?: string | null;
2528
- /** Changes applied to order. */
2529
- changes?: OrderChange[];
2530
- }
2531
- export interface OrderChange extends OrderChangeValueOneOf {
2532
- lineItemChanged?: LineItemChanges;
2533
- lineItemAdded?: ManagedLineItem;
2534
- lineItemRemoved?: ManagedLineItem;
2535
- discountAdded?: ManagedDiscount;
2536
- discountRemoved?: ManagedDiscount;
2537
- additionalFeeAdded?: ManagedAdditionalFee;
2538
- additionalFeeRemoved?: ManagedAdditionalFee;
2539
- totalPriceChanged?: TotalPriceChange;
2540
- shippingInformationChanged?: ShippingInformationChange;
2541
- }
2542
- /** @oneof */
2543
- export interface OrderChangeValueOneOf {
2544
- lineItemChanged?: LineItemChanges;
2545
- lineItemAdded?: ManagedLineItem;
2546
- lineItemRemoved?: ManagedLineItem;
2547
- discountAdded?: ManagedDiscount;
2548
- discountRemoved?: ManagedDiscount;
2549
- additionalFeeAdded?: ManagedAdditionalFee;
2550
- additionalFeeRemoved?: ManagedAdditionalFee;
2551
- totalPriceChanged?: TotalPriceChange;
2552
- shippingInformationChanged?: ShippingInformationChange;
2553
- }
2554
- export interface LineItemChanges {
2555
- /**
2556
- * Line item ID.
2557
- * @format GUID
2558
- */
2559
- _id?: string;
2560
- /** Item name. */
2561
- name?: ProductName;
2562
- /** Item quantity change. */
2563
- quantity?: LineItemQuantityChange;
2564
- /** Item price change. */
2565
- price?: LineItemPriceChange;
2566
- }
2567
- export interface LineItemQuantityChange {
2568
- /**
2569
- * Item quantity before update.
2570
- * @max 1000000
2571
- */
2572
- originalQuantity?: number;
2573
- /**
2574
- * Item quantity after update.
2575
- * @max 1000000
2576
- */
2577
- newQuantity?: number;
2578
- /**
2579
- * Difference between original and new quantity. Absolute value.
2580
- * @min 1
2581
- * @max 1000000
2582
- */
2583
- diff?: number;
2584
- /** Type of quantity change: increase or decrease. */
2585
- deltaType?: LineItemQuantityChangeType;
2586
- }
2587
- export declare enum LineItemQuantityChangeType {
2588
- /** Quantity increased. */
2589
- QUANTITY_INCREASED = "QUANTITY_INCREASED",
2590
- /** Quantity decreased. */
2591
- QUANTITY_DECREASED = "QUANTITY_DECREASED"
2592
- }
2593
- export interface LineItemPriceChange {
2594
- /** Item price before update. */
2595
- originalPrice?: Price;
2596
- /** Item price after update. */
2597
- newPrice?: Price;
2598
- }
2599
- export interface ManagedLineItem {
2600
- /**
2601
- * Line item ID.
2602
- * @format GUID
2603
- */
2604
- _id?: string;
2605
- /** Item name. */
2606
- name?: ProductName;
2607
- /**
2608
- * Added or removed item quantity.
2609
- * @min 1
2610
- * @max 1000000
2611
- */
2612
- quantity?: number;
2613
- }
2614
- export interface ManagedDiscount {
2615
- /**
2616
- * Discount id.
2617
- * @format GUID
2618
- */
2619
- _id?: string;
2620
- /** Discount name: coupon name / discount rule name / merchant discount description. */
2621
- name?: TranslatedValue;
2622
- /** Line items discount applies to. */
2623
- affectedLineItems?: LineItemAmount[];
2624
- /** Discount amount. */
2625
- totalAmount?: Price;
2626
- }
2627
- export interface TranslatedValue {
2628
- /**
2629
- * Value in site default language.
2630
- * @minLength 1
2631
- */
2632
- original?: string;
2633
- /**
2634
- * Translated value.
2635
- * @minLength 1
2636
- */
2637
- translated?: string | null;
2638
- }
2639
- export interface LineItemAmount {
2640
- /**
2641
- * Order line item id
2642
- * @format GUID
2643
- */
2644
- _id?: string;
2645
- /** Item name. */
2646
- name?: ProductName;
2647
- /** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
2648
- amount?: Price;
2649
- }
2650
- export interface ManagedAdditionalFee {
2651
- /**
2652
- * Additional fee id.
2653
- * @format GUID
2654
- */
2655
- _id?: string;
2656
- /** Additional fee name. */
2657
- name?: TranslatedValue;
2658
- /** Line items additional fee applies to. */
2659
- affectedLineItems?: LineItemAmount[];
2660
- /** Additional fee amount. */
2661
- totalAmount?: Price;
2662
- }
2663
- export interface TotalPriceChange {
2664
- /** Order’s total price after discounts and tax. Before update */
2665
- originalTotal?: Price;
2666
- /** Order’s total price after discounts and tax. After update */
2667
- newTotal?: Price;
2668
- }
2669
- export interface ShippingInformationChange {
2670
- /** Order’s Shipping Information. Before update */
2671
- originalShippingInfo?: ShippingInformation;
2672
- /** Order’s Shipping Information. After update */
2673
- newShippingInfo?: ShippingInformation;
2674
- }
2675
- export interface ShippingInformation {
2676
- /** Order’s shipping price. */
2677
- total?: Price;
2678
- /**
2679
- * Order’s shipping title.
2680
- * @maxLength 250
2681
- */
2682
- shippingTitle?: string;
2683
- }
2684
- /** Payment method is saved for order */
2685
- export interface SavedPaymentMethod {
2686
- /**
2687
- * Payment method name
2688
- * @minLength 1
2689
- * @maxLength 100
2690
- */
2691
- name?: string;
2692
- /**
2693
- * Payment method description
2694
- * @minLength 1
2695
- * @maxLength 100
2696
- */
2697
- description?: string | null;
2698
- }
2699
- export interface AuthorizedPaymentCreated {
2700
- /**
2701
- * Payment ID of payment associated with this activity
2702
- * @format GUID
2703
- */
2704
- paymentId?: string;
2705
- /** Payment amount */
2706
- amount?: Price;
2707
- /**
2708
- * The last 4 digits of the card number.
2709
- * @maxLength 4
2710
- */
2711
- lastFourDigits?: string | null;
2712
- /**
2713
- * Card issuer's brand.
2714
- * @maxLength 100
2715
- */
2716
- brand?: string | null;
2717
- }
2718
- export interface AuthorizedPaymentCaptured {
2719
- /**
2720
- * Payment ID of payment associated with this activity
2721
- * @format GUID
2722
- */
2723
- paymentId?: string;
2724
- /** Payment amount */
2725
- amount?: Price;
2726
- /**
2727
- * The last 4 digits of the card number.
2728
- * @maxLength 4
2729
- */
2730
- lastFourDigits?: string | null;
2731
- /**
2732
- * Card issuer's brand.
2733
- * @maxLength 100
2734
- */
2735
- brand?: string | null;
2736
- }
2737
- export interface AuthorizedPaymentVoided {
2738
- /**
2739
- * Payment ID of payment associated with this activity
2740
- * @format GUID
2741
- */
2742
- paymentId?: string;
2743
- /** Payment amount */
2744
- amount?: Price;
2745
- /**
2746
- * The last 4 digits of the card number.
2747
- * @maxLength 4
2748
- */
2749
- lastFourDigits?: string | null;
2750
- /**
2751
- * Card issuer's brand.
2752
- * @maxLength 100
2753
- */
2754
- brand?: string | null;
2755
- }
2756
- export interface RefundInitiated {
2757
- /**
2758
- * Refund ID.
2759
- * @format GUID
2760
- */
2761
- refundId?: string;
2762
- /** Refund amount. */
2763
- amount?: Price;
2764
- /**
2765
- * Details about the payments being refunded.
2766
- * @minSize 1
2767
- * @maxSize 50
2768
- */
2769
- payments?: RefundedPayment[];
2770
- /**
2771
- * Reason for refund.
2772
- * @maxLength 100
2773
- */
2774
- reason?: string | null;
2775
- }
2776
- export interface RefundedPayment extends RefundedPaymentKindOneOf {
2777
- /** Regular payment refund. */
2778
- regular?: RegularPaymentRefund;
2779
- /** Gift card payment refund. */
2780
- giftCard?: GiftCardPaymentRefund;
2781
- /** Membership payment refund. */
2782
- membership?: MembershipPaymentRefund;
2783
- /**
2784
- * Payment ID.
2785
- * @format GUID
2786
- */
2787
- paymentId?: string;
2788
- /** Whether refund was made externally and manually on the payment provider's side. */
2789
- externalRefund?: boolean;
2790
- }
2791
- /** @oneof */
2792
- export interface RefundedPaymentKindOneOf {
2793
- /** Regular payment refund. */
2794
- regular?: RegularPaymentRefund;
2795
- /** Gift card payment refund. */
2796
- giftCard?: GiftCardPaymentRefund;
2797
- /** Membership payment refund. */
2798
- membership?: MembershipPaymentRefund;
2799
- }
2800
- export interface RegularPaymentRefund {
2801
- /** Refund amount */
2802
- amount?: Price;
2803
- /**
2804
- * The last 4 digits of the card number.
2805
- * @maxLength 4
2806
- */
2807
- lastFourDigits?: string | null;
2808
- /**
2809
- * Card issuer's brand.
2810
- * @maxLength 100
2811
- */
2812
- brand?: string | null;
2813
- }
2814
- export interface GiftCardPaymentRefund {
2815
- /**
2816
- * Gift card payment ID
2817
- * @minLength 1
2818
- * @maxLength 100
2819
- */
2820
- giftCardPaymentId?: string | null;
2821
- /** Refund amount */
2822
- amount?: Price;
2823
- }
2824
- export interface MembershipPaymentRefund {
2825
- /**
2826
- * Membership ID
2827
- * @minLength 1
2828
- * @maxLength 100
2829
- */
2830
- membershipId?: string | null;
2831
- }
2832
- export interface PaymentRefunded {
2833
- /**
2834
- * Refund ID.
2835
- * @format GUID
2836
- */
2837
- refundId?: string;
2838
- /** Details about the refunded payment. */
2839
- payment?: RefundedPayment;
2840
- }
2841
- export interface PaymentRefundFailed {
2842
- /**
2843
- * Refund ID.
2844
- * @format GUID
2845
- */
2846
- refundId?: string;
2847
- /** Details about the failed payment refund. */
2848
- payment?: RefundedPayment;
2849
- }
2850
- export interface RefundedAsStoreCredit {
2851
- /** Refund amount */
2852
- amount?: Price;
2853
- /**
2854
- * Reason for refund
2855
- * @maxLength 100
2856
- */
2857
- reason?: string | null;
2858
- }
2859
- export interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {
2860
- /** Regular payment. */
2861
- regular?: RegularPayment;
2862
- /**
2863
- * Payment ID of payment associated with this activity
2864
- * @format GUID
2865
- */
2866
- paymentId?: string;
2867
- }
2868
- /** @oneof */
2869
- export interface PaymentPendingPaymentDetailsOneOf {
2870
- /** Regular payment. */
2871
- regular?: RegularPayment;
2872
- }
2873
- export interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {
2874
- /** Whether regular card used */
2875
- creditCardDetails?: CreditCardDetails;
2876
- /** Payment amount */
2877
- amount?: Price;
2878
- }
2879
- /** @oneof */
2880
- export interface RegularPaymentPaymentMethodDetailsOneOf {
2881
- /** Whether regular card used */
2882
- creditCardDetails?: CreditCardDetails;
2883
- }
2884
- export interface CreditCardDetails {
2885
- /**
2886
- * The last 4 digits of the card number.
2887
- * @maxLength 4
2888
- */
2889
- lastFourDigits?: string | null;
2890
- /**
2891
- * Card issuer's brand.
2892
- * @maxLength 100
2893
- */
2894
- brand?: string | null;
2895
- }
2896
- export interface PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {
2897
- /** Regular payment. */
2898
- regular?: RegularPayment;
2899
- /**
2900
- * Payment ID of payment associated with this activity
2901
- * @format GUID
2902
- */
2903
- paymentId?: string;
2904
- }
2905
- /** @oneof */
2906
- export interface PaymentCanceledPaymentDetailsOneOf {
2907
- /** Regular payment. */
2908
- regular?: RegularPayment;
2909
- }
2910
- export interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {
2911
- /** Regular payment. */
2912
- regular?: RegularPayment;
2913
- /**
2914
- * Payment ID of payment associated with this activity
2915
- * @format GUID
2916
- */
2917
- paymentId?: string;
2918
- }
2919
- /** @oneof */
2920
- export interface PaymentDeclinedPaymentDetailsOneOf {
2921
- /** Regular payment. */
2922
- regular?: RegularPayment;
2923
- }
2924
- export interface ReceiptCreated extends ReceiptCreatedReceiptInfoOneOf {
2925
- /** Receipt created by Wix */
2926
- wixReceipt?: WixReceipt;
2927
- /** Receipt created by an external system. */
2928
- externalReceipt?: ExternalReceipt;
2929
- /**
2930
- * Payment ID of payment associated with this activity
2931
- * @format GUID
2932
- */
2933
- paymentId?: string;
2934
- }
2935
- /** @oneof */
2936
- export interface ReceiptCreatedReceiptInfoOneOf {
2937
- /** Receipt created by Wix */
2938
- wixReceipt?: WixReceipt;
2939
- /** Receipt created by an external system. */
2940
- externalReceipt?: ExternalReceipt;
2941
- }
2942
- export interface WixReceipt {
2943
- /**
2944
- * Receipt ID
2945
- * @format GUID
2946
- */
2947
- receiptId?: string;
2948
- /**
2949
- * Display number of receipt
2950
- * @minLength 1
2951
- * @maxLength 40
2952
- */
2953
- displayNumber?: string | null;
2954
- }
2955
- export interface ExternalReceipt {
2956
- /**
2957
- * Receipt ID
2958
- * @maxLength 100
2959
- */
2960
- receiptId?: string | null;
2961
- /**
2962
- * Display number of receipt
2963
- * @minLength 1
2964
- * @maxLength 40
2965
- */
2966
- displayNumber?: string | null;
2967
- }
2968
- export interface ReceiptSent extends ReceiptSentReceiptInfoOneOf {
2969
- /** Receipt created by Wix */
2970
- wixReceipt?: WixReceipt;
2971
- /** Receipt created by an external system. */
2972
- externalReceipt?: ExternalReceipt;
2973
- /**
2974
- * Payment ID of payment associated with this activity
2975
- * @format GUID
2976
- */
2977
- paymentId?: string;
2978
- }
2979
- /** @oneof */
2980
- export interface ReceiptSentReceiptInfoOneOf {
2981
- /** Receipt created by Wix */
2982
- wixReceipt?: WixReceipt;
2983
- /** Receipt created by an external system. */
2984
- externalReceipt?: ExternalReceipt;
2985
- }
2986
- export declare enum ActivityType {
2987
- ORDER_REFUNDED = "ORDER_REFUNDED",
2988
- ORDER_PLACED = "ORDER_PLACED",
2989
- ORDER_PAID = "ORDER_PAID",
2990
- ORDER_FULFILLED = "ORDER_FULFILLED",
2991
- ORDER_NOT_FULFILLED = "ORDER_NOT_FULFILLED",
2992
- ORDER_CANCELED = "ORDER_CANCELED",
2993
- DOWNLOAD_LINK_SENT = "DOWNLOAD_LINK_SENT",
2994
- TRACKING_NUMBER_ADDED = "TRACKING_NUMBER_ADDED",
2995
- TRACKING_NUMBER_EDITED = "TRACKING_NUMBER_EDITED",
2996
- TRACKING_LINK_ADDED = "TRACKING_LINK_ADDED",
2997
- SHIPPING_CONFIRMATION_EMAIL_SENT = "SHIPPING_CONFIRMATION_EMAIL_SENT",
2998
- INVOICE_ADDED = "INVOICE_ADDED",
2999
- INVOICE_REMOVED = "INVOICE_REMOVED",
3000
- INVOICE_SENT = "INVOICE_SENT",
3001
- FULFILLER_EMAIL_SENT = "FULFILLER_EMAIL_SENT",
3002
- SHIPPING_ADDRESS_EDITED = "SHIPPING_ADDRESS_EDITED",
3003
- EMAIL_EDITED = "EMAIL_EDITED",
3004
- PICKUP_READY_EMAIL_SENT = "PICKUP_READY_EMAIL_SENT",
3005
- CUSTOM_ACTIVITY = "CUSTOM_ACTIVITY",
3006
- MERCHANT_COMMENT = "MERCHANT_COMMENT",
3007
- ORDER_CREATED_FROM_EXCHANGE = "ORDER_CREATED_FROM_EXCHANGE",
3008
- NEW_EXCHANGE_ORDER_CREATED = "NEW_EXCHANGE_ORDER_CREATED",
3009
- ORDER_PARTIALLY_PAID = "ORDER_PARTIALLY_PAID",
3010
- DRAFT_ORDER_CHANGES_APPLIED = "DRAFT_ORDER_CHANGES_APPLIED",
3011
- SAVED_PAYMENT_METHOD = "SAVED_PAYMENT_METHOD",
3012
- /** @documentationMaturity preview */
3013
- PAYMENT_PENDING = "PAYMENT_PENDING",
3014
- /** @documentationMaturity preview */
3015
- PAYMENT_CANCELED = "PAYMENT_CANCELED",
3016
- /** @documentationMaturity preview */
3017
- PAYMENT_DECLINED = "PAYMENT_DECLINED",
3018
- /** @documentationMaturity preview */
3019
- ORDER_PENDING = "ORDER_PENDING",
3020
- /** @documentationMaturity preview */
3021
- ORDER_REJECTED = "ORDER_REJECTED"
3022
- }
3023
- export declare enum AttributionSource {
3024
- UNSPECIFIED = "UNSPECIFIED",
3025
- FACEBOOK_ADS = "FACEBOOK_ADS"
3026
- }
3027
- export interface V1CreatedBy extends V1CreatedByStringOneOf {
3028
- /**
3029
- * User ID - when the order was created by a Wix user on behalf of a buyer.
3030
- * For example, via POS (point of service).
3031
- * @format GUID
3032
- */
3033
- userId?: string;
3034
- /**
3035
- * Member ID - when the order was created by a **logged in** site visitor.
3036
- * @format GUID
3037
- */
3038
- memberId?: string;
3039
- /**
3040
- * Visitor ID - when the order was created by a site visitor that was **not** logged in.
3041
- * @format GUID
3042
- */
3043
- visitorId?: string;
3044
- /**
3045
- * App ID - when the order was created by an external application.
3046
- * @format GUID
3047
- */
3048
- appId?: string;
3049
- }
3050
- /** @oneof */
3051
- export interface V1CreatedByStringOneOf {
3052
- /**
3053
- * User ID - when the order was created by a Wix user on behalf of a buyer.
3054
- * For example, via POS (point of service).
3055
- * @format GUID
3056
- */
3057
- userId?: string;
3058
- /**
3059
- * Member ID - when the order was created by a **logged in** site visitor.
3060
- * @format GUID
3061
- */
3062
- memberId?: string;
3063
- /**
3064
- * Visitor ID - when the order was created by a site visitor that was **not** logged in.
3065
- * @format GUID
3066
- */
3067
- visitorId?: string;
3068
- /**
3069
- * App ID - when the order was created by an external application.
3070
- * @format GUID
3071
- */
3072
- appId?: string;
3073
- }
3074
- export interface ChannelInfo {
3075
- /** Sales channel that submitted the order. */
3076
- type?: ChannelType;
3077
- /**
3078
- * Reference to an order ID from an external system.
3079
- * @maxLength 100
3080
- */
3081
- externalOrderId?: string | null;
3082
- /**
3083
- * URL to the order in the external system.
3084
- * @maxLength 300
3085
- */
3086
- externalOrderUrl?: string | null;
3087
- }
3088
- export declare enum ChannelType {
3089
- /** Unspecified sales channel. This value is not supported. */
3090
- UNSPECIFIED = "UNSPECIFIED",
3091
- /** A web client. */
3092
- WEB = "WEB",
3093
- /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */
3094
- POS = "POS",
3095
- /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */
3096
- EBAY = "EBAY",
3097
- /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */
3098
- AMAZON = "AMAZON",
3099
- /** Other sales platform. */
3100
- OTHER_PLATFORM = "OTHER_PLATFORM",
3101
- /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */
3102
- WIX_APP_STORE = "WIX_APP_STORE",
3103
- /** 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) */
3104
- WIX_INVOICES = "WIX_INVOICES",
3105
- /** Wix merchant backoffice. */
3106
- BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
3107
- /** Wish sales channel. */
3108
- WISH = "WISH",
3109
- /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */
3110
- CLASS_PASS = "CLASS_PASS",
3111
- /** Global-E sales channel. */
3112
- GLOBAL_E = "GLOBAL_E",
3113
- /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */
3114
- FACEBOOK = "FACEBOOK",
3115
- /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */
3116
- ETSY = "ETSY",
3117
- /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */
3118
- TIKTOK = "TIKTOK",
3119
- /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
3120
- FAIRE_COM = "FAIRE_COM"
3121
- }
3122
- export interface CustomField {
3123
- /** Custom field value. */
3124
- value?: any;
3125
- /**
3126
- * Custom field title.
3127
- * @minLength 1
3128
- * @maxLength 500
3129
- */
3130
- title?: string;
3131
- /**
3132
- * Translated custom field title.
3133
- * @minLength 1
3134
- * @maxLength 500
3135
- */
3136
- translatedTitle?: string | null;
3137
- }
3138
- export interface V1BalanceSummary {
3139
- /**
3140
- * Current amount left to pay.
3141
- * @readonly
3142
- */
3143
- balance?: Balance;
3144
- /**
3145
- * Sum of all approved and successful payments.
3146
- *
3147
- * The value includes payments that have subsequently been fully or partially refunded.
3148
- * @readonly
3149
- */
3150
- paid?: Price;
3151
- /**
3152
- * Sum of all successfully refunded payments.
3153
- * @readonly
3154
- */
3155
- refunded?: Price;
3156
- /**
3157
- * Sum of all authorized payments.
3158
- * @readonly
3159
- */
3160
- authorized?: Price;
3161
- /**
3162
- * Sum of all pending transactions.
3163
- * @readonly
3164
- */
3165
- pending?: Price;
3166
- }
3167
- export interface FulfillmentStatusesAggregate {
3168
- /** Unique string values based on Fulfillment entities statuses */
3169
- statuses?: string[] | null;
3170
- }
3171
- /**
3172
- * Common object for tags.
3173
- * Should be use as in this example:
3174
- * message Foo {
3175
- * string id = 1;
3176
- * ...
3177
- * Tags tags = 5
3178
- * }
3179
- *
3180
- * example of taggable entity
3181
- * {
3182
- * id: "123"
3183
- * tags: {
3184
- * tags: {
3185
- * tag_ids:["11","22"]
3186
- * },
3187
- * private_tags: {
3188
- * tag_ids: ["33", "44"]
3189
- * }
3190
- * }
3191
- * }
3192
- */
3193
- export interface Tags {
3194
- /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
3195
- privateTags?: TagList;
3196
- /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
3197
- tags?: TagList;
3198
- }
3199
- export interface TagList {
3200
- /**
3201
- * List of tag IDs
3202
- * @maxSize 100
3203
- * @maxLength 5
3204
- */
3205
- tagIds?: string[];
3206
- }
3207
- export interface CreateOrderFromDraftRequest {
3208
- }
3209
- export interface OrderCreateSettings {
3210
- }
3211
- export interface OrderCreateNotifications {
3212
- }
3213
- export interface CreateOrderFromDraftResponse {
3214
- }
3215
- export interface DeleteDraftOrderRequest {
3216
- /**
3217
- * The draft order id
3218
- * @format GUID
3219
- */
3220
- draftOrderId: string;
3221
- }
3222
- export interface DeleteDraftOrderResponse {
3223
- }
3224
- export interface QueryDraftOrdersRequest {
3225
- /** WQL expression */
3226
- query?: CursorQuery;
3227
- }
3228
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
3229
- /**
3230
- * Cursor paging options.
3231
- *
3232
- * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
3233
- */
3234
- cursorPaging?: CursorPaging;
3235
- /**
3236
- * Filter object.
3237
- *
3238
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
3239
- */
3240
- filter?: Record<string, any> | null;
3241
- /**
3242
- * Sort object.
3243
- *
3244
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
3245
- * @maxSize 5
3246
- */
3247
- sort?: Sorting[];
3248
- }
3249
- /** @oneof */
3250
- export interface CursorQueryPagingMethodOneOf {
3251
- /**
3252
- * Cursor paging options.
3253
- *
3254
- * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
3255
- */
3256
- cursorPaging?: CursorPaging;
3257
- }
3258
- export interface Sorting {
3259
- /**
3260
- * Name of the field to sort by.
3261
- * @maxLength 512
3262
- */
3263
- fieldName?: string;
3264
- /** Sort order. */
3265
- order?: SortOrder;
3266
- }
3267
- export declare enum SortOrder {
3268
- ASC = "ASC",
3269
- DESC = "DESC"
3270
- }
3271
- export interface CursorPaging {
3272
- /**
3273
- * Maximum number of items to return in the results.
3274
- * @max 100
3275
- */
3276
- limit?: number | null;
3277
- /**
3278
- * Pointer to the next or previous page in the list of results.
3279
- *
3280
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
3281
- * Not relevant for the first request.
3282
- * @maxLength 16000
3283
- */
3284
- cursor?: string | null;
3285
- }
3286
- export interface QueryDraftOrdersResponse {
3287
- /** list of edits per order */
3288
- draftOrders?: DraftOrder[];
3289
- /** Paging metadata. */
3290
- pagingMetadata?: CursorPagingMetadata;
3291
- }
3292
- export interface CursorPagingMetadata {
3293
- /** Number of items returned in current page. */
3294
- count?: number | null;
3295
- /** Cursor strings that point to the next page, previous page, or both. */
3296
- cursors?: Cursors;
3297
- /**
3298
- * Whether there are more pages to retrieve following the current page.
3299
- *
3300
- * + `true`: Another page of results can be retrieved.
3301
- * + `false`: This is the last page.
3302
- */
3303
- hasNext?: boolean | null;
3304
- }
3305
- export interface Cursors {
3306
- /**
3307
- * Cursor string pointing to the next page in the list of results.
3308
- * @maxLength 16000
3309
- */
3310
- next?: string | null;
3311
- /**
3312
- * Cursor pointing to the previous page in the list of results.
3313
- * @maxLength 16000
3314
- */
3315
- prev?: string | null;
3316
- }
3317
- export interface UpdateExtendedFieldsRequest {
3318
- /** ID of the entity to update. */
3319
- _id?: string;
3320
- /** Identifier for the app whose extended fields are being updated. */
3321
- namespace?: string;
3322
- /** 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. */
3323
- namespaceData?: Record<string, any> | null;
3324
- }
3325
- export interface UpdateExtendedFieldsResponse {
3326
- /** Updated DraftOrder */
3327
- draftOrder?: DraftOrder;
3328
- }
3329
- export interface SetTaxExemptionRequest {
3330
- }
3331
- export interface SetTaxExemptionResponse {
3332
- }
3333
- export interface GetDraftEditabilityStatusRequest {
3334
- /**
3335
- * Draft order ID.
3336
- * @format GUID
3337
- */
3338
- draftOrderId?: string | null;
3339
- }
3340
- export interface GetDraftEditabilityStatusResponse {
3341
- /**
3342
- * Draft order ID.
3343
- * @format GUID
3344
- */
3345
- draftOrderId?: string | null;
3346
- /**
3347
- * Draft order status.
3348
- * @readonly
3349
- */
3350
- status?: EditingStatus;
3351
- }
3352
- export interface SetBusinessLocationRequest {
3353
- }
3354
- export interface SetBusinessLocationResponse {
3355
- }
3356
- export interface DomainEvent extends DomainEventBodyOneOf {
3357
- createdEvent?: EntityCreatedEvent;
3358
- updatedEvent?: EntityUpdatedEvent;
3359
- deletedEvent?: EntityDeletedEvent;
3360
- actionEvent?: ActionEvent;
3361
- /**
3362
- * Unique event ID.
3363
- * Allows clients to ignore duplicate webhooks.
3364
- */
3365
- _id?: string;
3366
- /**
3367
- * Assumes actions are also always typed to an entity_type
3368
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3369
- */
3370
- entityFqdn?: string;
3371
- /**
3372
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3373
- * This is although the created/updated/deleted notion is duplication of the oneof types
3374
- * Example: created/updated/deleted/started/completed/email_opened
3375
- */
3376
- slug?: string;
3377
- /** ID of the entity associated with the event. */
3378
- entityId?: string;
3379
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3380
- eventTime?: Date | null;
3381
- /**
3382
- * Whether the event was triggered as a result of a privacy regulation application
3383
- * (for example, GDPR).
3384
- */
3385
- triggeredByAnonymizeRequest?: boolean | null;
3386
- /** If present, indicates the action that triggered the event. */
3387
- originatedFrom?: string | null;
3388
- /**
3389
- * A sequence number defining the order of updates to the underlying entity.
3390
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
3391
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3392
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3393
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
3394
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3395
- */
3396
- entityEventSequence?: string | null;
3397
- }
3398
- /** @oneof */
3399
- export interface DomainEventBodyOneOf {
3400
- createdEvent?: EntityCreatedEvent;
3401
- updatedEvent?: EntityUpdatedEvent;
3402
- deletedEvent?: EntityDeletedEvent;
3403
- actionEvent?: ActionEvent;
3404
- }
3405
- export interface EntityCreatedEvent {
3406
- entity?: string;
3407
- }
3408
- export interface RestoreInfo {
3409
- deletedDate?: Date | null;
3410
- }
3411
- export interface EntityUpdatedEvent {
3412
- /**
3413
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3414
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3415
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3416
- */
3417
- currentEntity?: string;
3418
- }
3419
- export interface EntityDeletedEvent {
3420
- /** Entity that was deleted */
3421
- deletedEntity?: string | null;
3422
- }
3423
- export interface ActionEvent {
3424
- body?: string;
3425
- }
3426
- export interface MessageEnvelope {
3427
- /**
3428
- * App instance ID.
3429
- * @format GUID
3430
- */
3431
- instanceId?: string | null;
3432
- /**
3433
- * Event type.
3434
- * @maxLength 150
3435
- */
3436
- eventType?: string;
3437
- /** The identification type and identity data. */
3438
- identity?: IdentificationData;
3439
- /** Stringify payload. */
3440
- data?: string;
3441
- }
3442
- export interface IdentificationData extends IdentificationDataIdOneOf {
3443
- /**
3444
- * ID of a site visitor that has not logged in to the site.
3445
- * @format GUID
3446
- */
3447
- anonymousVisitorId?: string;
3448
- /**
3449
- * ID of a site visitor that has logged in to the site.
3450
- * @format GUID
3451
- */
3452
- memberId?: string;
3453
- /**
3454
- * ID of a Wix user (site owner, contributor, etc.).
3455
- * @format GUID
3456
- */
3457
- wixUserId?: string;
3458
- /**
3459
- * ID of an app.
3460
- * @format GUID
3461
- */
3462
- appId?: string;
3463
- /** @readonly */
3464
- identityType?: WebhookIdentityType;
3465
- }
3466
- /** @oneof */
3467
- export interface IdentificationDataIdOneOf {
3468
- /**
3469
- * ID of a site visitor that has not logged in to the site.
3470
- * @format GUID
3471
- */
3472
- anonymousVisitorId?: string;
3473
- /**
3474
- * ID of a site visitor that has logged in to the site.
3475
- * @format GUID
3476
- */
3477
- memberId?: string;
3478
- /**
3479
- * ID of a Wix user (site owner, contributor, etc.).
3480
- * @format GUID
3481
- */
3482
- wixUserId?: string;
3483
- /**
3484
- * ID of an app.
3485
- * @format GUID
3486
- */
3487
- appId?: string;
3488
- }
3489
- export declare enum WebhookIdentityType {
3490
- UNKNOWN = "UNKNOWN",
3491
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3492
- MEMBER = "MEMBER",
3493
- WIX_USER = "WIX_USER",
3494
- APP = "APP"
3495
- }
3496
- interface PriceNonNullableFields {
3497
- amount: string;
3498
- formattedAmount: string;
3499
- }
3500
- interface PriceDescriptionNonNullableFields {
3501
- original: string;
3502
- }
3503
- interface ItemChangedDetailsNonNullableFields {
3504
- priceBeforeChange?: PriceNonNullableFields;
3505
- priceDescriptionBeforeChange?: PriceDescriptionNonNullableFields;
3506
- }
3507
- interface ProductNameNonNullableFields {
3508
- original: string;
3509
- }
3510
- interface CatalogReferenceNonNullableFields {
3511
- catalogItemId: string;
3512
- appId: string;
3513
- }
3514
- interface PlainTextValueNonNullableFields {
3515
- original: string;
3516
- }
3517
- interface ColorNonNullableFields {
3518
- original: string;
3519
- }
3520
- interface DescriptionLineNameNonNullableFields {
3521
- original: string;
3522
- }
3523
- interface DescriptionLineNonNullableFields {
3524
- plainText?: PlainTextValueNonNullableFields;
3525
- colorInfo?: ColorNonNullableFields;
3526
- plainTextValue?: PlainTextValueNonNullableFields;
3527
- color: string;
3528
- name?: DescriptionLineNameNonNullableFields;
3529
- lineType: DescriptionLineType;
3530
- }
3531
- interface PhysicalPropertiesNonNullableFields {
3532
- shippable: boolean;
3533
- }
3534
- interface ItemTypeNonNullableFields {
3535
- preset: ItemTypeItemType;
3536
- custom: string;
3537
- }
3538
- interface ItemTaxFullDetailsNonNullableFields {
3539
- taxableAmount?: PriceNonNullableFields;
3540
- taxRate: string;
3541
- totalTax?: PriceNonNullableFields;
3542
- }
3543
- interface LineItemTaxBreakdownNonNullableFields {
3544
- taxAmount?: PriceNonNullableFields;
3545
- jurisdictionType: JurisdictionType;
3546
- nonTaxableAmount?: PriceNonNullableFields;
3547
- taxableAmount?: PriceNonNullableFields;
3548
- }
3549
- interface LineItemTaxInfoNonNullableFields {
3550
- taxAmount?: PriceNonNullableFields;
3551
- taxableAmount?: PriceNonNullableFields;
3552
- taxIncludedInPrice: boolean;
3553
- taxBreakdown: LineItemTaxBreakdownNonNullableFields[];
3554
- }
3555
- interface DigitalFileNonNullableFields {
3556
- fileId: string;
3557
- }
3558
- interface SubscriptionSettingsNonNullableFields {
3559
- frequency: SubscriptionFrequency;
3560
- autoRenewal: boolean;
3561
- }
3562
- interface SubscriptionInfoNonNullableFields {
3563
- cycleNumber: number;
3564
- subscriptionOptionTitle: string;
3565
- subscriptionSettings?: SubscriptionSettingsNonNullableFields;
3566
- }
3567
- interface LocationAndQuantityNonNullableFields {
3568
- _id: string;
3569
- quantity: number;
3570
- }
3571
- interface OrderLineItemNonNullableFields {
3572
- _id: string;
3573
- productName?: ProductNameNonNullableFields;
3574
- catalogReference?: CatalogReferenceNonNullableFields;
3575
- quantity: number;
3576
- totalDiscount?: PriceNonNullableFields;
3577
- descriptionLines: DescriptionLineNonNullableFields[];
3578
- image: string;
3579
- physicalProperties?: PhysicalPropertiesNonNullableFields;
3580
- itemType?: ItemTypeNonNullableFields;
3581
- price?: PriceNonNullableFields;
3582
- priceBeforeDiscounts?: PriceNonNullableFields;
3583
- totalPriceBeforeTax?: PriceNonNullableFields;
3584
- totalPriceAfterTax?: PriceNonNullableFields;
3585
- paymentOption: PaymentOptionType;
3586
- taxDetails?: ItemTaxFullDetailsNonNullableFields;
3587
- taxInfo?: LineItemTaxInfoNonNullableFields;
3588
- digitalFile?: DigitalFileNonNullableFields;
3589
- subscriptionInfo?: SubscriptionInfoNonNullableFields;
3590
- priceDescription?: PriceDescriptionNonNullableFields;
3591
- depositAmount?: PriceNonNullableFields;
3592
- locations: LocationAndQuantityNonNullableFields[];
3593
- lineItemPrice?: PriceNonNullableFields;
3594
- }
3595
- interface ItemDetailsNonNullableFields {
3596
- added: boolean;
3597
- changedDetails?: ItemChangedDetailsNonNullableFields;
3598
- removed: boolean;
3599
- lineItem?: OrderLineItemNonNullableFields;
3600
- }
3601
- interface StreetAddressNonNullableFields {
3602
- number: string;
3603
- name: string;
3604
- apt: string;
3605
- }
3606
- interface AddressNonNullableFields {
3607
- streetAddress?: StreetAddressNonNullableFields;
3608
- }
3609
- interface VatIdNonNullableFields {
3610
- _id: string;
3611
- type: VatType;
3612
- }
3613
- interface FullAddressContactDetailsNonNullableFields {
3614
- vatId?: VatIdNonNullableFields;
3615
- }
3616
- interface AddressWithContactNonNullableFields {
3617
- address?: AddressNonNullableFields;
3618
- contactDetails?: FullAddressContactDetailsNonNullableFields;
3619
- }
3620
- interface PickupAddressNonNullableFields {
3621
- streetAddress?: StreetAddressNonNullableFields;
3622
- }
3623
- interface V1PickupDetailsNonNullableFields {
3624
- address?: PickupAddressNonNullableFields;
3625
- pickupMethod: PickupDetailsPickupMethod;
3626
- }
3627
- interface V1DeliveryLogisticsNonNullableFields {
3628
- shippingDestination?: AddressWithContactNonNullableFields;
3629
- pickupDetails?: V1PickupDetailsNonNullableFields;
3630
- }
3631
- interface V1ShippingPriceNonNullableFields {
3632
- price?: PriceNonNullableFields;
3633
- totalPriceBeforeTax?: PriceNonNullableFields;
3634
- totalPriceAfterTax?: PriceNonNullableFields;
3635
- taxDetails?: ItemTaxFullDetailsNonNullableFields;
3636
- discount?: PriceNonNullableFields;
3637
- }
3638
- interface V1ShippingInformationNonNullableFields {
3639
- title: string;
3640
- logistics?: V1DeliveryLogisticsNonNullableFields;
3641
- cost?: V1ShippingPriceNonNullableFields;
3642
- }
3643
- interface ShippingChangedDetailsNonNullableFields {
3644
- shippingInfoBeforeChange?: V1ShippingInformationNonNullableFields;
3645
- }
3646
- interface ShippingDetailsNonNullableFields {
3647
- added: boolean;
3648
- changedDetails?: ShippingChangedDetailsNonNullableFields;
3649
- removed: boolean;
3650
- shippingInfo?: V1ShippingInformationNonNullableFields;
3651
- }
3652
- interface BuyerInfoNonNullableFields {
3653
- visitorId: string;
3654
- memberId: string;
3655
- }
3656
- interface AdditionalFeeNonNullableFields {
3657
- name: string;
3658
- price?: PriceNonNullableFields;
3659
- taxDetails?: ItemTaxFullDetailsNonNullableFields;
3660
- priceBeforeTax?: PriceNonNullableFields;
3661
- priceAfterTax?: PriceNonNullableFields;
3662
- _id: string;
3663
- lineItemIds: string[];
3664
- }
3665
- interface TaxDetailsNonNullableFields {
3666
- taxable: boolean;
3667
- }
3668
- interface AdditionalFeeDetailsNonNullableFields {
3669
- additionalFee?: AdditionalFeeNonNullableFields;
3670
- taxDetails?: TaxDetailsNonNullableFields;
3671
- source: SourceType;
3672
- applied: boolean;
3673
- }
3674
- interface CouponNonNullableFields {
3675
- _id: string;
3676
- code: string;
3677
- name: string;
3678
- amount?: PriceNonNullableFields;
3679
- }
3680
- interface MerchantDiscountNonNullableFields {
3681
- discountReason: DiscountReason;
3682
- amount?: PriceNonNullableFields;
3683
- }
3684
- interface DiscountRuleNameNonNullableFields {
3685
- original: string;
3686
- }
3687
- interface DiscountRuleNonNullableFields {
3688
- _id: string;
3689
- name?: DiscountRuleNameNonNullableFields;
3690
- amount?: PriceNonNullableFields;
3691
- }
3692
- interface AppliedDiscountNonNullableFields {
3693
- coupon?: CouponNonNullableFields;
3694
- merchantDiscount?: MerchantDiscountNonNullableFields;
3695
- discountRule?: DiscountRuleNonNullableFields;
3696
- discountType: AppliedDiscountDiscountType;
3697
- lineItemIds: string[];
3698
- }
3699
- interface DiscountDetailsNonNullableFields {
3700
- discount?: AppliedDiscountNonNullableFields;
3701
- source: SourceType;
3702
- applied: boolean;
3703
- }
3704
- interface CreatedByNonNullableFields {
3705
- userId: string;
3706
- appId: string;
3707
- }
3708
- interface PriceSummaryNonNullableFields {
3709
- subtotal?: PriceNonNullableFields;
3710
- shipping?: PriceNonNullableFields;
3711
- tax?: PriceNonNullableFields;
3712
- discount?: PriceNonNullableFields;
3713
- totalPrice?: PriceNonNullableFields;
3714
- total?: PriceNonNullableFields;
3715
- totalWithGiftCard?: PriceNonNullableFields;
3716
- totalWithoutGiftCard?: PriceNonNullableFields;
3717
- totalAdditionalFees?: PriceNonNullableFields;
3718
- }
3719
- interface TaxSummaryNonNullableFields {
3720
- totalTax?: PriceNonNullableFields;
3721
- }
3722
- interface BalanceNonNullableFields {
3723
- amount: string;
3724
- formattedAmount: string;
3725
- }
3726
- interface BalanceSummaryNonNullableFields {
3727
- balance?: BalanceNonNullableFields;
3728
- paid?: PriceNonNullableFields;
3729
- refunded?: PriceNonNullableFields;
3730
- authorized?: PriceNonNullableFields;
3731
- }
3732
- interface InventoryUpdateNonNullableFields {
3733
- lineItemId: string;
3734
- }
3735
- interface DraftOrderCommitSettingsNonNullableFields {
3736
- updateInventory: InventoryUpdateNonNullableFields[];
3737
- }
3738
- interface RecipientInfoChangedDetailsNonNullableFields {
3739
- recipientInfoBeforeChange?: AddressWithContactNonNullableFields;
3740
- }
3741
- interface RecipientInfoDetailsNonNullableFields {
3742
- added: boolean;
3743
- changedDetails?: RecipientInfoChangedDetailsNonNullableFields;
3744
- removed: boolean;
3745
- recipientInfo?: AddressWithContactNonNullableFields;
3746
- }
3747
- interface OrderTaxBreakdownNonNullableFields {
3748
- taxName: string;
3749
- taxType: string;
3750
- jurisdiction: string;
3751
- jurisdictionType: JurisdictionType;
3752
- rate: string;
3753
- aggregatedTaxAmount?: PriceNonNullableFields;
3754
- aggregatedTaxableAmount?: PriceNonNullableFields;
3755
- }
3756
- interface OrderTaxInfoNonNullableFields {
3757
- totalTax?: PriceNonNullableFields;
3758
- taxBreakdown: OrderTaxBreakdownNonNullableFields[];
3759
- }
3760
- interface LocationNonNullableFields {
3761
- _id: string;
3762
- name: string;
3763
- }
3764
- interface BusinessLocationChangedDetailsNonNullableFields {
3765
- businessLocationBeforeChange?: LocationNonNullableFields;
3766
- }
3767
- interface BusinessLocationDetailsNonNullableFields {
3768
- added: boolean;
3769
- changedDetails?: BusinessLocationChangedDetailsNonNullableFields;
3770
- removed: boolean;
3771
- businessLocation?: LocationNonNullableFields;
3772
- }
3773
- interface DraftOrderNonNullableFields {
3774
- lineItems: ItemDetailsNonNullableFields[];
3775
- shippingInfo?: ShippingDetailsNonNullableFields;
3776
- buyerInfo?: BuyerInfoNonNullableFields;
3777
- billingInfo?: AddressWithContactNonNullableFields;
3778
- additionalFees: AdditionalFeeDetailsNonNullableFields[];
3779
- discounts: DiscountDetailsNonNullableFields[];
3780
- createdBy?: CreatedByNonNullableFields;
3781
- status: EditingStatus;
3782
- weightUnit: WeightUnit;
3783
- priceSummary?: PriceSummaryNonNullableFields;
3784
- taxSummary?: TaxSummaryNonNullableFields;
3785
- balanceSummary?: BalanceSummaryNonNullableFields;
3786
- commitSettings?: DraftOrderCommitSettingsNonNullableFields;
3787
- recipientInfo?: RecipientInfoDetailsNonNullableFields;
3788
- businessLocationDetails?: BusinessLocationDetailsNonNullableFields;
3789
- }
3790
- interface PickupDetailsNonNullableFields {
3791
- address?: AddressNonNullableFields;
3792
- pickupMethod: PickupMethod;
3793
- }
3794
- interface DeliveryLogisticsNonNullableFields {
3795
- pickupDetails?: PickupDetailsNonNullableFields;
3796
- }
3797
- interface ShippingPriceNonNullableFields {
3798
- price?: PriceNonNullableFields;
3799
- currency: string;
3800
- }
3801
- interface ShippingOptionNonNullableFields {
3802
- code: string;
3803
- title: string;
3804
- logistics?: DeliveryLogisticsNonNullableFields;
3805
- cost?: ShippingPriceNonNullableFields;
3806
- }
3807
- interface ApplicationErrorNonNullableFields {
3808
- code: string;
3809
- description: string;
3810
- }
3811
- interface FieldViolationNonNullableFields {
3812
- field: string;
3813
- description: string;
3814
- violatedRule: RuleType;
3815
- }
3816
- interface ValidationErrorNonNullableFields {
3817
- fieldViolations: FieldViolationNonNullableFields[];
3818
- }
3819
- interface DetailsNonNullableFields {
3820
- applicationError?: ApplicationErrorNonNullableFields;
3821
- validationError?: ValidationErrorNonNullableFields;
3822
- }
3823
- interface CarrierErrorNonNullableFields {
3824
- carrierId: string;
3825
- error?: DetailsNonNullableFields;
3826
- }
3827
- interface CarrierErrorsNonNullableFields {
3828
- errors: CarrierErrorNonNullableFields[];
3829
- }
3830
- interface CalculationErrorsNonNullableFields {
3831
- generalShippingCalculationError?: DetailsNonNullableFields;
3832
- carrierErrors?: CarrierErrorsNonNullableFields;
3833
- taxCalculationError?: DetailsNonNullableFields;
3834
- orderValidationErrors: ApplicationErrorNonNullableFields[];
3835
- }
3836
- interface CalculatedDraftOrderNonNullableFields {
3837
- draftOrder?: DraftOrderNonNullableFields;
3838
- shippingOptions: ShippingOptionNonNullableFields[];
3839
- calculationErrors?: CalculationErrorsNonNullableFields;
3840
- }
3841
- export interface CreateDraftOrderResponseNonNullableFields {
3842
- calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
3843
- }
3844
- export interface CreateEmptyDraftOrderResponseNonNullableFields {
3845
- calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
3846
- }
3847
- export interface AddLineItemsToDraftOrderResponseNonNullableFields {
3848
- calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
3849
- }
3850
- export interface UpdateLineItemsResponseNonNullableFields {
3851
- calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
3852
- }
3853
- export interface SetDiscountsResponseNonNullableFields {
3854
- calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
3855
- }
3856
- export interface CreateCustomDiscountsResponseNonNullableFields {
3857
- calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
3858
- }
3859
- export interface DeleteCustomDiscountsResponseNonNullableFields {
3860
- calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
3861
- }
3862
- export interface SetAdditionalFeesResponseNonNullableFields {
3863
- calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
3864
- }
3865
- export interface CreateCustomAdditionalFeesResponseNonNullableFields {
3866
- calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
3867
- }
3868
- export interface DeleteCustomAdditionalFeesResponseNonNullableFields {
3869
- calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
3870
- }
3871
- export interface SetShippingInfoResponseNonNullableFields {
3872
- }
3873
- export interface SetBuyerInfoResponseNonNullableFields {
3874
- }
3875
- export interface SetRecipientInfoResponseNonNullableFields {
3876
- }
3877
- export interface SetBillingInfoResponseNonNullableFields {
3878
- }
3879
- export interface GetDraftOrderResponseNonNullableFields {
3880
- calculatedDraftOrder?: CalculatedDraftOrderNonNullableFields;
3881
- }
3882
- export interface GetOrderDraftabilityStatusResponseNonNullableFields {
3883
- orderId: string;
3884
- orderDraftable: boolean;
3885
- nonDraftableReasons: NonDraftableReason[];
3886
- }
3887
- interface CustomActivityNonNullableFields {
3888
- appId: string;
3889
- type: string;
3890
- }
3891
- interface MerchantCommentNonNullableFields {
3892
- message: string;
3893
- }
3894
- interface OrderRefundedNonNullableFields {
3895
- manual: boolean;
3896
- amount?: PriceNonNullableFields;
3897
- reason: string;
3898
- }
3899
- interface OrderCreatedFromExchangeNonNullableFields {
3900
- originalOrderId: string;
3901
- }
3902
- interface LineItemExchangeDataNonNullableFields {
3903
- lineItemId: string;
3904
- quantity: number;
3905
- }
3906
- interface NewExchangeOrderCreatedNonNullableFields {
3907
- exchangeOrderId: string;
3908
- lineItems: LineItemExchangeDataNonNullableFields[];
3909
- }
3910
- interface ActivityNonNullableFields {
3911
- customActivity?: CustomActivityNonNullableFields;
3912
- merchantComment?: MerchantCommentNonNullableFields;
3913
- orderRefunded?: OrderRefundedNonNullableFields;
3914
- orderCreatedFromExchange?: OrderCreatedFromExchangeNonNullableFields;
3915
- newExchangeOrderCreated?: NewExchangeOrderCreatedNonNullableFields;
3916
- type: ActivityType;
3917
- }
3918
- interface V1CreatedByNonNullableFields {
3919
- userId: string;
3920
- memberId: string;
3921
- visitorId: string;
3922
- appId: string;
3923
- }
3924
- interface ChannelInfoNonNullableFields {
3925
- type: ChannelType;
3926
- }
3927
- interface CustomFieldNonNullableFields {
3928
- title: string;
3929
- }
3930
- interface V1BalanceSummaryNonNullableFields {
3931
- balance?: BalanceNonNullableFields;
3932
- paid?: PriceNonNullableFields;
3933
- refunded?: PriceNonNullableFields;
3934
- authorized?: PriceNonNullableFields;
3935
- pending?: PriceNonNullableFields;
3936
- }
3937
- interface TagListNonNullableFields {
3938
- tagIds: string[];
3939
- }
3940
- interface TagsNonNullableFields {
3941
- privateTags?: TagListNonNullableFields;
3942
- tags?: TagListNonNullableFields;
3943
- }
3944
- interface OrderNonNullableFields {
3945
- number: string;
3946
- lineItems: OrderLineItemNonNullableFields[];
3947
- buyerInfo?: BuyerInfoNonNullableFields;
3948
- paymentStatus: PaymentStatus;
3949
- fulfillmentStatus: FulfillmentStatus;
3950
- weightUnit: WeightUnit;
3951
- taxIncludedInPrices: boolean;
3952
- priceSummary?: PriceSummaryNonNullableFields;
3953
- billingInfo?: AddressWithContactNonNullableFields;
3954
- shippingInfo?: V1ShippingInformationNonNullableFields;
3955
- status: OrderStatus;
3956
- taxSummary?: TaxSummaryNonNullableFields;
3957
- taxInfo?: OrderTaxInfoNonNullableFields;
3958
- appliedDiscounts: AppliedDiscountNonNullableFields[];
3959
- activities: ActivityNonNullableFields[];
3960
- attributionSource: AttributionSource;
3961
- createdBy?: V1CreatedByNonNullableFields;
3962
- channelInfo?: ChannelInfoNonNullableFields;
3963
- customFields: CustomFieldNonNullableFields[];
3964
- isInternalOrderCreate: boolean;
3965
- payNow?: PriceSummaryNonNullableFields;
3966
- balanceSummary?: V1BalanceSummaryNonNullableFields;
3967
- additionalFees: AdditionalFeeNonNullableFields[];
3968
- recipientInfo?: AddressWithContactNonNullableFields;
3969
- tags?: TagsNonNullableFields;
3970
- businessLocation?: LocationNonNullableFields;
3971
- }
3972
- export interface CommitDraftOrderResponseNonNullableFields {
3973
- committedDraftOrder?: DraftOrderNonNullableFields;
3974
- orderAfterCommit?: OrderNonNullableFields;
3975
- }
3976
- export interface CreateOrderFromDraftResponseNonNullableFields {
3977
- }
3978
- export interface QueryDraftOrdersResponseNonNullableFields {
3979
- draftOrders: DraftOrderNonNullableFields[];
3980
- }
3981
- export interface SetTaxExemptionResponseNonNullableFields {
3982
- }
3983
- export interface SetBusinessLocationResponseNonNullableFields {
3984
- }
3985
- /**
3986
- * Creates or gets a draft order.
3987
- *
3988
- * When passing the ID of an order that is already in draft, the existing draft order will be returned.
3989
- * To complete a draft and update the order, call [Commit Draft Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/draft-orders/commit-draft-order).
3990
- * @param orderId - To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
3991
- * @public
3992
- * @documentationMaturity preview
3993
- * @requiredField orderId
3994
- * @permissionId ECOM.DRAFT_ORDERS_CREATE
3995
- * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
3996
- * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
3997
- * @permissionScope Manage Stores - all permissions
3998
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3999
- * @permissionScope Manage Restaurants - all permissions
4000
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4001
- * @permissionScope Manage eCommerce - all permissions
4002
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4003
- * @permissionScope Picasso private app mega scope
4004
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4005
- * @applicableIdentity APP
4006
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateDraftOrder
4007
- */
4008
- export declare function createDraftOrder(orderId: string | null): Promise<CreateDraftOrderResponse & CreateDraftOrderResponseNonNullableFields>;
4009
- /**
4010
- * Creates an empty draft order.
4011
- * @public
4012
- * @documentationMaturity preview
4013
- * @permissionId ECOM.DRAFT_ORDERS_CREATE
4014
- * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
4015
- * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
4016
- * @permissionScope Manage Stores - all permissions
4017
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4018
- * @permissionScope Manage Restaurants - all permissions
4019
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4020
- * @permissionScope Manage eCommerce - all permissions
4021
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4022
- * @permissionScope Picasso private app mega scope
4023
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4024
- * @applicableIdentity APP
4025
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateEmptyDraftOrder
4026
- */
4027
- export declare function createEmptyDraftOrder(): Promise<CreateEmptyDraftOrderResponse & CreateEmptyDraftOrderResponseNonNullableFields>;
4028
- /**
4029
- * Adds line items to a draft order.
4030
- * @param draftOrderId - The draft order id
4031
- * @public
4032
- * @documentationMaturity preview
4033
- * @requiredField draftOrderId
4034
- * @requiredField options.catalogLineItems.catalogReference
4035
- * @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
4036
- * @permissionScope Manage Stores - all permissions
4037
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4038
- * @permissionScope Manage Restaurants - all permissions
4039
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4040
- * @permissionScope Manage eCommerce - all permissions
4041
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4042
- * @permissionScope Picasso private app mega scope
4043
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4044
- * @applicableIdentity APP
4045
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.AddLineItemsToDraftOrder
4046
- */
4047
- export declare function addLineItemsToDraftOrder(draftOrderId: string, options?: AddLineItemsToDraftOrderOptions): Promise<AddLineItemsToDraftOrderResponse & AddLineItemsToDraftOrderResponseNonNullableFields>;
4048
- export interface AddLineItemsToDraftOrderOptions {
4049
- /**
4050
- * Catalog line items to add to draft order.
4051
- * @maxSize 300
4052
- */
4053
- catalogLineItems?: CatalogReferenceLineItem[];
4054
- /**
4055
- * Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin.
4056
- * @maxSize 300
4057
- */
4058
- customLineItems?: CustomLineItem[];
4059
- }
4060
- /**
4061
- * Updates a draft order's line items.
4062
- *
4063
- * Using this API, you can update a line item's quantity, price, and description.
4064
- * > **Notes:**
4065
- * > + Passing a quantity of `0` will remove the line item.
4066
- * > + Price cannot be updated for line items with `paymentOption: MEMBERSHIP`.
4067
- * > + Quantity cannot be decreased fulfilled line items. To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
4068
- * @param draftOrderId - The draft order id
4069
- * @public
4070
- * @documentationMaturity preview
4071
- * @requiredField draftOrderId
4072
- * @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
4073
- * @permissionScope Manage Stores - all permissions
4074
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4075
- * @permissionScope Manage Restaurants - all permissions
4076
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4077
- * @permissionScope Manage eCommerce - all permissions
4078
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4079
- * @permissionScope Picasso private app mega scope
4080
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4081
- * @applicableIdentity APP
4082
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateLineItems
4083
- */
4084
- export declare function updateLineItems(draftOrderId: string, options?: UpdateLineItemsOptions): Promise<UpdateLineItemsResponse & UpdateLineItemsResponseNonNullableFields>;
4085
- export interface UpdateLineItemsOptions {
4086
- /**
4087
- * Details of changes to apply per line item
4088
- * @minSize 1
4089
- * @maxSize 300
4090
- */
4091
- lineItemChanges?: LineItemChangeDetails[];
4092
- }
4093
- /**
4094
- * Sets and enables or disables discounts on a draft order.
4095
- *
4096
- * Any discounts not passed will not change.
4097
- * @param draftOrderId - The draft order id
4098
- * @param discounts - The discount ids to opt-in. all existing discounts not listed are to be opted-out.
4099
- * @public
4100
- * @documentationMaturity preview
4101
- * @requiredField discounts
4102
- * @requiredField draftOrderId
4103
- * @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS
4104
- * @permissionScope Manage Stores - all permissions
4105
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4106
- * @permissionScope Manage Restaurants - all permissions
4107
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4108
- * @permissionScope Manage eCommerce - all permissions
4109
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4110
- * @permissionScope Picasso private app mega scope
4111
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4112
- * @applicableIdentity APP
4113
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetDiscounts
4114
- */
4115
- export declare function setDiscounts(draftOrderId: string, discounts: IdAndApplied[]): Promise<SetDiscountsResponse & SetDiscountsResponseNonNullableFields>;
4116
- /**
4117
- * Adds merchant discounts to the order.
4118
- * @param draftOrderId - The draft order id
4119
- * @public
4120
- * @documentationMaturity preview
4121
- * @requiredField draftOrderId
4122
- * @requiredField options.discounts.amount
4123
- * @requiredField options.discounts.amount.amount
4124
- * @requiredField options.discounts.discountType
4125
- * @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS
4126
- * @permissionScope Manage Stores - all permissions
4127
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4128
- * @permissionScope Manage Restaurants - all permissions
4129
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4130
- * @permissionScope Manage eCommerce - all permissions
4131
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4132
- * @permissionScope Picasso private app mega scope
4133
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4134
- * @applicableIdentity APP
4135
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateCustomDiscounts
4136
- */
4137
- export declare function createCustomDiscounts(draftOrderId: string, options?: CreateCustomDiscountsOptions): Promise<CreateCustomDiscountsResponse & CreateCustomDiscountsResponseNonNullableFields>;
4138
- export interface CreateCustomDiscountsOptions {
4139
- /**
4140
- * The discounts to add.
4141
- * @minSize 1
4142
- * @maxSize 100
4143
- */
4144
- discounts?: DiscountOption[];
4145
- }
4146
- /**
4147
- * Remove custom discounts from the order.
4148
- * @param draftOrderId - The draft order id
4149
- * @param discountIds - The discounts to remove
4150
- * @public
4151
- * @documentationMaturity preview
4152
- * @requiredField discountIds
4153
- * @requiredField draftOrderId
4154
- * @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
4155
- * @permissionScope Manage Stores - all permissions
4156
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4157
- * @permissionScope Manage Restaurants - all permissions
4158
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4159
- * @permissionScope Manage eCommerce - all permissions
4160
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4161
- * @permissionScope Picasso private app mega scope
4162
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4163
- * @applicableIdentity APP
4164
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteCustomDiscounts
4165
- */
4166
- export declare function deleteCustomDiscounts(draftOrderId: string, discountIds: string[]): Promise<DeleteCustomDiscountsResponse & DeleteCustomDiscountsResponseNonNullableFields>;
4167
- /**
4168
- * Set which additional fees existing on the draft order are to be opt-in.
4169
- * All existing additional fees not provided on the call are opted-out.
4170
- * @param draftOrderId - The draft order id
4171
- * @param additionalFees - The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out
4172
- * @public
4173
- * @documentationMaturity preview
4174
- * @requiredField additionalFees
4175
- * @requiredField draftOrderId
4176
- * @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES
4177
- * @permissionScope Manage Stores - all permissions
4178
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4179
- * @permissionScope Manage Restaurants - all permissions
4180
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4181
- * @permissionScope Manage eCommerce - all permissions
4182
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4183
- * @permissionScope Picasso private app mega scope
4184
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4185
- * @applicableIdentity APP
4186
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetAdditionalFees
4187
- */
4188
- export declare function setAdditionalFees(draftOrderId: string, additionalFees: IdAndApplied[]): Promise<SetAdditionalFeesResponse & SetAdditionalFeesResponseNonNullableFields>;
4189
- /**
4190
- * Create custom additional fees to the order.
4191
- * added additional fees are by default opted-out.
4192
- * To opt-in them, please call SetAdditionalFees with the added additional fee ids.
4193
- * @param draftOrderId - The draft order id
4194
- * @public
4195
- * @documentationMaturity preview
4196
- * @requiredField draftOrderId
4197
- * @requiredField options.customAdditionalFees.name
4198
- * @requiredField options.customAdditionalFees.price
4199
- * @requiredField options.customAdditionalFees.price.amount
4200
- * @permissionId ECOM.DRAFT_ORDERS_CREATE_ADDITIONAL_FEES
4201
- * @permissionScope Manage Stores - all permissions
4202
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4203
- * @permissionScope Manage Restaurants - all permissions
4204
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4205
- * @permissionScope Manage eCommerce - all permissions
4206
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4207
- * @permissionScope Picasso private app mega scope
4208
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4209
- * @applicableIdentity APP
4210
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateCustomAdditionalFees
4211
- */
4212
- export declare function createCustomAdditionalFees(draftOrderId: string, options?: CreateCustomAdditionalFeesOptions): Promise<CreateCustomAdditionalFeesResponse & CreateCustomAdditionalFeesResponseNonNullableFields>;
4213
- export interface CreateCustomAdditionalFeesOptions {
4214
- /**
4215
- * The additional fees to add. added with opted-out setting
4216
- * @minSize 1
4217
- * @maxSize 100
4218
- */
4219
- customAdditionalFees?: AdditionalFeeOption[];
4220
- }
4221
- /**
4222
- * Remove custom additional fees from the order.
4223
- * @param draftOrderId - The draft order id
4224
- * @param customAdditionalFees - The additional fees to remove
4225
- * @public
4226
- * @documentationMaturity preview
4227
- * @requiredField customAdditionalFees
4228
- * @requiredField draftOrderId
4229
- * @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
4230
- * @permissionScope Manage Stores - all permissions
4231
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4232
- * @permissionScope Manage Restaurants - all permissions
4233
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4234
- * @permissionScope Manage eCommerce - all permissions
4235
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4236
- * @permissionScope Picasso private app mega scope
4237
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4238
- * @applicableIdentity APP
4239
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteCustomAdditionalFees
4240
- */
4241
- export declare function deleteCustomAdditionalFees(draftOrderId: string, customAdditionalFees: string[]): Promise<DeleteCustomAdditionalFeesResponse & DeleteCustomAdditionalFeesResponseNonNullableFields>;
4242
- /**
4243
- * Sets shipping info to a draft order.
4244
- * @public
4245
- * @documentationMaturity preview
4246
- * @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
4247
- * @permissionScope Manage Stores - all permissions
4248
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4249
- * @permissionScope Manage Restaurants - all permissions
4250
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4251
- * @permissionScope Manage eCommerce - all permissions
4252
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4253
- * @permissionScope Picasso private app mega scope
4254
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4255
- * @applicableIdentity APP
4256
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetShippingInfo
4257
- */
4258
- export declare function setShippingInfo(): Promise<void>;
4259
- /**
4260
- * Sets buyer info to a draft order.
4261
- * @public
4262
- * @documentationMaturity preview
4263
- * @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
4264
- * @permissionScope Manage Stores - all permissions
4265
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4266
- * @permissionScope Manage Restaurants - all permissions
4267
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4268
- * @permissionScope Manage eCommerce - all permissions
4269
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4270
- * @permissionScope Picasso private app mega scope
4271
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4272
- * @applicableIdentity APP
4273
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBuyerInfo
4274
- */
4275
- export declare function setBuyerInfo(): Promise<void>;
4276
- /**
4277
- * Sets recipient info to a draft order.
4278
- * @public
4279
- * @documentationMaturity preview
4280
- * @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
4281
- * @permissionScope Manage Stores - all permissions
4282
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4283
- * @permissionScope Manage Restaurants - all permissions
4284
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4285
- * @permissionScope Manage eCommerce - all permissions
4286
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4287
- * @permissionScope Picasso private app mega scope
4288
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4289
- * @applicableIdentity APP
4290
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetRecipientInfo
4291
- */
4292
- export declare function setRecipientInfo(): Promise<void>;
4293
- /**
4294
- * Sets billing info to a draft order.
4295
- * @public
4296
- * @documentationMaturity preview
4297
- * @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
4298
- * @permissionScope Manage Stores - all permissions
4299
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4300
- * @permissionScope Manage Restaurants - all permissions
4301
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4302
- * @permissionScope Manage eCommerce - all permissions
4303
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4304
- * @permissionScope Picasso private app mega scope
4305
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4306
- * @applicableIdentity APP
4307
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBillingInfo
4308
- */
4309
- export declare function setBillingInfo(): Promise<void>;
4310
- /**
4311
- * Get an order.
4312
- * When order is in draft status, it's re-estimated and return with latest tax and totals
4313
- * Automatic discounts and automatic additional fees will reflect the latest prices and eligibility.
4314
- * Calculation will be based on current draft order content - items, shipping info and eligible discounts and additional fees.
4315
- * When order is in committed status, it's returned with it's calculation at the moment it was committed.
4316
- * @param draftOrderId - The draft order id
4317
- * @public
4318
- * @documentationMaturity preview
4319
- * @requiredField draftOrderId
4320
- * @permissionId ECOM.DRAFT_ORDERS_READ
4321
- * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
4322
- * @permissionScope Manage Stores - all permissions
4323
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4324
- * @permissionScope Manage Restaurants - all permissions
4325
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4326
- * @permissionScope Manage eCommerce - all permissions
4327
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4328
- * @permissionScope Picasso private app mega scope
4329
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4330
- * @applicableIdentity APP
4331
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.GetDraftOrder
4332
- */
4333
- export declare function getDraftOrder(draftOrderId: string): Promise<GetDraftOrderResponse & GetDraftOrderResponseNonNullableFields>;
4334
- /**
4335
- * Checks whether a draft can be created for this order
4336
- * @param orderId - Order ID.
4337
- * @public
4338
- * @documentationMaturity preview
4339
- * @requiredField orderId
4340
- * @permissionId ECOM.DRAFT_ORDERS_READ
4341
- * @permissionScope Manage Stores - all permissions
4342
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4343
- * @permissionScope Manage Restaurants - all permissions
4344
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4345
- * @permissionScope Manage eCommerce - all permissions
4346
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4347
- * @permissionScope Picasso private app mega scope
4348
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4349
- * @applicableIdentity APP
4350
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.GetOrderDraftabilityStatus
4351
- */
4352
- export declare function getOrderDraftabilityStatus(orderId: string): Promise<GetOrderDraftabilityStatusResponse & GetOrderDraftabilityStatusResponseNonNullableFields>;
4353
- /**
4354
- * Commit latest changes to the baseline order and control what side-effects will be applied.
4355
- * Commit cannot be undone or reverted.
4356
- * Order-edit become closed for editing, however it's kept for reference and can be retrieved.
4357
- * @param draftOrderId - The draft order id
4358
- * @public
4359
- * @documentationMaturity preview
4360
- * @requiredField draftOrderId
4361
- * @permissionId ECOM.DRAFT_ORDERS_COMMIT
4362
- * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
4363
- * @permissionScope Manage Stores - all permissions
4364
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4365
- * @permissionScope Manage Restaurants - all permissions
4366
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4367
- * @permissionScope Manage eCommerce - all permissions
4368
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4369
- * @permissionScope Picasso private app mega scope
4370
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4371
- * @applicableIdentity APP
4372
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CommitDraftOrder
4373
- */
4374
- export declare function commitDraftOrder(draftOrderId: string, options?: CommitDraftOrderOptions): Promise<CommitDraftOrderResponse & CommitDraftOrderResponseNonNullableFields>;
4375
- export interface CommitDraftOrderOptions {
4376
- /** Optional side effects to trigger */
4377
- commitSettings?: DraftOrderCommitSettings;
4378
- /**
4379
- * Reason for edit, given by user (optional).
4380
- * @maxLength 200
4381
- */
4382
- reason?: string | null;
4383
- }
4384
- /**
4385
- * Create new order and control what side-effects will be applied
4386
- * Commit cannot be undone or reverted.
4387
- * Order-edit become closed for editing, however it's kept for reference and can be retrieved.
4388
- * @public
4389
- * @documentationMaturity preview
4390
- * @permissionId ECOM.DRAFT_ORDER_CREATE_ORDER_FROM_DRAFT
4391
- * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
4392
- * @permissionScope Manage Stores - all permissions
4393
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4394
- * @permissionScope Manage Restaurants - all permissions
4395
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4396
- * @permissionScope Manage eCommerce - all permissions
4397
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4398
- * @permissionScope Picasso private app mega scope
4399
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4400
- * @applicableIdentity APP
4401
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateOrderFromDraft
4402
- */
4403
- export declare function createOrderFromDraft(): Promise<void>;
4404
- /**
4405
- * Delete order-edit entity with all pending changes.
4406
- * Order-edit in status 'COMMITTED' cannot be deleted.
4407
- * @param draftOrderId - The draft order id
4408
- * @public
4409
- * @documentationMaturity preview
4410
- * @requiredField draftOrderId
4411
- * @permissionId ECOM.DRAFT_ORDERS_DELETE
4412
- * @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
4413
- * @permissionScope Manage Stores - all permissions
4414
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4415
- * @permissionScope Manage Restaurants - all permissions
4416
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4417
- * @permissionScope Manage eCommerce - all permissions
4418
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4419
- * @permissionScope Picasso private app mega scope
4420
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4421
- * @applicableIdentity APP
4422
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteDraftOrder
4423
- */
4424
- export declare function deleteDraftOrder(draftOrderId: string): Promise<void>;
4425
- /**
4426
- * Retrieves a list of draft orders given the provided paging, filtering, and sorting. Up to 100 draft orders can be returned per request.
4427
- *
4428
- * Refer to the table below for supported fields, filters, and sorting:
4429
- * | **Property** | **Supported Filters & Sorting** | **Sortable** |
4430
- * |----------------|---------------------------------------------------------------------------------|--------------|
4431
- * | `_createdDate` | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()`, `lt()`, `le()`, `gt()`, `ge()` | Sortable |
4432
- * | `_updatedDate` | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()`, `lt()`, `le()`, `gt()`, `ge()` | Sortable |
4433
- * | `status` | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()` | Sortable |
4434
- * | `orderId` | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()`, `startsWith()` | |
4435
- * To learn how to query draft orders, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
4436
- * @public
4437
- * @documentationMaturity preview
4438
- * @permissionScope Manage Stores - all permissions
4439
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4440
- * @permissionScope Manage Restaurants - all permissions
4441
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4442
- * @permissionScope Manage eCommerce - all permissions
4443
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4444
- * @permissionScope Picasso private app mega scope
4445
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4446
- * @permissionId ECOM.DRAFT_ORDERS_READ
4447
- * @applicableIdentity APP
4448
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.QueryDraftOrders
4449
- */
4450
- export declare function queryDraftOrders(): DraftOrdersQueryBuilder;
4451
- interface QueryCursorResult {
4452
- cursors: Cursors;
4453
- hasNext: () => boolean;
4454
- hasPrev: () => boolean;
4455
- length: number;
4456
- pageSize: number;
4457
- }
4458
- export interface DraftOrdersQueryResult extends QueryCursorResult {
4459
- items: DraftOrder[];
4460
- query: DraftOrdersQueryBuilder;
4461
- next: () => Promise<DraftOrdersQueryResult>;
4462
- prev: () => Promise<DraftOrdersQueryResult>;
4463
- }
4464
- export interface DraftOrdersQueryBuilder {
4465
- /** @param propertyName - Property whose value is compared with `value`.
4466
- * @param value - Value to compare against.
4467
- * @documentationMaturity preview
4468
- */
4469
- eq: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
4470
- /** @param propertyName - Property whose value is compared with `value`.
4471
- * @param value - Value to compare against.
4472
- * @documentationMaturity preview
4473
- */
4474
- ne: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
4475
- /** @param propertyName - Property whose value is compared with `value`.
4476
- * @param value - Value to compare against.
4477
- * @documentationMaturity preview
4478
- */
4479
- ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
4480
- /** @param propertyName - Property whose value is compared with `value`.
4481
- * @param value - Value to compare against.
4482
- * @documentationMaturity preview
4483
- */
4484
- gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
4485
- /** @param propertyName - Property whose value is compared with `value`.
4486
- * @param value - Value to compare against.
4487
- * @documentationMaturity preview
4488
- */
4489
- le: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
4490
- /** @param propertyName - Property whose value is compared with `value`.
4491
- * @param value - Value to compare against.
4492
- * @documentationMaturity preview
4493
- */
4494
- lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => DraftOrdersQueryBuilder;
4495
- /** @param propertyName - Property whose value is compared with `string`.
4496
- * @param string - String to compare against. Case-insensitive.
4497
- * @documentationMaturity preview
4498
- */
4499
- startsWith: (propertyName: 'orderId', value: string) => DraftOrdersQueryBuilder;
4500
- /** @param propertyName - Property whose value is compared with `values`.
4501
- * @param values - List of values to compare against.
4502
- * @documentationMaturity preview
4503
- */
4504
- hasSome: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any[]) => DraftOrdersQueryBuilder;
4505
- /** @documentationMaturity preview */
4506
- in: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;
4507
- /** @documentationMaturity preview */
4508
- exists: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: boolean) => DraftOrdersQueryBuilder;
4509
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
4510
- * @documentationMaturity preview
4511
- */
4512
- ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
4513
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
4514
- * @documentationMaturity preview
4515
- */
4516
- descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
4517
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
4518
- * @documentationMaturity preview
4519
- */
4520
- limit: (limit: number) => DraftOrdersQueryBuilder;
4521
- /** @param cursor - A pointer to specific record
4522
- * @documentationMaturity preview
4523
- */
4524
- skipTo: (cursor: string) => DraftOrdersQueryBuilder;
4525
- /** @documentationMaturity preview */
4526
- find: () => Promise<DraftOrdersQueryResult>;
4527
- }
4528
- /**
4529
- * Sets tax exemption to a draft order.
4530
- * @public
4531
- * @documentationMaturity preview
4532
- * @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION
4533
- * @permissionScope Manage Stores - all permissions
4534
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4535
- * @permissionScope Manage Restaurants - all permissions
4536
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4537
- * @permissionScope Manage eCommerce - all permissions
4538
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4539
- * @permissionScope Picasso private app mega scope
4540
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4541
- * @applicableIdentity APP
4542
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetTaxExemption
4543
- */
4544
- export declare function setTaxExemption(): Promise<void>;
4545
- /**
4546
- * Sets business location to a draft order.
4547
- * @public
4548
- * @documentationMaturity preview
4549
- * @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
4550
- * @permissionScope Manage Stores - all permissions
4551
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
4552
- * @permissionScope Manage Restaurants - all permissions
4553
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
4554
- * @permissionScope Manage eCommerce - all permissions
4555
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
4556
- * @permissionScope Picasso private app mega scope
4557
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
4558
- * @applicableIdentity APP
4559
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBusinessLocation
4560
- */
4561
- export declare function setBusinessLocation(): Promise<void>;
4562
- export {};