@wix/auto_sdk_ecom_checkout 1.0.0

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 (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/ecom-v1-checkout-checkout.context.d.ts +37 -0
  11. package/build/cjs/src/ecom-v1-checkout-checkout.context.js +71 -0
  12. package/build/cjs/src/ecom-v1-checkout-checkout.context.js.map +1 -0
  13. package/build/cjs/src/ecom-v1-checkout-checkout.http.d.ts +120 -0
  14. package/build/cjs/src/ecom-v1-checkout-checkout.http.js +1299 -0
  15. package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -0
  16. package/build/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +58 -0
  17. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js +332 -0
  18. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
  19. package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +186 -0
  20. package/build/cjs/src/ecom-v1-checkout-checkout.public.js +346 -0
  21. package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -0
  22. package/build/cjs/src/ecom-v1-checkout-checkout.types.d.ts +3046 -0
  23. package/build/cjs/src/ecom-v1-checkout-checkout.types.js +301 -0
  24. package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -0
  25. package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +3740 -0
  26. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +1513 -0
  27. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +37 -0
  39. package/build/es/src/ecom-v1-checkout-checkout.context.js +37 -0
  40. package/build/es/src/ecom-v1-checkout-checkout.context.js.map +1 -0
  41. package/build/es/src/ecom-v1-checkout-checkout.http.d.ts +120 -0
  42. package/build/es/src/ecom-v1-checkout-checkout.http.js +1280 -0
  43. package/build/es/src/ecom-v1-checkout-checkout.http.js.map +1 -0
  44. package/build/es/src/ecom-v1-checkout-checkout.meta.d.ts +58 -0
  45. package/build/es/src/ecom-v1-checkout-checkout.meta.js +290 -0
  46. package/build/es/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
  47. package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +186 -0
  48. package/build/es/src/ecom-v1-checkout-checkout.public.js +295 -0
  49. package/build/es/src/ecom-v1-checkout-checkout.public.js.map +1 -0
  50. package/build/es/src/ecom-v1-checkout-checkout.types.d.ts +3046 -0
  51. package/build/es/src/ecom-v1-checkout-checkout.types.js +298 -0
  52. package/build/es/src/ecom-v1-checkout-checkout.types.js.map +1 -0
  53. package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +3740 -0
  54. package/build/es/src/ecom-v1-checkout-checkout.universal.js +1471 -0
  55. package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +37 -0
  66. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +71 -0
  67. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js.map +1 -0
  68. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.d.ts +120 -0
  69. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +1299 -0
  70. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -0
  71. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +58 -0
  72. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js +332 -0
  73. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
  74. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +210 -0
  75. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +346 -0
  76. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -0
  77. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.d.ts +3085 -0
  78. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js +301 -0
  79. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -0
  80. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +4005 -0
  81. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +1513 -0
  82. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/ecom-v1-checkout-checkout.context.d.ts +37 -0
  93. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +37 -0
  94. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js.map +1 -0
  95. package/build/internal/es/src/ecom-v1-checkout-checkout.http.d.ts +120 -0
  96. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +1280 -0
  97. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +1 -0
  98. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.d.ts +58 -0
  99. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js +290 -0
  100. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
  101. package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +210 -0
  102. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +295 -0
  103. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +1 -0
  104. package/build/internal/es/src/ecom-v1-checkout-checkout.types.d.ts +3085 -0
  105. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js +298 -0
  106. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +1 -0
  107. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +4005 -0
  108. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +1471 -0
  109. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,4005 @@
1
+ export interface Checkout {
2
+ /**
3
+ * Checkout ID.
4
+ * @readonly
5
+ */
6
+ _id?: string | null;
7
+ /**
8
+ * Line items.
9
+ *
10
+ * Max: 300 items
11
+ * @readonly
12
+ */
13
+ lineItems?: LineItem[];
14
+ /** Billing information. */
15
+ billingInfo?: AddressWithContact;
16
+ /** Shipping information. */
17
+ shippingInfo?: ShippingInfo;
18
+ /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
19
+ buyerNote?: string | null;
20
+ /** Buyer information. */
21
+ buyerInfo?: BuyerInfo;
22
+ /**
23
+ * All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
24
+ * @readonly
25
+ */
26
+ conversionCurrency?: string;
27
+ /**
28
+ * Calculated price summary for the checkout.
29
+ * @readonly
30
+ */
31
+ priceSummary?: PriceSummary;
32
+ /**
33
+ * Errors when calculating totals.
34
+ * @readonly
35
+ */
36
+ calculationErrors?: CalculationErrors;
37
+ /**
38
+ * Applied gift card details.
39
+ *
40
+ * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/wix-stores-setting-up-wix-gift-cards).
41
+ * @readonly
42
+ */
43
+ giftCard?: GiftCard;
44
+ /**
45
+ * Applied discounts.
46
+ * @readonly
47
+ */
48
+ appliedDiscounts?: AppliedDiscount[];
49
+ /** Custom fields. */
50
+ customFields?: CustomField[];
51
+ /**
52
+ * Weight measurement unit - defaults to site's weight unit.
53
+ * @readonly
54
+ */
55
+ weightUnit?: WeightUnit;
56
+ /**
57
+ * Tax summary.
58
+ * @readonly
59
+ */
60
+ taxSummary?: TaxSummary;
61
+ /**
62
+ * The currency used when submitting the order.
63
+ * @readonly
64
+ */
65
+ currency?: string;
66
+ /**
67
+ * Sales channel that submitted the order.
68
+ * @readonly
69
+ */
70
+ channelType?: ChannelType;
71
+ /**
72
+ * Site language in which original values are shown.
73
+ * @readonly
74
+ */
75
+ siteLanguage?: string;
76
+ /**
77
+ * Language for communication with the buyer. Defaults to the site language.
78
+ * For a site that supports multiple languages, this is the language the buyer selected.
79
+ * @readonly
80
+ */
81
+ buyerLanguage?: string;
82
+ /**
83
+ * Whether an order was successfully created from this checkout.
84
+ * For an order to be successful, it must be successfully paid for (unless the total is 0).
85
+ * @readonly
86
+ */
87
+ completed?: boolean;
88
+ /**
89
+ * Whether tax is included in line item prices.
90
+ * @readonly
91
+ */
92
+ taxIncludedInPrice?: boolean;
93
+ /**
94
+ * ID of the checkout's initiator.
95
+ * @readonly
96
+ */
97
+ createdBy?: CreatedBy;
98
+ /**
99
+ * Date and time the checkout was created.
100
+ * @readonly
101
+ */
102
+ _createdDate?: Date | null;
103
+ /**
104
+ * Date and time the checkout was updated.
105
+ * @readonly
106
+ */
107
+ _updatedDate?: Date | null;
108
+ /**
109
+ * Minimal amount to pay in order to place the order.
110
+ * @readonly
111
+ */
112
+ payNow?: PriceSummary;
113
+ /**
114
+ * Remaining amount for the order to be fully paid.
115
+ * @readonly
116
+ */
117
+ payLater?: PriceSummary;
118
+ /** Memberships to apply when creating the order. */
119
+ membershipOptions?: MembershipOptions;
120
+ /** Additional Fees. */
121
+ additionalFees?: AdditionalFee[];
122
+ /** Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart. */
123
+ cartId?: string | null;
124
+ /**
125
+ * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
126
+ * @readonly
127
+ */
128
+ violations?: Violation[];
129
+ /**
130
+ * Custom field data for the checkout object.
131
+ *
132
+ * [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.
133
+ */
134
+ extendedFields?: ExtendedFields;
135
+ /**
136
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
137
+ * @readonly
138
+ */
139
+ purchaseFlowId?: string | null;
140
+ /**
141
+ * Additional settings for customization of the checkout process.
142
+ *
143
+ * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
144
+ */
145
+ customSettings?: CustomSettings;
146
+ /**
147
+ * Reference IDs for the app and component providing custom checkout page content.
148
+ *
149
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
150
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
151
+ */
152
+ customContentReference?: CustomContentReference;
153
+ /**
154
+ * Order ID.
155
+ *
156
+ * This field is empty until the checkout completes and becomes an order.
157
+ * @internal
158
+ * @readonly
159
+ */
160
+ orderId?: string | null;
161
+ /**
162
+ * Payment for subscriptions after free trial period.
163
+ * @internal
164
+ * @readonly
165
+ */
166
+ payAfterFreeTrial?: PriceSummary;
167
+ /**
168
+ * The business location ID associated with the checkout.
169
+ * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
170
+ * @internal
171
+ */
172
+ businessLocationId?: string | null;
173
+ /**
174
+ * Whether payment is required to create an order.
175
+ *
176
+ * Payment is required if any of the following conditions are met:
177
+ * 1. At least one item requires a payment method. This can be because the item has the `savePaymentMethod` field set to `true`, or the item is a subscription with a price greater than zero.
178
+ * 2. The calculated total amount due for immediate payment is greater than zero - `checkout.payNow > 0`.
179
+ * @internal
180
+ * @readonly
181
+ */
182
+ paymentRequired?: boolean;
183
+ }
184
+ export interface LineItem {
185
+ /**
186
+ * Line item ID.
187
+ * @readonly
188
+ */
189
+ _id?: string | null;
190
+ /**
191
+ * Item quantity.
192
+ *
193
+ * Min: `"1"`
194
+ * Max: `"100000"`
195
+ */
196
+ quantity?: number;
197
+ /** Catalog and item reference. Holds 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. */
198
+ catalogReference?: CatalogReference;
199
+ /**
200
+ * Item name.
201
+ * + Stores - `product.name`
202
+ * + Bookings - `service.info.name`
203
+ * + Events - `ticket.name`
204
+ * @readonly
205
+ */
206
+ productName?: ProductName;
207
+ /**
208
+ * URL to the item's page on the site.
209
+ * @readonly
210
+ */
211
+ url?: string;
212
+ /**
213
+ * Item price **after** catalog-defined discount and line item discounts.
214
+ * @readonly
215
+ */
216
+ price?: MultiCurrencyPrice;
217
+ /**
218
+ * Total line item price **after** catalog-defined discount and line item discounts.
219
+ * @readonly
220
+ */
221
+ lineItemPrice?: MultiCurrencyPrice;
222
+ /**
223
+ * Item price **before** catalog-defined discount. Defaults to `price` when not provided.
224
+ * @readonly
225
+ */
226
+ fullPrice?: MultiCurrencyPrice;
227
+ /**
228
+ * Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided.
229
+ * @readonly
230
+ */
231
+ priceBeforeDiscounts?: MultiCurrencyPrice;
232
+ /**
233
+ * Total price after all discounts and tax.
234
+ * @readonly
235
+ */
236
+ totalPriceAfterTax?: MultiCurrencyPrice;
237
+ /**
238
+ * Total price after discounts, and before tax.
239
+ * @readonly
240
+ */
241
+ totalPriceBeforeTax?: MultiCurrencyPrice;
242
+ /**
243
+ * Tax details for this line item.
244
+ * @readonly
245
+ */
246
+ taxDetails?: ItemTaxFullDetails;
247
+ /**
248
+ * Discount for this line item's entire quantity.
249
+ * @readonly
250
+ */
251
+ discount?: MultiCurrencyPrice;
252
+ /**
253
+ * Line item description lines. Used for displaying the cart, checkout and order.
254
+ * @readonly
255
+ */
256
+ descriptionLines?: DescriptionLine[];
257
+ /**
258
+ * Line item image details.
259
+ * @readonly
260
+ */
261
+ media?: string;
262
+ /**
263
+ * Item availability details.
264
+ * @readonly
265
+ */
266
+ availability?: ItemAvailabilityInfo;
267
+ /**
268
+ * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
269
+ * @readonly
270
+ */
271
+ physicalProperties?: PhysicalProperties;
272
+ /**
273
+ * Item type. Either a preset type or custom.
274
+ * @readonly
275
+ */
276
+ itemType?: ItemType;
277
+ /**
278
+ * Subscription option information.
279
+ * @readonly
280
+ */
281
+ subscriptionOptionInfo?: SubscriptionOptionInfo;
282
+ /**
283
+ * Type of selected payment option for current item. Defaults to `"FULL_PAYMENT_ONLINE"`.
284
+ * + `"FULL_PAYMENT_ONLINE"`: The entire payment for this item happens as part of the checkout.
285
+ * + `"FULL_PAYMENT_OFFLINE"`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
286
+ * + `"MEMBERSHIP"`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
287
+ * + `"DEPOSIT_ONLINE"`: Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.
288
+ * @readonly
289
+ */
290
+ paymentOption?: PaymentOptionType;
291
+ /**
292
+ * Service properties. When relevant, this contains information such as date and number of participants.
293
+ * @readonly
294
+ */
295
+ serviceProperties?: ServiceProperties;
296
+ /**
297
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
298
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
299
+ * + In most cases, this field has the same value as `catalogReference.catalogItemId`.
300
+ * + Used in membership validation.
301
+ * @readonly
302
+ */
303
+ rootCatalogItemId?: string | null;
304
+ /**
305
+ * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
306
+ * @readonly
307
+ */
308
+ priceDescription?: PriceDescription;
309
+ /**
310
+ * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
311
+ * @readonly
312
+ */
313
+ depositAmount?: MultiCurrencyPrice;
314
+ /**
315
+ * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
316
+ * @readonly
317
+ */
318
+ customLineItem?: boolean;
319
+ /**
320
+ * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
321
+ * @readonly
322
+ */
323
+ consentRequiredPaymentPolicy?: string | null;
324
+ /**
325
+ * Overriding values for catalog item properties.
326
+ *
327
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
328
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
329
+ */
330
+ catalogOverrideFields?: CatalogOverrideFields;
331
+ /**
332
+ * Whether the price is not yet defined, and will be updated after the order is created.
333
+ * @internal
334
+ * @readonly
335
+ */
336
+ priceUndetermined?: boolean;
337
+ /**
338
+ * Whether the line item quantity is fixed and cannot be changed.
339
+ * @internal
340
+ * @readonly
341
+ */
342
+ fixedQuantity?: boolean;
343
+ /**
344
+ * Whether to save the payment method on the order.
345
+ *
346
+ * Default: `false`
347
+ * @readonly
348
+ */
349
+ savePaymentMethod?: boolean;
350
+ /**
351
+ * Address to be used for tax calculation.
352
+ * @internal
353
+ */
354
+ taxableAddress?: TaxableAddress;
355
+ /**
356
+ * Custom extended fields for the line item object.
357
+ *
358
+ * [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.
359
+ * @internal
360
+ */
361
+ extendedFields?: ExtendedFields;
362
+ /**
363
+ * Policies to be displayed to the customer on the checkout page.
364
+ * @internal
365
+ * @readonly
366
+ */
367
+ policies?: Policy[];
368
+ /**
369
+ * ID of the app managing the inventory.
370
+ * @internal
371
+ */
372
+ inventoryAppId?: string | null;
373
+ /**
374
+ * Whether the item can only be purchased by site members.
375
+ *
376
+ * Default: `false`
377
+ * @internal
378
+ * @readonly
379
+ */
380
+ membersOnly?: boolean;
381
+ }
382
+ /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
383
+ export interface CatalogReference {
384
+ /** ID of the item within the catalog it belongs to. */
385
+ catalogItemId?: string;
386
+ /**
387
+ * ID of the app providing the catalog.
388
+ *
389
+ * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
390
+ *
391
+ * For items from Wix catalogs, the following values always apply:
392
+ * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
393
+ * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
394
+ * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
395
+ */
396
+ appId?: string;
397
+ /**
398
+ * Additional item details in key:value pairs.
399
+ *
400
+ * Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
401
+ *
402
+ * For products and variants from your Wix Stores catalog, learn more about [eCommerce integration](https://www.wix.com/velo/reference/wix-stores-backend/ecommerce-integration).
403
+ */
404
+ options?: Record<string, any> | null;
405
+ }
406
+ export interface ProductName {
407
+ /**
408
+ * __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).
409
+ *
410
+ * Min: 1 character.
411
+ * Max: 200 characters.
412
+ */
413
+ original?: string;
414
+ /**
415
+ * Item name translated into the buyer's language.
416
+ *
417
+ * Min: 1 character.
418
+ * Max: 400 characters.
419
+ * Default: Same as `original`.
420
+ */
421
+ translated?: string | null;
422
+ }
423
+ export interface MultiCurrencyPrice {
424
+ /** Amount. */
425
+ amount?: string;
426
+ /**
427
+ * Converted amount.
428
+ * @readonly
429
+ */
430
+ convertedAmount?: string;
431
+ /**
432
+ * Amount formatted with currency symbol.
433
+ * @readonly
434
+ */
435
+ formattedAmount?: string;
436
+ /**
437
+ * Converted amount formatted with currency symbol.
438
+ * @readonly
439
+ */
440
+ formattedConvertedAmount?: string;
441
+ }
442
+ export interface ItemTaxFullDetails {
443
+ /** Amount for which tax is calculated. */
444
+ taxableAmount?: MultiCurrencyPrice;
445
+ /** Tax rate %, as a decimal point between 0 and 1. */
446
+ taxRate?: string;
447
+ /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
448
+ totalTax?: MultiCurrencyPrice;
449
+ /**
450
+ * If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.
451
+ * @readonly
452
+ * @deprecated
453
+ */
454
+ rateBreakdown?: TaxRateBreakdown[];
455
+ }
456
+ export interface TaxRateBreakdown {
457
+ /** Name of tax against which the calculation was performed. */
458
+ name?: string;
459
+ /** Rate at which this tax detail was calculated. */
460
+ rate?: string;
461
+ /** Amount of tax for this tax detail. */
462
+ tax?: MultiCurrencyPrice;
463
+ }
464
+ /**
465
+ * TaxBreakdown represents tax information for a line item.
466
+ * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
467
+ */
468
+ export interface TaxBreakdown {
469
+ /** The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec". */
470
+ jurisdiction?: string | null;
471
+ /** The amount of this line item price that was considered nontaxable. (Decimal value) */
472
+ nonTaxableAmount?: MultiCurrencyPrice;
473
+ /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value) */
474
+ rate?: string | null;
475
+ /** The amount of tax estimated for this line item. (Decimal value) */
476
+ taxAmount?: MultiCurrencyPrice;
477
+ /** The taxable amount of this line item. */
478
+ taxableAmount?: MultiCurrencyPrice;
479
+ /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. */
480
+ taxType?: string | null;
481
+ /**
482
+ * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
483
+ * This name should be explicit enough to allow the merchant to understand what tax was calculated.
484
+ */
485
+ taxName?: string | null;
486
+ /** The type of the jurisdiction in which this tax detail applies. */
487
+ jurisdictionType?: JurisdictionType;
488
+ }
489
+ /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
490
+ export declare enum JurisdictionType {
491
+ UNDEFINED = "UNDEFINED",
492
+ COUNTRY = "COUNTRY",
493
+ STATE = "STATE",
494
+ COUNTY = "COUNTY",
495
+ CITY = "CITY",
496
+ SPECIAL = "SPECIAL"
497
+ }
498
+ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
499
+ /** Description line plain text value. */
500
+ plainText?: PlainTextValue;
501
+ /** Description line color value. */
502
+ colorInfo?: Color;
503
+ /** Description line name. */
504
+ name?: DescriptionLineName;
505
+ }
506
+ /** @oneof */
507
+ export interface DescriptionLineValueOneOf {
508
+ /** Description line plain text value. */
509
+ plainText?: PlainTextValue;
510
+ /** Description line color value. */
511
+ colorInfo?: Color;
512
+ }
513
+ /** @oneof */
514
+ export interface DescriptionLineDescriptionLineValueOneOf {
515
+ }
516
+ export interface DescriptionLineName {
517
+ /** 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). */
518
+ original?: string;
519
+ /**
520
+ * Description line name translated into the buyer's language.
521
+ *
522
+ * Default: Same as `original`.
523
+ */
524
+ translated?: string | null;
525
+ }
526
+ export interface PlainTextValue {
527
+ /** 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). */
528
+ original?: string;
529
+ /**
530
+ * Description line plain text value translated into the buyer's language.
531
+ *
532
+ * Default: Same as `original`.
533
+ */
534
+ translated?: string | null;
535
+ }
536
+ export interface Color {
537
+ /** 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). */
538
+ original?: string;
539
+ /**
540
+ * Description line color name translated into the buyer's language.
541
+ *
542
+ * Default: Same as `original`.
543
+ */
544
+ translated?: string | null;
545
+ /** HEX or RGB color code for display. */
546
+ code?: string | null;
547
+ }
548
+ export declare enum DescriptionLineType {
549
+ /** Unrecognized type. */
550
+ UNRECOGNISED = "UNRECOGNISED",
551
+ /** Plain text type. */
552
+ PLAIN_TEXT = "PLAIN_TEXT",
553
+ /** Color type. */
554
+ COLOR = "COLOR"
555
+ }
556
+ export interface FocalPoint {
557
+ /** X-coordinate of the focal point. */
558
+ x?: number;
559
+ /** Y-coordinate of the focal point. */
560
+ y?: number;
561
+ /** crop by height */
562
+ height?: number | null;
563
+ /** crop by width */
564
+ width?: number | null;
565
+ }
566
+ export interface ItemAvailabilityInfo {
567
+ /** Item availability status. */
568
+ status?: ItemAvailabilityStatus;
569
+ /** Quantity available. */
570
+ quantityAvailable?: number | null;
571
+ }
572
+ export declare enum ItemAvailabilityStatus {
573
+ AVAILABLE = "AVAILABLE",
574
+ /** Item does not exist */
575
+ NOT_FOUND = "NOT_FOUND",
576
+ /** Item not in stock */
577
+ NOT_AVAILABLE = "NOT_AVAILABLE",
578
+ /** Available quantity is less than requested */
579
+ PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
580
+ }
581
+ export interface PhysicalProperties {
582
+ /** Line item weight. Measurement unit (`"KG"` or `"LB"`) is taken from `order.weightUnit`. */
583
+ weight?: number | null;
584
+ /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
585
+ sku?: string | null;
586
+ /** Whether this line item is shippable. */
587
+ shippable?: boolean;
588
+ }
589
+ export interface Scope {
590
+ /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
591
+ namespace?: string;
592
+ /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
593
+ group?: Group;
594
+ }
595
+ export interface Group {
596
+ /** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
597
+ name?: string;
598
+ /** Item ID (when the coupon scope is limited to just one item). */
599
+ entityId?: string | null;
600
+ }
601
+ export interface ItemType extends ItemTypeItemTypeDataOneOf {
602
+ /** Preset item type. */
603
+ preset?: ItemTypeItemType;
604
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
605
+ custom?: string;
606
+ }
607
+ /** @oneof */
608
+ export interface ItemTypeItemTypeDataOneOf {
609
+ /** Preset item type. */
610
+ preset?: ItemTypeItemType;
611
+ /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
612
+ custom?: string;
613
+ }
614
+ export declare enum ItemTypeItemType {
615
+ UNRECOGNISED = "UNRECOGNISED",
616
+ PHYSICAL = "PHYSICAL",
617
+ DIGITAL = "DIGITAL",
618
+ GIFT_CARD = "GIFT_CARD",
619
+ SERVICE = "SERVICE"
620
+ }
621
+ export interface SubscriptionOptionInfo {
622
+ /** Subscription option settings. */
623
+ subscriptionSettings?: SubscriptionSettings;
624
+ /** Subscription option title. */
625
+ title?: Title;
626
+ /** Subscription option description. */
627
+ description?: Description;
628
+ }
629
+ export interface SubscriptionSettings {
630
+ /** Frequency of recurring payment. */
631
+ frequency?: SubscriptionFrequency;
632
+ /**
633
+ * Interval of recurring payment.
634
+ *
635
+ * Default: `1`.
636
+ * If SubscriptionFrequency is Day the minimum interval is 7
637
+ */
638
+ interval?: number | null;
639
+ /** Whether subscription is renewed automatically at the end of each period. */
640
+ autoRenewal?: boolean;
641
+ /** Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`. */
642
+ billingCycles?: number | null;
643
+ /**
644
+ * Whether to allow the customer to cancel the subscription..
645
+ * @internal
646
+ */
647
+ enableCustomerCancellation?: boolean;
648
+ /**
649
+ * Period until first cycle starts. If applied payNow will be 0
650
+ * If None => no free trial
651
+ * @internal
652
+ */
653
+ freeTrialPeriod?: FreeTrialPeriod;
654
+ /**
655
+ * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
656
+ * @internal
657
+ */
658
+ startDate?: Date | null;
659
+ }
660
+ /** Frequency unit of recurring payment */
661
+ export declare enum SubscriptionFrequency {
662
+ UNDEFINED = "UNDEFINED",
663
+ DAY = "DAY",
664
+ WEEK = "WEEK",
665
+ MONTH = "MONTH",
666
+ YEAR = "YEAR"
667
+ }
668
+ export interface FreeTrialPeriod {
669
+ /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */
670
+ frequency?: SubscriptionFrequency;
671
+ /** interval of period */
672
+ interval?: number;
673
+ }
674
+ export interface Title {
675
+ /** 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). */
676
+ original?: string;
677
+ /**
678
+ * Subscription option name translated into the buyer's language.
679
+ *
680
+ * Default: Same as `original`.
681
+ */
682
+ translated?: string | null;
683
+ }
684
+ export interface Description {
685
+ /** Subscription option description. */
686
+ original?: string;
687
+ /** Translated subscription option description. */
688
+ translated?: string | null;
689
+ }
690
+ export interface SecuredMedia {
691
+ /** Media ID in Wix Media Manager. */
692
+ _id?: string;
693
+ /** Original filename. */
694
+ fileName?: string;
695
+ /** File type. */
696
+ fileType?: FileType;
697
+ }
698
+ export declare enum FileType {
699
+ UNSPECIFIED = "UNSPECIFIED",
700
+ SECURE_PICTURE = "SECURE_PICTURE",
701
+ SECURE_VIDEO = "SECURE_VIDEO",
702
+ SECURE_DOCUMENT = "SECURE_DOCUMENT",
703
+ SECURE_MUSIC = "SECURE_MUSIC",
704
+ SECURE_ARCHIVE = "SECURE_ARCHIVE"
705
+ }
706
+ /** Type of selected payment option for catalog item */
707
+ export declare enum PaymentOptionType {
708
+ /** The entire payment for this item happens as part of the checkout. */
709
+ FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
710
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
711
+ FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
712
+ /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
713
+ MEMBERSHIP = "MEMBERSHIP",
714
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
715
+ DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
716
+ /** 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`. */
717
+ MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
718
+ }
719
+ export interface ServiceProperties {
720
+ /**
721
+ * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
722
+ * For example, the start time of a class.
723
+ */
724
+ scheduledDate?: Date | null;
725
+ /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
726
+ numberOfParticipants?: number | null;
727
+ }
728
+ export interface PriceDescription {
729
+ /** __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). */
730
+ original?: string;
731
+ /**
732
+ * Price description translated into the buyer's language.
733
+ *
734
+ * Default: Same as `original`.
735
+ */
736
+ translated?: string | null;
737
+ }
738
+ export interface CatalogOverrideFields {
739
+ /** Item name. */
740
+ productName?: ProductName;
741
+ /** Item price **after** discounts. */
742
+ price?: string | null;
743
+ /** Item price **before** discounts. */
744
+ fullPrice?: string | null;
745
+ /** Item description lines. Used when displaying the line item to customers. */
746
+ descriptionLines?: DescriptionLine[];
747
+ /** Physical properties of the item. */
748
+ physicalProperties?: PhysicalProperties;
749
+ /** Item image. */
750
+ image?: string;
751
+ /** Payment method selected for the item. */
752
+ paymentOption?: PaymentOption;
753
+ /** Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`. */
754
+ depositAmount?: string | null;
755
+ /**
756
+ * Whether to save the payment method on the order.
757
+ *
758
+ * Default: `false`
759
+ */
760
+ savePaymentMethod?: boolean | null;
761
+ }
762
+ export interface PaymentOption {
763
+ /**
764
+ * + `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.
765
+ * + `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
766
+ * + `MEMBERSHIP`: Payment for this item is done by charging a membership. When selected, `price` is `0`.
767
+ * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.
768
+ * + `MEMBERSHIP_OFFLINE`: 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`.
769
+ */
770
+ value?: PaymentOptionType;
771
+ }
772
+ export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
773
+ /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
774
+ addressType?: TaxableAddressType;
775
+ }
776
+ /** @oneof */
777
+ export interface TaxableAddressTaxableAddressDataOneOf {
778
+ /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
779
+ addressType?: TaxableAddressType;
780
+ }
781
+ export declare enum TaxableAddressType {
782
+ UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
783
+ BUSINESS = "BUSINESS",
784
+ BILLING = "BILLING",
785
+ SHIPPING = "SHIPPING"
786
+ }
787
+ export interface ExtendedFields {
788
+ /**
789
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
790
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
791
+ *
792
+ * You can only access fields for which you have the appropriate permissions.
793
+ *
794
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
795
+ */
796
+ namespaces?: Record<string, Record<string, any>>;
797
+ }
798
+ export interface Policy {
799
+ /** Policy title - should be translated */
800
+ title?: string | null;
801
+ /** Policy content - should be translated */
802
+ content?: string;
803
+ }
804
+ /** Billing Info and shipping details */
805
+ export interface AddressWithContact {
806
+ /** Address. */
807
+ address?: ApiAddress;
808
+ /** Contact details. */
809
+ contactDetails?: FullAddressContactDetails;
810
+ }
811
+ /** Physical address */
812
+ export interface ApiAddress {
813
+ /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
814
+ country?: string | null;
815
+ /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
816
+ subdivision?: string | null;
817
+ /** City name. */
818
+ city?: string | null;
819
+ /** Postal or zip code. */
820
+ postalCode?: string | null;
821
+ /** Street address. */
822
+ streetAddress?: StreetAddress;
823
+ /** Main address line (usually street name and number). */
824
+ addressLine1?: string | null;
825
+ /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
826
+ addressLine2?: string | null;
827
+ /**
828
+ * Country's full name.
829
+ * @readonly
830
+ */
831
+ countryFullname?: string | null;
832
+ /**
833
+ * Subdivision full-name.
834
+ * @readonly
835
+ */
836
+ subdivisionFullname?: string | null;
837
+ }
838
+ export interface StreetAddress {
839
+ /** Street number. */
840
+ number?: string;
841
+ /** Street name. */
842
+ name?: string;
843
+ }
844
+ export interface AddressLocation {
845
+ /** Address latitude. */
846
+ latitude?: number | null;
847
+ /** Address longitude. */
848
+ longitude?: number | null;
849
+ }
850
+ /** Full contact details for an address */
851
+ export interface FullAddressContactDetails {
852
+ /** First name. */
853
+ firstName?: string | null;
854
+ /** Last name. */
855
+ lastName?: string | null;
856
+ /** Phone number. */
857
+ phone?: string | null;
858
+ /** Company name. */
859
+ company?: string | null;
860
+ /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
861
+ vatId?: CommonVatId;
862
+ }
863
+ export interface CommonVatId {
864
+ /** Customer's tax ID. */
865
+ _id?: string;
866
+ /**
867
+ * Tax type.
868
+ *
869
+ * Supported values:
870
+ * + `CPF`: for individual tax payers
871
+ * + `CNPJ`: for corporations
872
+ */
873
+ type?: CommonVatType;
874
+ }
875
+ /** tax info types */
876
+ export declare enum CommonVatType {
877
+ UNSPECIFIED = "UNSPECIFIED",
878
+ /** CPF - for individual tax payers. */
879
+ CPF = "CPF",
880
+ /** CNPJ - for corporations */
881
+ CNPJ = "CNPJ"
882
+ }
883
+ export interface ShippingInfo {
884
+ /** Shipping address and contact details. */
885
+ shippingDestination?: AddressWithContact;
886
+ /** Selected option out of the options allowed for the `region`. */
887
+ selectedCarrierServiceOption?: SelectedCarrierServiceOption;
888
+ /**
889
+ * Shipping region. Based on the address provided.
890
+ * @readonly
891
+ */
892
+ region?: ShippingRegion;
893
+ /**
894
+ * All carrier options for this shipping rule.
895
+ * @readonly
896
+ */
897
+ carrierServiceOptions?: CarrierServiceOption[];
898
+ }
899
+ export interface SelectedCarrierServiceOption {
900
+ /** Unique identifier of selected option. For example, "usps_std_overnight". */
901
+ code?: string;
902
+ /**
903
+ * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
904
+ * For example, "Standard" or "First-Class Package International".
905
+ * @readonly
906
+ */
907
+ title?: string;
908
+ /**
909
+ * Delivery logistics.
910
+ * @readonly
911
+ */
912
+ logistics?: DeliveryLogistics;
913
+ /**
914
+ * Shipping costs.
915
+ * @readonly
916
+ */
917
+ cost?: SelectedCarrierServiceOptionPrices;
918
+ /**
919
+ * Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)
920
+ * @readonly
921
+ */
922
+ requestedShippingOption?: boolean;
923
+ /** Other charges */
924
+ otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
925
+ /** This carrier's unique ID */
926
+ carrierId?: string | null;
927
+ /** Delivery solution allocations to different delivery carriers and delivery regions */
928
+ deliveryAllocations?: DeliveryAllocation[];
929
+ /** If the delivery solution is a partial and doesn't apply to all items. */
930
+ partial?: boolean | null;
931
+ }
932
+ export interface DeliveryLogistics {
933
+ /** Expected delivery time, in free text. For example, "3-5 business days". */
934
+ deliveryTime?: string | null;
935
+ /** Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot". */
936
+ instructions?: string | null;
937
+ /** Pickup details. */
938
+ pickupDetails?: PickupDetails;
939
+ }
940
+ export interface PickupDetails {
941
+ /** Pickup address. */
942
+ address?: ApiAddress;
943
+ /**
944
+ * Whether the pickup address is that of a business - this may effect tax calculation.
945
+ * @deprecated
946
+ */
947
+ businessLocation?: boolean;
948
+ /** Pickup method */
949
+ pickupMethod?: PickupMethod;
950
+ }
951
+ export declare enum PickupMethod {
952
+ UNKNOWN_METHOD = "UNKNOWN_METHOD",
953
+ STORE_PICKUP = "STORE_PICKUP",
954
+ PICKUP_POINT = "PICKUP_POINT"
955
+ }
956
+ export interface DeliveryTimeSlot {
957
+ /** starting time of the delivery time slot */
958
+ from?: Date | null;
959
+ /** ending time of the delivery time slot */
960
+ to?: Date | null;
961
+ }
962
+ export interface SelectedCarrierServiceOptionPrices {
963
+ /** Total shipping price, after discount and after tax. */
964
+ totalPriceAfterTax?: MultiCurrencyPrice;
965
+ /** Total price of shipping after discounts (when relevant), and before tax. */
966
+ totalPriceBeforeTax?: MultiCurrencyPrice;
967
+ /** Tax details. */
968
+ taxDetails?: ItemTaxFullDetails;
969
+ /** Shipping discount before tax. */
970
+ totalDiscount?: MultiCurrencyPrice;
971
+ /** Shipping price before discount and before tax. */
972
+ price?: MultiCurrencyPrice;
973
+ }
974
+ export interface SelectedCarrierServiceOptionOtherCharge {
975
+ /** Type of additional cost. */
976
+ type?: ChargeType;
977
+ /** Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'. */
978
+ details?: string | null;
979
+ /** Price of added charge. */
980
+ cost?: SelectedCarrierServiceOptionPrices;
981
+ }
982
+ export declare enum ChargeType {
983
+ HANDLING_FEE = "HANDLING_FEE",
984
+ INSURANCE = "INSURANCE"
985
+ }
986
+ export interface DeliveryAllocation {
987
+ /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
988
+ deliveryCarrier?: Carrier;
989
+ /** The delivery region that are relevant for this delivery solution. */
990
+ deliveryRegion?: Region;
991
+ /** Populated if the delivery solution is a partially supplied by this carrier. */
992
+ applicableLineItems?: ApplicableLineItems;
993
+ }
994
+ export interface Carrier {
995
+ /** The carrier app id */
996
+ appId?: string | null;
997
+ /** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
998
+ code?: string;
999
+ }
1000
+ export interface Region {
1001
+ /** The delivery region id. */
1002
+ _id?: string | null;
1003
+ /** The delivery region name. */
1004
+ name?: string | null;
1005
+ }
1006
+ export interface ApplicableLineItems {
1007
+ /** Line items that the delivery solution is for. */
1008
+ lineItemIds?: string[];
1009
+ }
1010
+ export interface ShippingRegion {
1011
+ /**
1012
+ * Shipping region ID.
1013
+ * @readonly
1014
+ */
1015
+ _id?: string;
1016
+ /** Shipping region name. */
1017
+ name?: string;
1018
+ }
1019
+ export interface CarrierServiceOption {
1020
+ /** Carrier ID. */
1021
+ carrierId?: string;
1022
+ /** Shipping options offered by this carrier for this request. */
1023
+ shippingOptions?: ShippingOption[];
1024
+ }
1025
+ export interface ShippingOption {
1026
+ /**
1027
+ * Unique code of provided shipping option like "usps_std_overnight".
1028
+ * For legacy calculators this would be the UUID of the option.
1029
+ */
1030
+ code?: string;
1031
+ /**
1032
+ * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
1033
+ * For example, "Standard" or "First-Class Package International".
1034
+ */
1035
+ title?: string;
1036
+ /** Delivery logistics. */
1037
+ logistics?: DeliveryLogistics;
1038
+ /** Sipping price information. */
1039
+ cost?: ShippingPrice;
1040
+ /** Delivery solution allocations to different delivery carriers and delivery regions */
1041
+ deliveryAllocations?: DeliveryAllocation[];
1042
+ /** If the delivery solution is a partial and doesn't apply to all items. */
1043
+ partial?: boolean | null;
1044
+ }
1045
+ export interface ShippingPrice {
1046
+ /** Shipping price. */
1047
+ price?: MultiCurrencyPrice;
1048
+ /** Other costs such as insurance, handling & packaging for fragile items, etc. */
1049
+ otherCharges?: OtherCharge[];
1050
+ }
1051
+ export interface OtherCharge {
1052
+ /** Type of additional cost. */
1053
+ type?: ChargeType;
1054
+ /** Price of added cost. */
1055
+ price?: MultiCurrencyPrice;
1056
+ }
1057
+ export interface BuyerInfo extends BuyerInfoIdOneOf {
1058
+ /**
1059
+ * Visitor ID - if the buyer is **not** a site member.
1060
+ * @readonly
1061
+ */
1062
+ visitorId?: string;
1063
+ /**
1064
+ * Member ID - If the buyer is a site member.
1065
+ * @readonly
1066
+ */
1067
+ memberId?: string;
1068
+ /**
1069
+ * Contact ID. For more information, see the Contacts API.
1070
+ * @readonly
1071
+ */
1072
+ contactId?: string | null;
1073
+ /** Buyer email address. */
1074
+ email?: string | null;
1075
+ }
1076
+ /** @oneof */
1077
+ export interface BuyerInfoIdOneOf {
1078
+ /**
1079
+ * Visitor ID - if the buyer is **not** a site member.
1080
+ * @readonly
1081
+ */
1082
+ visitorId?: string;
1083
+ /**
1084
+ * Member ID - If the buyer is a site member.
1085
+ * @readonly
1086
+ */
1087
+ memberId?: string;
1088
+ }
1089
+ export interface PriceSummary {
1090
+ /** Subtotal of all line items, before discounts and before tax. */
1091
+ subtotal?: MultiCurrencyPrice;
1092
+ /** Total shipping price, before discounts and before tax. */
1093
+ shipping?: MultiCurrencyPrice;
1094
+ /** Total tax. */
1095
+ tax?: MultiCurrencyPrice;
1096
+ /** Total calculated discount value. */
1097
+ discount?: MultiCurrencyPrice;
1098
+ /** Total price after discounts, gift cards, and tax. */
1099
+ total?: MultiCurrencyPrice;
1100
+ /** Total additional fees price before tax. */
1101
+ additionalFees?: MultiCurrencyPrice;
1102
+ }
1103
+ export interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1104
+ /** General shipping calculation error. */
1105
+ generalShippingCalculationError?: Details;
1106
+ /** Carrier errors. */
1107
+ carrierErrors?: CarrierErrors;
1108
+ /** Tax calculation error. */
1109
+ taxCalculationError?: Details;
1110
+ /** Coupon calculation error. */
1111
+ couponCalculationError?: Details;
1112
+ /** Gift card calculation error. */
1113
+ giftCardCalculationError?: Details;
1114
+ /** Order validation errors. */
1115
+ orderValidationErrors?: ApplicationError[];
1116
+ /**
1117
+ * Membership payment methods calculation errors
1118
+ * For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid
1119
+ */
1120
+ membershipError?: Details;
1121
+ /** Discount Rule calculation error. */
1122
+ discountsCalculationError?: Details;
1123
+ }
1124
+ /** @oneof */
1125
+ export interface CalculationErrorsShippingCalculationErrorOneOf {
1126
+ /** General shipping calculation error. */
1127
+ generalShippingCalculationError?: Details;
1128
+ /** Carrier errors. */
1129
+ carrierErrors?: CarrierErrors;
1130
+ }
1131
+ export interface Details extends DetailsKindOneOf {
1132
+ applicationError?: ApplicationError;
1133
+ validationError?: ValidationError;
1134
+ systemError?: SystemError;
1135
+ /**
1136
+ * deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
1137
+ * @deprecated
1138
+ */
1139
+ tracing?: Record<string, string>;
1140
+ }
1141
+ /** @oneof */
1142
+ export interface DetailsKindOneOf {
1143
+ applicationError?: ApplicationError;
1144
+ validationError?: ValidationError;
1145
+ systemError?: SystemError;
1146
+ }
1147
+ export interface ApplicationError {
1148
+ /** Error code. */
1149
+ code?: string;
1150
+ /** Description of the error. */
1151
+ description?: string;
1152
+ /** Data related to the error. */
1153
+ data?: Record<string, any> | null;
1154
+ }
1155
+ /**
1156
+ * example result:
1157
+ * {
1158
+ * "fieldViolations": [
1159
+ * {
1160
+ * "field": "fieldA",
1161
+ * "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
1162
+ * "violatedRule": "OTHER",
1163
+ * "ruleName": "INVALID_NOTE",
1164
+ * "data": {
1165
+ * "value": "FI"
1166
+ * }
1167
+ * },
1168
+ * {
1169
+ * "field": "fieldB",
1170
+ * "description": "field value out of range. supported range: [0-20]",
1171
+ * "violatedRule": "MAX",
1172
+ * "data": {
1173
+ * "threshold": 20
1174
+ * }
1175
+ * },
1176
+ * {
1177
+ * "field": "fieldC",
1178
+ * "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
1179
+ * "violatedRule": "FORMAT",
1180
+ * "data": {
1181
+ * "type": "PHONE"
1182
+ * }
1183
+ * }
1184
+ * ]
1185
+ * }
1186
+ */
1187
+ export interface ValidationError {
1188
+ fieldViolations?: FieldViolation[];
1189
+ }
1190
+ export declare enum RuleType {
1191
+ VALIDATION = "VALIDATION",
1192
+ OTHER = "OTHER",
1193
+ MAX = "MAX",
1194
+ MIN = "MIN",
1195
+ MAX_LENGTH = "MAX_LENGTH",
1196
+ MIN_LENGTH = "MIN_LENGTH",
1197
+ MAX_SIZE = "MAX_SIZE",
1198
+ MIN_SIZE = "MIN_SIZE",
1199
+ FORMAT = "FORMAT",
1200
+ DECIMAL_LTE = "DECIMAL_LTE",
1201
+ DECIMAL_GTE = "DECIMAL_GTE",
1202
+ DECIMAL_LT = "DECIMAL_LT",
1203
+ DECIMAL_GT = "DECIMAL_GT",
1204
+ DECIMAL_MAX_SCALE = "DECIMAL_MAX_SCALE",
1205
+ INVALID_ENUM_VALUE = "INVALID_ENUM_VALUE",
1206
+ REQUIRED_FIELD = "REQUIRED_FIELD",
1207
+ FIELD_NOT_ALLOWED = "FIELD_NOT_ALLOWED",
1208
+ ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT",
1209
+ EXACT_LENGTH = "EXACT_LENGTH",
1210
+ EXACT_SIZE = "EXACT_SIZE",
1211
+ REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1212
+ }
1213
+ export interface FieldViolation {
1214
+ field?: string;
1215
+ description?: string;
1216
+ violatedRule?: RuleType;
1217
+ /** applicable when violated_rule=OTHER */
1218
+ ruleName?: string | null;
1219
+ data?: Record<string, any> | null;
1220
+ }
1221
+ export interface SystemError {
1222
+ /** Error code. */
1223
+ errorCode?: string | null;
1224
+ }
1225
+ export interface CarrierErrors {
1226
+ /** Carrier errors. */
1227
+ errors?: CarrierError[];
1228
+ }
1229
+ export interface CarrierError {
1230
+ /** Carrier ID. */
1231
+ carrierId?: string;
1232
+ /** Error details. */
1233
+ error?: Details;
1234
+ }
1235
+ export interface GiftCard {
1236
+ /**
1237
+ * Gift Card ID.
1238
+ * @deprecated
1239
+ */
1240
+ _id?: string;
1241
+ /** Gift card obfuscated code. */
1242
+ obfuscatedCode?: string;
1243
+ /** Gift card value. */
1244
+ amount?: MultiCurrencyPrice;
1245
+ /** App ID of the gift card provider. */
1246
+ appId?: string;
1247
+ /**
1248
+ * External ID in the gift card provider's system.
1249
+ * Used for integration and tracking across different platforms.
1250
+ */
1251
+ externalId?: string | null;
1252
+ }
1253
+ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1254
+ /** Coupon details. */
1255
+ coupon?: Coupon;
1256
+ /** Merchant discount. */
1257
+ merchantDiscount?: MerchantDiscount;
1258
+ /** Discount rule */
1259
+ discountRule?: DiscountRule;
1260
+ /** Discount type. */
1261
+ discountType?: DiscountType;
1262
+ /**
1263
+ * IDs of the line items the discount applies to.
1264
+ * @deprecated IDs of line items the discount applies to.
1265
+ * @replacedBy line_items_discounts
1266
+ * @targetRemovalDate 2024-06-01
1267
+ */
1268
+ lineItemIds?: string[];
1269
+ /**
1270
+ * Number of subscription cycle this discount applies to
1271
+ * default None - all billing cycle
1272
+ * @internal
1273
+ */
1274
+ subscriptionCycles?: number | null;
1275
+ }
1276
+ /** @oneof */
1277
+ export interface AppliedDiscountDiscountSourceOneOf {
1278
+ /** Coupon details. */
1279
+ coupon?: Coupon;
1280
+ /** Merchant discount. */
1281
+ merchantDiscount?: MerchantDiscount;
1282
+ /** Discount rule */
1283
+ discountRule?: DiscountRule;
1284
+ }
1285
+ export declare enum DiscountType {
1286
+ GLOBAL = "GLOBAL",
1287
+ SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1288
+ SHIPPING = "SHIPPING"
1289
+ }
1290
+ /** Coupon */
1291
+ export interface Coupon {
1292
+ /** Coupon ID. */
1293
+ _id?: string;
1294
+ /** Coupon code. */
1295
+ code?: string;
1296
+ /** Coupon value. */
1297
+ amount?: MultiCurrencyPrice;
1298
+ /** Coupon name. */
1299
+ name?: string;
1300
+ }
1301
+ export interface MerchantDiscount {
1302
+ /** Discount value. */
1303
+ amount?: MultiCurrencyPrice;
1304
+ /** Discount Percentage. Will be calculated from items price before other discounts. */
1305
+ percentage?: number | null;
1306
+ }
1307
+ export interface DiscountRule {
1308
+ /** Discount rule ID */
1309
+ _id?: string;
1310
+ /** Discount rule name */
1311
+ name?: DiscountRuleName;
1312
+ /** Discount value. */
1313
+ amount?: MultiCurrencyPrice;
1314
+ }
1315
+ export interface DiscountRuleName {
1316
+ /** Original discount rule name (in site's default language). */
1317
+ original?: string;
1318
+ /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
1319
+ translated?: string | null;
1320
+ }
1321
+ export interface LineItemDiscount {
1322
+ /** ID of line item the discount applies to. */
1323
+ _id?: string;
1324
+ /** Discount value. */
1325
+ totalDiscountAmount?: MultiCurrencyPrice;
1326
+ }
1327
+ export interface CustomField {
1328
+ /** Custom field value. */
1329
+ value?: any;
1330
+ /** Custom field title. */
1331
+ title?: string;
1332
+ /** Translated custom field title. */
1333
+ translatedTitle?: string | null;
1334
+ }
1335
+ export declare enum WeightUnit {
1336
+ /** Weight unit can't be classified, due to an error */
1337
+ UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
1338
+ /** Kilograms */
1339
+ KG = "KG",
1340
+ /** Pounds */
1341
+ LB = "LB"
1342
+ }
1343
+ export interface TaxSummary {
1344
+ /**
1345
+ * Amount for which tax is calculated, added from line items.
1346
+ * @readonly
1347
+ */
1348
+ taxableAmount?: MultiCurrencyPrice;
1349
+ /**
1350
+ * Calculated tax, added from line items.
1351
+ * @readonly
1352
+ */
1353
+ totalTax?: MultiCurrencyPrice;
1354
+ /**
1355
+ * Tax calculator that was active when the order was created.
1356
+ * @deprecated
1357
+ */
1358
+ calculationDetails?: TaxCalculationDetails;
1359
+ }
1360
+ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1361
+ /** Reason the manual calculation was used. */
1362
+ manualRateReason?: ManualCalculationReason;
1363
+ /** Details of the fallback rate calculation. */
1364
+ autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
1365
+ /** Rate calculation type. */
1366
+ rateType?: RateType;
1367
+ }
1368
+ /** @oneof */
1369
+ export interface TaxCalculationDetailsCalculationDetailsOneOf {
1370
+ /** Reason the manual calculation was used. */
1371
+ manualRateReason?: ManualCalculationReason;
1372
+ /** Details of the fallback rate calculation. */
1373
+ autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
1374
+ }
1375
+ export declare enum RateType {
1376
+ /** no tax being collected for this request due to location of purchase */
1377
+ NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
1378
+ /** manual rate used for calculation */
1379
+ MANUAL_RATE = "MANUAL_RATE",
1380
+ /** autotax rate used for calculation */
1381
+ AUTO_RATE = "AUTO_RATE",
1382
+ /** fallback rate used for calculation */
1383
+ FALLBACK_RATE = "FALLBACK_RATE"
1384
+ }
1385
+ export declare enum ManualCalculationReason {
1386
+ /** user set calculator in Business Manager to be Manual */
1387
+ GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
1388
+ /** specific region is on manual even though Global setting is Auto-tax */
1389
+ REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
1390
+ }
1391
+ export interface AutoTaxFallbackCalculationDetails {
1392
+ /** reason for fallback */
1393
+ fallbackReason?: FallbackReason;
1394
+ /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
1395
+ error?: ApplicationError;
1396
+ }
1397
+ export declare enum FallbackReason {
1398
+ /** auto-tax failed to be calculated */
1399
+ AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
1400
+ /** auto-tax was temporarily deactivated on a system-level */
1401
+ AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
1402
+ }
1403
+ /**
1404
+ * 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.
1405
+ * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
1406
+ */
1407
+ export interface AggregatedTaxBreakdown {
1408
+ /** The name of the tax against which this tax amount was calculated. */
1409
+ taxName?: string;
1410
+ /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */
1411
+ taxType?: string;
1412
+ /** The name of the jurisdiction in which this tax detail applies. */
1413
+ jurisdiction?: string;
1414
+ /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1415
+ jurisdictionTypeEnum?: JurisdictionType;
1416
+ /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value) */
1417
+ rate?: string;
1418
+ /** The sum of all the tax from line items that calculated by the tax identifiers. */
1419
+ aggregatedTaxAmount?: MultiCurrencyPrice;
1420
+ }
1421
+ export declare enum ChannelType {
1422
+ /** Unspecified sales channel. This value is not supported. */
1423
+ UNSPECIFIED = "UNSPECIFIED",
1424
+ /** A web client. */
1425
+ WEB = "WEB",
1426
+ /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */
1427
+ POS = "POS",
1428
+ /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */
1429
+ EBAY = "EBAY",
1430
+ /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */
1431
+ AMAZON = "AMAZON",
1432
+ /** Other sales platform. */
1433
+ OTHER_PLATFORM = "OTHER_PLATFORM",
1434
+ /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */
1435
+ WIX_APP_STORE = "WIX_APP_STORE",
1436
+ /** 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) */
1437
+ WIX_INVOICES = "WIX_INVOICES",
1438
+ /** Wix merchant backoffice. */
1439
+ BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
1440
+ /** Wish sales channel. */
1441
+ WISH = "WISH",
1442
+ /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */
1443
+ CLASS_PASS = "CLASS_PASS",
1444
+ /** Global-E sales channel. */
1445
+ GLOBAL_E = "GLOBAL_E",
1446
+ /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */
1447
+ FACEBOOK = "FACEBOOK",
1448
+ /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */
1449
+ ETSY = "ETSY",
1450
+ /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */
1451
+ TIKTOK = "TIKTOK",
1452
+ /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
1453
+ FAIRE_COM = "FAIRE_COM"
1454
+ }
1455
+ export interface CreatedBy extends CreatedByIdOneOf {
1456
+ /**
1457
+ * User ID - when the order was created by a Wix user on behalf of a buyer.
1458
+ * For example, via POS (point of service).
1459
+ */
1460
+ userId?: string;
1461
+ /** Member ID - when the order was created by a **logged in** site visitor. */
1462
+ memberId?: string;
1463
+ /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
1464
+ visitorId?: string;
1465
+ /** App ID - when the order was created by an external application or Wix service. */
1466
+ appId?: string;
1467
+ }
1468
+ /** @oneof */
1469
+ export interface CreatedByIdOneOf {
1470
+ /**
1471
+ * User ID - when the order was created by a Wix user on behalf of a buyer.
1472
+ * For example, via POS (point of service).
1473
+ */
1474
+ userId?: string;
1475
+ /** Member ID - when the order was created by a **logged in** site visitor. */
1476
+ memberId?: string;
1477
+ /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
1478
+ visitorId?: string;
1479
+ /** App ID - when the order was created by an external application or Wix service. */
1480
+ appId?: string;
1481
+ }
1482
+ /** Reserved for internal use. */
1483
+ export interface MembershipOptions {
1484
+ /**
1485
+ * Reserved for internal use.
1486
+ * @readonly
1487
+ */
1488
+ eligibleMemberships?: Membership[];
1489
+ /**
1490
+ * Reserved for internal use.
1491
+ * @readonly
1492
+ */
1493
+ invalidMemberships?: InvalidMembership[];
1494
+ /** Selected membership to apply to this checkout. */
1495
+ selectedMemberships?: SelectedMemberships;
1496
+ }
1497
+ export interface Membership {
1498
+ /** Membership ID. */
1499
+ _id?: string;
1500
+ /** ID of the application providing this payment option. */
1501
+ appId?: string;
1502
+ /** The name of this membership. */
1503
+ name?: MembershipName;
1504
+ /** Line item IDs which are "paid for" by this membership. */
1505
+ lineItemIds?: string[];
1506
+ /** Optional - For a membership that has limited credits, information about credit usage. */
1507
+ credits?: MembershipPaymentCredits;
1508
+ /** Optional - TMembership expiry date. */
1509
+ expirationDate?: Date | null;
1510
+ /** Additional data about this membership. */
1511
+ additionalData?: Record<string, any> | null;
1512
+ }
1513
+ export interface MembershipName {
1514
+ /** Membership name. */
1515
+ original?: string;
1516
+ /** Translated membership name. Defaults to `original` when not provided. */
1517
+ translated?: string | null;
1518
+ }
1519
+ export interface MembershipPaymentCredits {
1520
+ /** Membership's total amount of credits. */
1521
+ total?: number;
1522
+ /** Membership's remaining amount of credits. */
1523
+ remaining?: number;
1524
+ }
1525
+ export interface InvalidMembership {
1526
+ /** Membership details. */
1527
+ membership?: Membership;
1528
+ /** Reason why this membership is invalid and cannot be used. */
1529
+ reason?: string;
1530
+ }
1531
+ export interface SelectedMemberships {
1532
+ /** Selected memberships. */
1533
+ memberships?: SelectedMembership[];
1534
+ }
1535
+ export interface SelectedMembership {
1536
+ /** Membership ID. */
1537
+ _id?: string;
1538
+ /** ID of the app providing this payment option. */
1539
+ appId?: string;
1540
+ /** IDs of the line items this membership applies to. */
1541
+ lineItemIds?: string[];
1542
+ }
1543
+ export interface AdditionalFee {
1544
+ /** Additional fee's unique code (or ID) for future processing. */
1545
+ code?: string | null;
1546
+ /** Translated additional fee's name. */
1547
+ name?: string;
1548
+ /** Additional fee's price. */
1549
+ price?: MultiCurrencyPrice;
1550
+ /** Tax details. */
1551
+ taxDetails?: ItemTaxFullDetails;
1552
+ /** Provider's app id. */
1553
+ providerAppId?: string | null;
1554
+ /** Additional fee's price before tax. */
1555
+ priceBeforeTax?: MultiCurrencyPrice;
1556
+ /** Additional fee's price after tax. */
1557
+ priceAfterTax?: MultiCurrencyPrice;
1558
+ /**
1559
+ * Optional - Line items associated with this additional fee.
1560
+ * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
1561
+ */
1562
+ lineItemIds?: string[];
1563
+ /**
1564
+ * Number of subscription cycle this fee applies to
1565
+ * default None - all billing cycle
1566
+ * @internal
1567
+ */
1568
+ subscriptionCycles?: number | null;
1569
+ /** the source the additional fee was added from */
1570
+ source?: AdditionalFeeSource;
1571
+ }
1572
+ export declare enum AdditionalFeeSource {
1573
+ UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
1574
+ /** The additional fee was added by an additional fee service plugin */
1575
+ SERVICE_PLUGIN = "SERVICE_PLUGIN",
1576
+ /** The additional fee was added on the item either via the catalog or on custom line item */
1577
+ ITEM = "ITEM",
1578
+ /** The additional fee was added manually on the request */
1579
+ MANUAL = "MANUAL"
1580
+ }
1581
+ export interface ConversionInfo {
1582
+ /**
1583
+ * The site currency.
1584
+ * @readonly
1585
+ */
1586
+ siteCurrency?: string;
1587
+ /**
1588
+ * The rate used when converting from the site currency to the checkout currency.
1589
+ * @readonly
1590
+ */
1591
+ conversionRate?: string;
1592
+ }
1593
+ export interface Violation {
1594
+ /** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */
1595
+ severity?: Severity;
1596
+ /** Target location on a checkout or cart page where the violation will be displayed. */
1597
+ target?: Target;
1598
+ /** Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `<a href="https://www.wix.com">Click me</a>`. */
1599
+ description?: string | null;
1600
+ }
1601
+ export declare enum Severity {
1602
+ /** The user is allowed to move forward in the flow. */
1603
+ WARNING = "WARNING",
1604
+ /**
1605
+ * The user is blocked from moving forward in the flow.
1606
+ * For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.
1607
+ */
1608
+ ERROR = "ERROR"
1609
+ }
1610
+ export interface Target extends TargetTargetTypeOneOf {
1611
+ /** General (other) violation. */
1612
+ other?: Other;
1613
+ /** Specific line item violation. */
1614
+ lineItem?: TargetLineItem;
1615
+ }
1616
+ /** @oneof */
1617
+ export interface TargetTargetTypeOneOf {
1618
+ /** General (other) violation. */
1619
+ other?: Other;
1620
+ /** Specific line item violation. */
1621
+ lineItem?: TargetLineItem;
1622
+ }
1623
+ /** Available locations on the webpage */
1624
+ export declare enum NameInOther {
1625
+ /** Default location, in case no specific location is specified. */
1626
+ OTHER_DEFAULT = "OTHER_DEFAULT"
1627
+ }
1628
+ /** Available locations on the line item */
1629
+ export declare enum NameInLineItem {
1630
+ /** Default location, in case no specific location is specified. */
1631
+ LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
1632
+ }
1633
+ export declare enum SuggestedFix {
1634
+ /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
1635
+ UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
1636
+ /** The line item should be removed from the cart or checkout to resolve the violation. */
1637
+ REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
1638
+ }
1639
+ /** General (other) violation. */
1640
+ export interface Other {
1641
+ /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
1642
+ name?: NameInOther;
1643
+ }
1644
+ /** Specific line item violation. */
1645
+ export interface TargetLineItem {
1646
+ /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
1647
+ name?: NameInLineItem;
1648
+ /** ID of the line item containing the violation. */
1649
+ _id?: string | null;
1650
+ /**
1651
+ * Suggested fix for resolving the line item violation.
1652
+ * @internal
1653
+ */
1654
+ suggestedFix?: SuggestedFix;
1655
+ }
1656
+ export interface CustomSettings {
1657
+ /**
1658
+ * Whether to restrict the option to add or remove a gift card on the checkout page.
1659
+ *
1660
+ * Default: `false`
1661
+ */
1662
+ lockGiftCard?: boolean;
1663
+ /**
1664
+ * Whether to restrict the option to add or remove a coupon code on the checkout page.
1665
+ *
1666
+ * Default: `false`
1667
+ */
1668
+ lockCouponCode?: boolean;
1669
+ /**
1670
+ * Whether to disable policy agreement checkout in the checkout page
1671
+ *
1672
+ * Default: `false`
1673
+ */
1674
+ disabledPolicyAgreementCheckbox?: boolean;
1675
+ /**
1676
+ * Whether to disable manual payment option for this checkout.
1677
+ *
1678
+ * Default: `false`
1679
+ */
1680
+ disabledManualPayment?: boolean;
1681
+ }
1682
+ export interface CustomContentReference {
1683
+ /**
1684
+ * ID of the app providing the content.
1685
+ *
1686
+ * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
1687
+ */
1688
+ appId?: string;
1689
+ /**
1690
+ * ID of the component within the app it belongs to.
1691
+ *
1692
+ * You can get your component's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
1693
+ */
1694
+ componentId?: string;
1695
+ }
1696
+ export interface ExternalReference {
1697
+ /**
1698
+ * ID of the app associated with the purchase flow.
1699
+ * For example, the Wix Pay Links app ID.
1700
+ */
1701
+ appId?: string;
1702
+ /**
1703
+ * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
1704
+ * For example, a Wix Pay Link ID.
1705
+ */
1706
+ resourceId?: string | null;
1707
+ }
1708
+ export interface UpdatedCheckoutMessage {
1709
+ /** Previous checkout. */
1710
+ oldCheckout?: Checkout;
1711
+ /** Updated checkout. */
1712
+ updatedCheckout?: Checkout;
1713
+ }
1714
+ export interface CreateCheckoutRequest {
1715
+ /** Checkout information. */
1716
+ checkoutInfo?: Checkout;
1717
+ /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
1718
+ couponCode?: string | null;
1719
+ /** Catalog line items to add to the checkout. */
1720
+ lineItems?: LineItem[];
1721
+ /**
1722
+ * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
1723
+ *
1724
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1725
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
1726
+ */
1727
+ customLineItems?: CustomLineItem[];
1728
+ /**
1729
+ * Sales channel that submitted the order.
1730
+ * + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
1731
+ * + `"WEB"`: A web client.
1732
+ * + `"POS"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)
1733
+ * + `"EBAY"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)
1734
+ * + `"AMAZON"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)
1735
+ * + `"WISH"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)
1736
+ * + `"WIX_INVOICES"`: 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)
1737
+ * + `"WIX_APP_STORE"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)
1738
+ * + `"BACKOFFICE_MERCHANT"`: Wix merchant backoffice
1739
+ * + `"OTHER_PLATFORM"`: Other sales platform.
1740
+ */
1741
+ channelType: ChannelType;
1742
+ /**
1743
+ * Gift card code.
1744
+ *
1745
+ * The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.
1746
+ *
1747
+ * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/wix-stores-setting-up-wix-gift-cards).
1748
+ */
1749
+ giftCardCode?: string | null;
1750
+ /**
1751
+ * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
1752
+ *
1753
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
1754
+ */
1755
+ overrideCheckoutUrl?: string | null;
1756
+ }
1757
+ export interface CustomLineItem {
1758
+ /**
1759
+ * Custom line item quantity.
1760
+ *
1761
+ * Min: `1`
1762
+ * Max: `100000`
1763
+ */
1764
+ quantity?: number;
1765
+ /** Custom line item price. For security reasons, the `price` field should come from backend Velo code, and not be passed from the frontend. */
1766
+ price?: string;
1767
+ /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1768
+ priceDescription?: PriceDescription;
1769
+ /** Custom line item description lines. Used for displaying the cart, checkout and order. */
1770
+ descriptionLines?: DescriptionLine[];
1771
+ /**
1772
+ * Custom line item media.
1773
+ * + Link to an image/video from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager) - `"wix:image://v1/3c76e2_c53...4ea4~mv2.jpg#originWidth=1000&originHeight=1000"`.
1774
+ * + An image from the web - `"http(s)://<image url>"`.
1775
+ */
1776
+ media?: string;
1777
+ /**
1778
+ * Custom line item ID. If passed, `id` must be unique.
1779
+ *
1780
+ * Default: auto-generated ID
1781
+ */
1782
+ _id?: string | null;
1783
+ /** Tax group ID for this custom line item. */
1784
+ taxGroupId?: string | null;
1785
+ /** Name of the item or product. */
1786
+ productName?: ProductName;
1787
+ /** URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work. */
1788
+ url?: string;
1789
+ /** Item type. Either a preset type or custom. */
1790
+ itemType?: ItemType;
1791
+ /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */
1792
+ fullPrice?: string | null;
1793
+ /**
1794
+ * Item quantity available for purchase. Only return this if inventory is managed.
1795
+ * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
1796
+ */
1797
+ quantityAvailable?: number | null;
1798
+ /** Physical properties of the item. */
1799
+ physicalProperties?: PhysicalProperties;
1800
+ /**
1801
+ * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
1802
+ *
1803
+ * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
1804
+ * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
1805
+ * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
1806
+ * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field.
1807
+ */
1808
+ paymentOption?: PaymentOptionType;
1809
+ /**
1810
+ * Service properties. When relevant, this contains information such as date and number of participants.
1811
+ * Used, among other things, when checking for valid memberships.
1812
+ */
1813
+ serviceProperties?: ServiceProperties;
1814
+ /**
1815
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
1816
+ *
1817
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
1818
+ * + In most cases, this field is the same as `catalogReference.catalogItemId`.
1819
+ * + Used in membership validation.
1820
+ */
1821
+ rootCatalogItemId?: string | null;
1822
+ /**
1823
+ * Partial payment for the given item to be paid upfront during the checkout.
1824
+ *
1825
+ * Eligible for catalog items with type `DEPOSIT_ONLINE`.
1826
+ * When omitted, the item's price will not be split and is expected to be paid in a single installment.
1827
+ */
1828
+ depositAmount?: string | null;
1829
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
1830
+ catalogReference?: CatalogReference;
1831
+ /**
1832
+ * Whether the price is not yet defined, and will be updated after the order is created.
1833
+ *
1834
+ * Default: `false`
1835
+ * @internal
1836
+ */
1837
+ priceUndetermined?: boolean;
1838
+ /**
1839
+ * Whether the line item quantity is fixed and cannot be changed.
1840
+ *
1841
+ * Default: `false`
1842
+ * @internal
1843
+ */
1844
+ fixedQuantity?: boolean;
1845
+ /**
1846
+ * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
1847
+ * @readonly
1848
+ */
1849
+ consentRequiredPaymentPolicy?: string | null;
1850
+ /**
1851
+ * Whether to save the payment method on the order.
1852
+ *
1853
+ * Default: `false`
1854
+ * @readonly
1855
+ */
1856
+ savePaymentMethod?: boolean;
1857
+ /**
1858
+ * Policies to be displayed to the customer on the checkout page.
1859
+ * @internal
1860
+ */
1861
+ policies?: Policy[];
1862
+ /**
1863
+ * ID of the app managing the inventory.
1864
+ * @internal
1865
+ */
1866
+ inventoryAppId?: string | null;
1867
+ /**
1868
+ * Whether the item can only be purchased by site members.
1869
+ *
1870
+ * Default: `false`
1871
+ * @internal
1872
+ */
1873
+ membersOnly?: boolean;
1874
+ }
1875
+ export interface MerchantDiscountInput {
1876
+ /** Discount amount. */
1877
+ amount?: string;
1878
+ /** IDs of the line items the discount applies to. */
1879
+ lineItemIds?: string[];
1880
+ }
1881
+ export interface CreateCheckoutResponse {
1882
+ /** Newly created checkout. */
1883
+ checkout?: Checkout;
1884
+ }
1885
+ export interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {
1886
+ generalShippingCalculationError?: Details;
1887
+ carrierErrors?: CarrierErrors;
1888
+ }
1889
+ /** @oneof */
1890
+ export interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {
1891
+ generalShippingCalculationError?: Details;
1892
+ carrierErrors?: CarrierErrors;
1893
+ }
1894
+ export interface GetCheckoutRequest {
1895
+ /** Checkout ID. */
1896
+ _id: string;
1897
+ }
1898
+ export interface GetCheckoutResponse {
1899
+ /** The requested checkout. */
1900
+ checkout?: Checkout;
1901
+ }
1902
+ export interface GetCheckoutWithAllExtendedFieldsRequest {
1903
+ /** Checkout ID. */
1904
+ _id?: string;
1905
+ }
1906
+ export interface GetCheckoutWithAllExtendedFieldsResponse {
1907
+ /** The requested checkout. */
1908
+ checkout?: Checkout;
1909
+ }
1910
+ export interface GetCheckoutByCartIdRequest {
1911
+ /** Cart ID. */
1912
+ _id: string;
1913
+ }
1914
+ export interface GetCheckoutByCartIdResponse {
1915
+ /** The requested checkout. */
1916
+ checkout?: Checkout;
1917
+ }
1918
+ export interface GetWixCheckoutURLRequest {
1919
+ /** Checkout ID. */
1920
+ _id: string;
1921
+ }
1922
+ export interface GetWixCheckoutURLResponse {
1923
+ /** Checkout URL. */
1924
+ checkoutUrl?: string;
1925
+ }
1926
+ export interface GetCheckoutURLRequest {
1927
+ /** Checkout ID. */
1928
+ _id: string;
1929
+ }
1930
+ export interface GetCheckoutURLResponse {
1931
+ /** Checkout URL. */
1932
+ checkoutUrl?: string;
1933
+ }
1934
+ export interface UpdateCheckoutRequest {
1935
+ /** Checkout information. */
1936
+ checkout: Checkout;
1937
+ /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
1938
+ couponCode?: string | null;
1939
+ /** Gift card code. */
1940
+ giftCardCode?: string | null;
1941
+ /**
1942
+ * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
1943
+ *
1944
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
1945
+ */
1946
+ overrideCheckoutUrl?: string | null;
1947
+ /** Catalog line items. */
1948
+ lineItems?: LineItem[];
1949
+ /**
1950
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
1951
+ *
1952
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1953
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
1954
+ */
1955
+ customLineItems?: CustomLineItem[];
1956
+ }
1957
+ export interface UpdateCheckoutResponse {
1958
+ /** Updated checkout. */
1959
+ checkout?: Checkout;
1960
+ }
1961
+ export interface RemoveCouponRequest {
1962
+ /** ID of the checkout to remove the coupon from. */
1963
+ _id: string;
1964
+ }
1965
+ export interface RemoveCouponResponse {
1966
+ /** Updated checkout after removal of coupon. */
1967
+ checkout?: Checkout;
1968
+ }
1969
+ export interface RemoveGiftCardRequest {
1970
+ /** ID of the checkout to remove the gift card from. */
1971
+ _id: string;
1972
+ }
1973
+ export interface RemoveGiftCardResponse {
1974
+ /** Updated checkout after removal of gift card. */
1975
+ checkout?: Checkout;
1976
+ }
1977
+ export interface RemoveOverrideCheckoutUrlRequest {
1978
+ /** ID of the checkout to remove the override checkout url from. */
1979
+ _id: string;
1980
+ }
1981
+ export interface RemoveOverrideCheckoutUrlResponse {
1982
+ /** Updated checkout after removal of override checkout url. */
1983
+ checkout?: Checkout;
1984
+ }
1985
+ export interface AddToCheckoutRequest {
1986
+ /** Checkout ID. */
1987
+ _id: string;
1988
+ /** Catalog line items. */
1989
+ lineItems?: LineItem[];
1990
+ /**
1991
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
1992
+ *
1993
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1994
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
1995
+ */
1996
+ customLineItems?: CustomLineItem[];
1997
+ }
1998
+ export interface AddToCheckoutResponse {
1999
+ /** Updated checkout. */
2000
+ checkout?: Checkout;
2001
+ }
2002
+ export interface RemoveLineItemsRequest {
2003
+ /** ID of the checkout to remove line items from. */
2004
+ _id: string;
2005
+ /** IDs of the line items to remove from the checkout. */
2006
+ lineItemIds: string[];
2007
+ }
2008
+ export interface RemoveLineItemsResponse {
2009
+ /** Updated checkout after removal of line items. */
2010
+ checkout?: Checkout;
2011
+ }
2012
+ export interface CreateOrderRequest {
2013
+ /** Checkout ID. */
2014
+ _id: string;
2015
+ /** Indicates the payment method should be saved on the order */
2016
+ savePaymentMethod?: boolean;
2017
+ /** Indicates whether to authorize the payment and delay the capture */
2018
+ delayCapture?: boolean;
2019
+ }
2020
+ export interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
2021
+ /** ID of the newly created order. */
2022
+ orderId?: string;
2023
+ /** ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions). */
2024
+ subscriptionId?: string;
2025
+ /**
2026
+ * Payment gateway order ID.
2027
+ *
2028
+ * For online orders, pass this value as the `paymentId` parameter to the Wix Pay [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function so your customer can pay for the order.
2029
+ *
2030
+ * This field will be returned if money needs to be charged. In some cases, money cannot be charged:
2031
+ * + When the total price (the `priceSummary.total.amount` field in the checkout/order objects) is 0. For example, in the case of a free item or an item with a 100% discount.
2032
+ * + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.
2033
+ */
2034
+ paymentGatewayOrderId?: string | null;
2035
+ }
2036
+ /** @oneof */
2037
+ export interface CreateOrderResponseIdOneOf {
2038
+ /** ID of newly created order. */
2039
+ orderId?: string;
2040
+ /** ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions). */
2041
+ subscriptionId?: string;
2042
+ }
2043
+ export interface PaymentErrorResponseData {
2044
+ paymentResponseToken?: string | null;
2045
+ transactionStatus?: string;
2046
+ failureDetails?: string | null;
2047
+ }
2048
+ export interface DoublePaymentErrorData extends DoublePaymentErrorDataIdOneOf {
2049
+ orderId?: string;
2050
+ subscriptionId?: string;
2051
+ }
2052
+ /** @oneof */
2053
+ export interface DoublePaymentErrorDataIdOneOf {
2054
+ orderId?: string;
2055
+ subscriptionId?: string;
2056
+ }
2057
+ export interface RedeemErrorData {
2058
+ reason?: string;
2059
+ }
2060
+ export interface ViolationsList {
2061
+ /** Violations risen by ValidationsSPI implementers. */
2062
+ violations?: Violation[];
2063
+ }
2064
+ export interface CreateOrderAndChargeRequest {
2065
+ /** Checkout ID. */
2066
+ _id: string;
2067
+ /** Payment token. */
2068
+ paymentToken?: string | null;
2069
+ /** Indicates the payment method should be saved on the order */
2070
+ savePaymentMethod?: boolean;
2071
+ /** Indicates whether to authorize the payment and delay the capture */
2072
+ delayCapture?: boolean;
2073
+ }
2074
+ export interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
2075
+ /** ID of newly created order. */
2076
+ orderId?: string;
2077
+ /** ID of newly created subscription. */
2078
+ subscriptionId?: string;
2079
+ /** Payment response token. */
2080
+ paymentResponseToken?: string | null;
2081
+ /**
2082
+ * For online orders, send this value as a parameter to the Wix Pay [`startPayment()`](https://www.wix.com/velo/reference/wix-pay/startpayment) function to enable your buyer to pay for the order.
2083
+ * `paymentGatewayOrderId` will be returned if money needs to be charged.
2084
+ *
2085
+ * In some cases, money should not be charged:
2086
+ * + If the total price is 0. For example, in the case of a free item or an item with 100% discount.
2087
+ * + If the total price is not 0, but the payment is covered by alternative payment methods, such as a gift card.
2088
+ */
2089
+ paymentGatewayOrderId?: string | null;
2090
+ }
2091
+ /** @oneof */
2092
+ export interface CreateOrderAndChargeResponseIdOneOf {
2093
+ /** ID of newly created order. */
2094
+ orderId?: string;
2095
+ /** ID of newly created subscription. */
2096
+ subscriptionId?: string;
2097
+ }
2098
+ export interface MarkCheckoutAsCompletedRequest {
2099
+ /** Checkout ID. */
2100
+ _id: string;
2101
+ /**
2102
+ * Order ID.
2103
+ * @internal
2104
+ */
2105
+ orderId?: string | null;
2106
+ }
2107
+ export interface MarkCheckoutAsCompletedResponse {
2108
+ }
2109
+ /** Triggered when buyer successfully completed checkout flow */
2110
+ export interface CheckoutMarkedAsCompleted {
2111
+ checkout?: Checkout;
2112
+ }
2113
+ export interface UpdateLineItemsQuantityRequest {
2114
+ /** Checkout ID. */
2115
+ _id: string;
2116
+ /** Line item info to update. */
2117
+ lineItems: LineItemQuantityUpdate[];
2118
+ }
2119
+ export interface LineItemQuantityUpdate {
2120
+ /** ID of the line item to update. */
2121
+ _id?: string;
2122
+ /**
2123
+ * New total amount of the line item,
2124
+ * not the amount to add to the current `quantity`.
2125
+ *
2126
+ * Min: `1`
2127
+ *
2128
+ * Max: `100000`
2129
+ */
2130
+ quantity?: number;
2131
+ }
2132
+ export interface UpdateLineItemsQuantityResponse {
2133
+ /** Updated checkout. */
2134
+ checkout?: Checkout;
2135
+ }
2136
+ export interface GetCheckoutPaymentSettingsRequest {
2137
+ /** Checkout ID. */
2138
+ _id: string;
2139
+ }
2140
+ export interface GetCheckoutPaymentSettingsResponse {
2141
+ blockedPaymentOptions?: GetCheckoutPaymentSettingsResponsePaymentOption[];
2142
+ }
2143
+ export declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
2144
+ UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
2145
+ MANUAL = "MANUAL"
2146
+ }
2147
+ export interface DeleteCheckoutRequest {
2148
+ /** ID of the checkout to delete. */
2149
+ _id?: string;
2150
+ }
2151
+ export interface DeleteCheckoutResponse {
2152
+ }
2153
+ export interface SubscriptionCreated {
2154
+ subscription?: Subscription;
2155
+ }
2156
+ export interface Subscription {
2157
+ /**
2158
+ * Subscription id (auto-generated upon subscription creation)
2159
+ * @readonly
2160
+ */
2161
+ _id?: string;
2162
+ /** id of subscription in external system */
2163
+ externalId?: string | null;
2164
+ /**
2165
+ * Subscription creation date
2166
+ * @readonly
2167
+ */
2168
+ dateCreated?: Date | null;
2169
+ /** The id of the cart this order was created from */
2170
+ cartId?: string | null;
2171
+ /** The id of the checkout this subscriptions was created from */
2172
+ checkoutId?: string | null;
2173
+ /** member or contact */
2174
+ buyerInfo?: V1BuyerInfo;
2175
+ /** Line items ordered */
2176
+ lineItems?: V1LineItem[];
2177
+ /** Totals for subscription's line items */
2178
+ totals?: Totals;
2179
+ /** site settings at the moment when subscription created */
2180
+ storeSettings?: StoreSettings;
2181
+ /** Full billing address */
2182
+ billingAddress?: Address;
2183
+ /** Delivery information */
2184
+ shippingInfo?: V1ShippingInfo;
2185
+ /** Coupon that was applied to subscription */
2186
+ appliedCoupon?: AppliedCoupon;
2187
+ /** Message from the customer (e.g., customization request) */
2188
+ buyerNote?: string | null;
2189
+ /** Custom field */
2190
+ customField?: V1CustomField;
2191
+ /** Information about subscription option from which subscription was created */
2192
+ subscriptionOptionInfo?: V1SubscriptionOptionInfo;
2193
+ /** Sales channel that submitted this subscription */
2194
+ channelInfo?: ChannelInfo;
2195
+ /** defines when subscriber will be charged: for frequency=MONTH, billingCycles=6, interval=2 payment will be done every 2 month during one year */
2196
+ subscriptionSettings?: V1SubscriptionSettings;
2197
+ /**
2198
+ * information about first subscription payment
2199
+ * @readonly
2200
+ */
2201
+ billingInfo?: BillingInfo;
2202
+ }
2203
+ /** Buyer Info */
2204
+ export interface V1BuyerInfo {
2205
+ /** Wix customer ID */
2206
+ _id?: string;
2207
+ /** Customer type */
2208
+ identityType?: IdentityType;
2209
+ }
2210
+ export declare enum IdentityType {
2211
+ UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
2212
+ /** Site member */
2213
+ MEMBER = "MEMBER",
2214
+ /** Contact */
2215
+ CONTACT = "CONTACT"
2216
+ }
2217
+ export interface V1LineItem {
2218
+ /** Line item ID (auto-generated) */
2219
+ index?: number;
2220
+ /** Line item quantity */
2221
+ quantity?: number;
2222
+ /** Line item variantId (from Stores Catalog) */
2223
+ variantId?: string | null;
2224
+ /** Line item options ordered */
2225
+ options?: OptionSelection[];
2226
+ /** Line item custom text field selections */
2227
+ customTextFields?: CustomTextFieldSelection[];
2228
+ /** Charges details */
2229
+ chargeDetails?: ChargeDetails;
2230
+ /** Product details */
2231
+ productDetails?: ProductDetails;
2232
+ }
2233
+ export interface OptionSelection {
2234
+ /** Option name */
2235
+ option?: string;
2236
+ /** Selected choice for this option */
2237
+ selection?: string;
2238
+ }
2239
+ export interface CustomTextFieldSelection {
2240
+ /** Custom text field name */
2241
+ title?: string;
2242
+ /** Custom text field value */
2243
+ value?: string;
2244
+ }
2245
+ export interface ChargeDetails {
2246
+ /** price of line item (depends on subscription option) */
2247
+ price?: number;
2248
+ /** Total price charged to the customer (for this line items) after computation of quantity and discount */
2249
+ totalPrice?: number | null;
2250
+ /** Discount applied for this line item */
2251
+ discount?: number | null;
2252
+ /** Tax applied for this line item */
2253
+ tax?: number | null;
2254
+ /** Is tax applied for this line item */
2255
+ taxIncludedInPrice?: boolean;
2256
+ /** Tax rate %, as a decimal point >= 0 */
2257
+ taxRate?: string | null;
2258
+ }
2259
+ export interface ProductDetails {
2260
+ /** Line item product ID (optional for POS orders) */
2261
+ productId?: string | null;
2262
+ /** Line item name */
2263
+ name?: string;
2264
+ /** Line item name translated to buyer's language */
2265
+ translatedName?: string | null;
2266
+ /** Line item type (may be extended) */
2267
+ lineItemType?: LineItemType;
2268
+ /** Line item primary media for preview */
2269
+ mediaItem?: MediaItem;
2270
+ /** Line item SKU */
2271
+ sku?: string | null;
2272
+ /** Line item weight */
2273
+ weight?: number | null;
2274
+ /** Line item notes */
2275
+ notes?: string | null;
2276
+ /** Line item fulfillerId from stores fulfillers. No value means self fulfilled */
2277
+ fulfillerId?: string | null;
2278
+ /** Tax group id */
2279
+ taxGroupId?: string | null;
2280
+ /** App id from the catalog reference */
2281
+ appId?: string | null;
2282
+ }
2283
+ export declare enum LineItemType {
2284
+ /** Line item type can't be classified, due to an error */
2285
+ UNSPECIFIED_LINE_ITEM_TYPE = "UNSPECIFIED_LINE_ITEM_TYPE",
2286
+ /** Physical item type */
2287
+ PHYSICAL = "PHYSICAL",
2288
+ /** Digital item type */
2289
+ DIGITAL = "DIGITAL",
2290
+ /** Custom item price */
2291
+ CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
2292
+ }
2293
+ export interface MediaItem {
2294
+ /**
2295
+ * Media type
2296
+ * @readonly
2297
+ */
2298
+ mediaType?: MediaItemType;
2299
+ /**
2300
+ * Media URL
2301
+ * @readonly
2302
+ */
2303
+ url?: string;
2304
+ /**
2305
+ * Media item width
2306
+ * @readonly
2307
+ */
2308
+ width?: number;
2309
+ /**
2310
+ * Media item height
2311
+ * @readonly
2312
+ */
2313
+ height?: number;
2314
+ /** Media ID (for media items previously saved in Wix Media) */
2315
+ _id?: string | null;
2316
+ /** Media external URL */
2317
+ externalImageUrl?: string | null;
2318
+ /** Alternative text for presentation when media cannot be displayed */
2319
+ altText?: string | null;
2320
+ }
2321
+ export declare enum MediaItemType {
2322
+ /** Media item type can't be classified, due to an error */
2323
+ UNSPECIFIED_MEDIA_TYPE_ITEM = "UNSPECIFIED_MEDIA_TYPE_ITEM",
2324
+ /** Image item type */
2325
+ IMAGE = "IMAGE"
2326
+ }
2327
+ export interface Totals {
2328
+ /** Subtotal of all line items, before tax */
2329
+ subtotal?: number;
2330
+ /** Total shipping price, including tax */
2331
+ shipping?: number;
2332
+ /** Total tax */
2333
+ tax?: number;
2334
+ /** Total calculated discount value */
2335
+ discount?: number;
2336
+ /** Total price */
2337
+ total?: number;
2338
+ /** Total weight */
2339
+ weight?: number | null;
2340
+ /**
2341
+ * Total line items quantity
2342
+ * @readonly
2343
+ */
2344
+ quantity?: number;
2345
+ }
2346
+ export interface StoreSettings {
2347
+ /** Currency used for pricing in this store */
2348
+ currency?: string | null;
2349
+ /** Weight unit used in this store */
2350
+ weightUnit?: WeightUnit;
2351
+ /**
2352
+ * The language to be used when communicating with the buyer
2353
+ * For a site that support multiple languages, this would be the language the buyer selected
2354
+ * Otherwise this would be the site language
2355
+ */
2356
+ buyerLanguage?: string | null;
2357
+ }
2358
+ export interface Address extends AddressAddressLine1OptionsOneOf {
2359
+ /** Address line 1 (free text) */
2360
+ addressLine1?: string;
2361
+ /** Address line 1 (street) */
2362
+ street?: Street;
2363
+ /** Addressee name */
2364
+ fullName?: FullName;
2365
+ /** Country code (2 letters) */
2366
+ country?: string | null;
2367
+ /** State or district */
2368
+ subdivision?: string | null;
2369
+ /** City name */
2370
+ city?: string | null;
2371
+ /** ZIP/postal code */
2372
+ zipCode?: string | null;
2373
+ /** Phone number */
2374
+ phone?: string | null;
2375
+ /** Company name */
2376
+ company?: string | null;
2377
+ /** Email address */
2378
+ email?: string | null;
2379
+ /** address line */
2380
+ addressLine2?: string | null;
2381
+ /** Tax information (for Brazil only) */
2382
+ vatId?: VatId;
2383
+ }
2384
+ /** @oneof */
2385
+ export interface AddressAddressLine1OptionsOneOf {
2386
+ /** Address line 1 (free text) */
2387
+ addressLine1?: string;
2388
+ /** Address line 1 (street) */
2389
+ street?: Street;
2390
+ }
2391
+ export interface FullName {
2392
+ /** Customer's first name */
2393
+ firstName?: string;
2394
+ /** Customer's last name */
2395
+ lastName?: string;
2396
+ }
2397
+ export interface Street {
2398
+ /** Street number */
2399
+ number?: string;
2400
+ /** Street name */
2401
+ name?: string;
2402
+ }
2403
+ export interface VatId {
2404
+ /** Customer's tax ID. */
2405
+ number?: string;
2406
+ /**
2407
+ * Tax type.
2408
+ * + `CPF`: For individual tax payers.
2409
+ * + `CNPJ`: For corporations.
2410
+ */
2411
+ type?: VatType;
2412
+ }
2413
+ /** Brazilian tax info types */
2414
+ export declare enum VatType {
2415
+ /** When the tax info type can't be classified, due to an error */
2416
+ UNSPECIFIED_TAX_TYPE = "UNSPECIFIED_TAX_TYPE",
2417
+ /** CPF - for individual tax payers */
2418
+ CPF = "CPF",
2419
+ /** CNPJ - for corporations */
2420
+ CNPJ = "CNPJ"
2421
+ }
2422
+ export interface V1ShippingInfo extends V1ShippingInfoDetailsOneOf {
2423
+ /** Shipment details (when this object describes shipment) */
2424
+ shipmentDetails?: ShipmentDetails;
2425
+ /** Pickup details (when this object describes pickup) */
2426
+ pickupDetails?: V1PickupDetails;
2427
+ /** Delivery option name */
2428
+ deliveryOption?: string;
2429
+ /** Delivery option delivery time */
2430
+ estimatedDeliveryTime?: string | null;
2431
+ }
2432
+ /** @oneof */
2433
+ export interface V1ShippingInfoDetailsOneOf {
2434
+ /** Shipment details (when this object describes shipment) */
2435
+ shipmentDetails?: ShipmentDetails;
2436
+ /** Pickup details (when this object describes pickup) */
2437
+ pickupDetails?: V1PickupDetails;
2438
+ }
2439
+ export interface ShipmentDetails {
2440
+ /** Shipping destination address */
2441
+ address?: Address;
2442
+ /** Discount applied for shipping */
2443
+ discount?: number | null;
2444
+ /** Tax applied for shipping */
2445
+ tax?: number | null;
2446
+ /** Whether tax is included in the price */
2447
+ taxIncludedInPrice?: boolean;
2448
+ /** Tax rate % for shipping, as a decimal point >= 0 */
2449
+ taxRate?: string | null;
2450
+ }
2451
+ export interface V1PickupDetails {
2452
+ /** Pickup address */
2453
+ address?: PickupAddress;
2454
+ /** Store owner's pickup instructions */
2455
+ pickupInstructions?: string | null;
2456
+ }
2457
+ export interface PickupAddress {
2458
+ /** Country code (2 letters) */
2459
+ country?: string;
2460
+ /** State/District */
2461
+ subdivision?: string | null;
2462
+ /** Address */
2463
+ addressLine?: string;
2464
+ /** City */
2465
+ city?: string;
2466
+ /** ZIP/postal code */
2467
+ zipCode?: string;
2468
+ }
2469
+ export interface AppliedCoupon {
2470
+ /** Coupon ID */
2471
+ couponId?: string;
2472
+ /** Coupon name */
2473
+ name?: string;
2474
+ /** Coupon code */
2475
+ code?: string;
2476
+ }
2477
+ /** Custom field */
2478
+ export interface V1CustomField {
2479
+ /** Free text that the customer entered in the custom field during the checkout process */
2480
+ value?: string;
2481
+ /** Title for the custom field */
2482
+ title?: string;
2483
+ /** The title translated according to the buyer language */
2484
+ translatedTitle?: string;
2485
+ }
2486
+ export interface V1SubscriptionOptionInfo {
2487
+ _id?: string | null;
2488
+ title?: string;
2489
+ description?: string | null;
2490
+ discount?: Discount;
2491
+ }
2492
+ export interface Discount {
2493
+ /** Discount type. */
2494
+ type?: DiscountDiscountType;
2495
+ /** Discount value. */
2496
+ value?: number;
2497
+ }
2498
+ export declare enum DiscountDiscountType {
2499
+ UNDEFINED = "UNDEFINED",
2500
+ /** No discount */
2501
+ AMOUNT = "AMOUNT",
2502
+ PERCENT = "PERCENT"
2503
+ }
2504
+ export interface ChannelInfo {
2505
+ /** Sales channel that submitted the subscription */
2506
+ type?: ChannelInfoChannelType;
2507
+ }
2508
+ export declare enum ChannelInfoChannelType {
2509
+ UNSPECIFIED = "UNSPECIFIED",
2510
+ WEB = "WEB",
2511
+ OTHER_PLATFORM = "OTHER_PLATFORM",
2512
+ WIX_APP_STORE = "WIX_APP_STORE"
2513
+ }
2514
+ export interface V1SubscriptionSettings {
2515
+ /** Frequency of recurring payment. */
2516
+ frequency?: SubscriptionFrequency;
2517
+ /** Whether subscription is renewed automatically at the end of each period. */
2518
+ autoRenewal?: boolean;
2519
+ /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
2520
+ billingCycles?: number | null;
2521
+ }
2522
+ export interface BillingInfo {
2523
+ /** Payment method used for this order */
2524
+ paymentMethod?: string | null;
2525
+ /** Transaction ID from payment gateway (e.g., Wix Payments) */
2526
+ paymentGatewayTransactionId?: string | null;
2527
+ /** Order ID from payment gateway (e.g., Wix Payments) */
2528
+ paymentGatewayOrderId?: string | null;
2529
+ }
2530
+ export interface Empty {
2531
+ }
2532
+ export interface DomainEvent extends DomainEventBodyOneOf {
2533
+ createdEvent?: EntityCreatedEvent;
2534
+ updatedEvent?: EntityUpdatedEvent;
2535
+ deletedEvent?: EntityDeletedEvent;
2536
+ actionEvent?: ActionEvent;
2537
+ /**
2538
+ * Unique event ID.
2539
+ * Allows clients to ignore duplicate webhooks.
2540
+ */
2541
+ _id?: string;
2542
+ /**
2543
+ * Assumes actions are also always typed to an entity_type
2544
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2545
+ */
2546
+ entityFqdn?: string;
2547
+ /**
2548
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2549
+ * This is although the created/updated/deleted notion is duplication of the oneof types
2550
+ * Example: created/updated/deleted/started/completed/email_opened
2551
+ */
2552
+ slug?: string;
2553
+ /** ID of the entity associated with the event. */
2554
+ entityId?: string;
2555
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2556
+ eventTime?: Date | null;
2557
+ /**
2558
+ * Whether the event was triggered as a result of a privacy regulation application
2559
+ * (for example, GDPR).
2560
+ */
2561
+ triggeredByAnonymizeRequest?: boolean | null;
2562
+ /** If present, indicates the action that triggered the event. */
2563
+ originatedFrom?: string | null;
2564
+ /**
2565
+ * A sequence number defining the order of updates to the underlying entity.
2566
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
2567
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2568
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2569
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
2570
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2571
+ */
2572
+ entityEventSequence?: string | null;
2573
+ }
2574
+ /** @oneof */
2575
+ export interface DomainEventBodyOneOf {
2576
+ createdEvent?: EntityCreatedEvent;
2577
+ updatedEvent?: EntityUpdatedEvent;
2578
+ deletedEvent?: EntityDeletedEvent;
2579
+ actionEvent?: ActionEvent;
2580
+ }
2581
+ export interface EntityCreatedEvent {
2582
+ entity?: string;
2583
+ }
2584
+ export interface RestoreInfo {
2585
+ deletedDate?: Date | null;
2586
+ }
2587
+ export interface EntityUpdatedEvent {
2588
+ /**
2589
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2590
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2591
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2592
+ */
2593
+ currentEntity?: string;
2594
+ }
2595
+ export interface EntityDeletedEvent {
2596
+ /** Entity that was deleted */
2597
+ deletedEntity?: string | null;
2598
+ }
2599
+ export interface ActionEvent {
2600
+ body?: string;
2601
+ }
2602
+ export interface MessageEnvelope {
2603
+ /** App instance ID. */
2604
+ instanceId?: string | null;
2605
+ /** Event type. */
2606
+ eventType?: string;
2607
+ /** The identification type and identity data. */
2608
+ identity?: IdentificationData;
2609
+ /** Stringify payload. */
2610
+ data?: string;
2611
+ }
2612
+ export interface IdentificationData extends IdentificationDataIdOneOf {
2613
+ /** ID of a site visitor that has not logged in to the site. */
2614
+ anonymousVisitorId?: string;
2615
+ /** ID of a site visitor that has logged in to the site. */
2616
+ memberId?: string;
2617
+ /** ID of a Wix user (site owner, contributor, etc.). */
2618
+ wixUserId?: string;
2619
+ /** ID of an app. */
2620
+ appId?: string;
2621
+ /** @readonly */
2622
+ identityType?: WebhookIdentityType;
2623
+ }
2624
+ /** @oneof */
2625
+ export interface IdentificationDataIdOneOf {
2626
+ /** ID of a site visitor that has not logged in to the site. */
2627
+ anonymousVisitorId?: string;
2628
+ /** ID of a site visitor that has logged in to the site. */
2629
+ memberId?: string;
2630
+ /** ID of a Wix user (site owner, contributor, etc.). */
2631
+ wixUserId?: string;
2632
+ /** ID of an app. */
2633
+ appId?: string;
2634
+ }
2635
+ export declare enum WebhookIdentityType {
2636
+ UNKNOWN = "UNKNOWN",
2637
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2638
+ MEMBER = "MEMBER",
2639
+ WIX_USER = "WIX_USER",
2640
+ APP = "APP"
2641
+ }
2642
+ interface CatalogReferenceNonNullableFields {
2643
+ catalogItemId: string;
2644
+ appId: string;
2645
+ }
2646
+ interface ProductNameNonNullableFields {
2647
+ original: string;
2648
+ }
2649
+ interface MultiCurrencyPriceNonNullableFields {
2650
+ amount: string;
2651
+ convertedAmount: string;
2652
+ formattedAmount: string;
2653
+ formattedConvertedAmount: string;
2654
+ }
2655
+ interface TaxRateBreakdownNonNullableFields {
2656
+ name: string;
2657
+ rate: string;
2658
+ tax?: MultiCurrencyPriceNonNullableFields;
2659
+ exemptAmount?: MultiCurrencyPriceNonNullableFields;
2660
+ exemptionIds: number[];
2661
+ taxableAmount?: MultiCurrencyPriceNonNullableFields;
2662
+ }
2663
+ interface TaxBreakdownNonNullableFields {
2664
+ nonTaxableAmount?: MultiCurrencyPriceNonNullableFields;
2665
+ taxAmount?: MultiCurrencyPriceNonNullableFields;
2666
+ taxableAmount?: MultiCurrencyPriceNonNullableFields;
2667
+ jurisdictionType: JurisdictionType;
2668
+ }
2669
+ interface ItemTaxFullDetailsNonNullableFields {
2670
+ taxableAmount?: MultiCurrencyPriceNonNullableFields;
2671
+ taxRate: string;
2672
+ totalTax?: MultiCurrencyPriceNonNullableFields;
2673
+ rateBreakdown: TaxRateBreakdownNonNullableFields[];
2674
+ exemptAmount?: MultiCurrencyPriceNonNullableFields;
2675
+ taxBreakdown: TaxBreakdownNonNullableFields[];
2676
+ }
2677
+ interface PlainTextValueNonNullableFields {
2678
+ original: string;
2679
+ }
2680
+ interface ColorNonNullableFields {
2681
+ original: string;
2682
+ }
2683
+ interface DescriptionLineNameNonNullableFields {
2684
+ original: string;
2685
+ }
2686
+ interface DescriptionLineNonNullableFields {
2687
+ plainText?: PlainTextValueNonNullableFields;
2688
+ colorInfo?: ColorNonNullableFields;
2689
+ plainTextValue?: PlainTextValueNonNullableFields;
2690
+ color: string;
2691
+ name?: DescriptionLineNameNonNullableFields;
2692
+ lineType: DescriptionLineType;
2693
+ }
2694
+ interface ItemAvailabilityInfoNonNullableFields {
2695
+ status: ItemAvailabilityStatus;
2696
+ }
2697
+ interface PhysicalPropertiesNonNullableFields {
2698
+ shippable: boolean;
2699
+ }
2700
+ interface GroupNonNullableFields {
2701
+ name: string;
2702
+ }
2703
+ interface ScopeNonNullableFields {
2704
+ namespace: string;
2705
+ group?: GroupNonNullableFields;
2706
+ }
2707
+ interface ItemTypeNonNullableFields {
2708
+ preset: ItemTypeItemType;
2709
+ custom: string;
2710
+ }
2711
+ interface FreeTrialPeriodNonNullableFields {
2712
+ frequency: SubscriptionFrequency;
2713
+ interval: number;
2714
+ }
2715
+ interface SubscriptionSettingsNonNullableFields {
2716
+ frequency: SubscriptionFrequency;
2717
+ autoRenewal: boolean;
2718
+ /** @internal */
2719
+ enableCustomerCancellation: boolean;
2720
+ /** @internal */
2721
+ freeTrialPeriod?: FreeTrialPeriodNonNullableFields;
2722
+ }
2723
+ interface TitleNonNullableFields {
2724
+ original: string;
2725
+ }
2726
+ interface DescriptionNonNullableFields {
2727
+ original: string;
2728
+ }
2729
+ interface SubscriptionOptionInfoNonNullableFields {
2730
+ subscriptionSettings?: SubscriptionSettingsNonNullableFields;
2731
+ title?: TitleNonNullableFields;
2732
+ description?: DescriptionNonNullableFields;
2733
+ }
2734
+ interface SecuredMediaNonNullableFields {
2735
+ _id: string;
2736
+ fileName: string;
2737
+ fileType: FileType;
2738
+ }
2739
+ interface PriceDescriptionNonNullableFields {
2740
+ original: string;
2741
+ }
2742
+ interface PaymentOptionNonNullableFields {
2743
+ value: PaymentOptionType;
2744
+ }
2745
+ interface CatalogOverrideFieldsNonNullableFields {
2746
+ productName?: ProductNameNonNullableFields;
2747
+ descriptionLines: DescriptionLineNonNullableFields[];
2748
+ physicalProperties?: PhysicalPropertiesNonNullableFields;
2749
+ image: string;
2750
+ paymentOption?: PaymentOptionNonNullableFields;
2751
+ }
2752
+ interface TaxableAddressNonNullableFields {
2753
+ addressType: TaxableAddressType;
2754
+ }
2755
+ interface PolicyNonNullableFields {
2756
+ content: string;
2757
+ }
2758
+ interface LineItemNonNullableFields {
2759
+ quantity: number;
2760
+ catalogReference?: CatalogReferenceNonNullableFields;
2761
+ productName?: ProductNameNonNullableFields;
2762
+ url: string;
2763
+ price?: MultiCurrencyPriceNonNullableFields;
2764
+ lineItemPrice?: MultiCurrencyPriceNonNullableFields;
2765
+ fullPrice?: MultiCurrencyPriceNonNullableFields;
2766
+ priceBeforeDiscounts?: MultiCurrencyPriceNonNullableFields;
2767
+ totalPriceAfterTax?: MultiCurrencyPriceNonNullableFields;
2768
+ totalPriceBeforeTax?: MultiCurrencyPriceNonNullableFields;
2769
+ taxDetails?: ItemTaxFullDetailsNonNullableFields;
2770
+ discount?: MultiCurrencyPriceNonNullableFields;
2771
+ descriptionLines: DescriptionLineNonNullableFields[];
2772
+ media: string;
2773
+ availability?: ItemAvailabilityInfoNonNullableFields;
2774
+ physicalProperties?: PhysicalPropertiesNonNullableFields;
2775
+ /** @internal */
2776
+ couponScopes: ScopeNonNullableFields[];
2777
+ itemType?: ItemTypeNonNullableFields;
2778
+ subscriptionOptionInfo?: SubscriptionOptionInfoNonNullableFields;
2779
+ digitalFile?: SecuredMediaNonNullableFields;
2780
+ paymentOption: PaymentOptionType;
2781
+ priceDescription?: PriceDescriptionNonNullableFields;
2782
+ depositAmount?: MultiCurrencyPriceNonNullableFields;
2783
+ customLineItem: boolean;
2784
+ catalogOverrideFields?: CatalogOverrideFieldsNonNullableFields;
2785
+ /** @internal */
2786
+ priceUndetermined: boolean;
2787
+ /** @internal */
2788
+ fixedQuantity: boolean;
2789
+ savePaymentMethod: boolean;
2790
+ /** @internal */
2791
+ taxableAddress?: TaxableAddressNonNullableFields;
2792
+ /** @internal */
2793
+ policies: PolicyNonNullableFields[];
2794
+ /** @internal */
2795
+ membersOnly: boolean;
2796
+ }
2797
+ interface StreetAddressNonNullableFields {
2798
+ number: string;
2799
+ name: string;
2800
+ apt: string;
2801
+ }
2802
+ interface ApiAddressNonNullableFields {
2803
+ streetAddress?: StreetAddressNonNullableFields;
2804
+ }
2805
+ interface CommonVatIdNonNullableFields {
2806
+ _id: string;
2807
+ type: CommonVatType;
2808
+ }
2809
+ interface FullAddressContactDetailsNonNullableFields {
2810
+ vatId?: CommonVatIdNonNullableFields;
2811
+ }
2812
+ interface AddressWithContactNonNullableFields {
2813
+ address?: ApiAddressNonNullableFields;
2814
+ contactDetails?: FullAddressContactDetailsNonNullableFields;
2815
+ }
2816
+ interface PickupDetailsNonNullableFields {
2817
+ address?: ApiAddressNonNullableFields;
2818
+ businessLocation: boolean;
2819
+ pickupMethod: PickupMethod;
2820
+ }
2821
+ interface DeliveryLogisticsNonNullableFields {
2822
+ pickupDetails?: PickupDetailsNonNullableFields;
2823
+ }
2824
+ interface SelectedCarrierServiceOptionPricesNonNullableFields {
2825
+ totalPriceAfterTax?: MultiCurrencyPriceNonNullableFields;
2826
+ totalPriceBeforeTax?: MultiCurrencyPriceNonNullableFields;
2827
+ taxDetails?: ItemTaxFullDetailsNonNullableFields;
2828
+ totalDiscount?: MultiCurrencyPriceNonNullableFields;
2829
+ price?: MultiCurrencyPriceNonNullableFields;
2830
+ }
2831
+ interface SelectedCarrierServiceOptionOtherChargeNonNullableFields {
2832
+ type: ChargeType;
2833
+ cost?: SelectedCarrierServiceOptionPricesNonNullableFields;
2834
+ }
2835
+ interface CarrierNonNullableFields {
2836
+ code: string;
2837
+ }
2838
+ interface ApplicableLineItemsNonNullableFields {
2839
+ lineItemIds: string[];
2840
+ }
2841
+ interface DeliveryAllocationNonNullableFields {
2842
+ deliveryCarrier?: CarrierNonNullableFields;
2843
+ applicableLineItems?: ApplicableLineItemsNonNullableFields;
2844
+ }
2845
+ interface SelectedCarrierServiceOptionNonNullableFields {
2846
+ code: string;
2847
+ title: string;
2848
+ logistics?: DeliveryLogisticsNonNullableFields;
2849
+ cost?: SelectedCarrierServiceOptionPricesNonNullableFields;
2850
+ requestedShippingOption: boolean;
2851
+ otherCharges: SelectedCarrierServiceOptionOtherChargeNonNullableFields[];
2852
+ deliveryAllocations: DeliveryAllocationNonNullableFields[];
2853
+ }
2854
+ interface ShippingRegionNonNullableFields {
2855
+ _id: string;
2856
+ name: string;
2857
+ }
2858
+ interface OtherChargeNonNullableFields {
2859
+ type: ChargeType;
2860
+ price?: MultiCurrencyPriceNonNullableFields;
2861
+ }
2862
+ interface ShippingPriceNonNullableFields {
2863
+ price?: MultiCurrencyPriceNonNullableFields;
2864
+ otherCharges: OtherChargeNonNullableFields[];
2865
+ }
2866
+ interface ShippingOptionNonNullableFields {
2867
+ code: string;
2868
+ title: string;
2869
+ logistics?: DeliveryLogisticsNonNullableFields;
2870
+ cost?: ShippingPriceNonNullableFields;
2871
+ deliveryAllocations: DeliveryAllocationNonNullableFields[];
2872
+ }
2873
+ interface CarrierServiceOptionNonNullableFields {
2874
+ carrierId: string;
2875
+ shippingOptions: ShippingOptionNonNullableFields[];
2876
+ }
2877
+ interface ShippingInfoNonNullableFields {
2878
+ shippingDestination?: AddressWithContactNonNullableFields;
2879
+ selectedCarrierServiceOption?: SelectedCarrierServiceOptionNonNullableFields;
2880
+ region?: ShippingRegionNonNullableFields;
2881
+ carrierServiceOptions: CarrierServiceOptionNonNullableFields[];
2882
+ }
2883
+ interface BuyerInfoNonNullableFields {
2884
+ visitorId: string;
2885
+ memberId: string;
2886
+ openAccess: boolean;
2887
+ }
2888
+ interface PriceSummaryNonNullableFields {
2889
+ subtotal?: MultiCurrencyPriceNonNullableFields;
2890
+ shipping?: MultiCurrencyPriceNonNullableFields;
2891
+ tax?: MultiCurrencyPriceNonNullableFields;
2892
+ discount?: MultiCurrencyPriceNonNullableFields;
2893
+ total?: MultiCurrencyPriceNonNullableFields;
2894
+ additionalFees?: MultiCurrencyPriceNonNullableFields;
2895
+ }
2896
+ interface ApplicationErrorNonNullableFields {
2897
+ code: string;
2898
+ description: string;
2899
+ }
2900
+ interface FieldViolationNonNullableFields {
2901
+ field: string;
2902
+ description: string;
2903
+ violatedRule: RuleType;
2904
+ }
2905
+ interface ValidationErrorNonNullableFields {
2906
+ fieldViolations: FieldViolationNonNullableFields[];
2907
+ }
2908
+ interface DetailsNonNullableFields {
2909
+ applicationError?: ApplicationErrorNonNullableFields;
2910
+ validationError?: ValidationErrorNonNullableFields;
2911
+ }
2912
+ interface CarrierErrorNonNullableFields {
2913
+ carrierId: string;
2914
+ error?: DetailsNonNullableFields;
2915
+ }
2916
+ interface CarrierErrorsNonNullableFields {
2917
+ errors: CarrierErrorNonNullableFields[];
2918
+ }
2919
+ interface CalculationErrorsNonNullableFields {
2920
+ generalShippingCalculationError?: DetailsNonNullableFields;
2921
+ carrierErrors?: CarrierErrorsNonNullableFields;
2922
+ taxCalculationError?: DetailsNonNullableFields;
2923
+ couponCalculationError?: DetailsNonNullableFields;
2924
+ giftCardCalculationError?: DetailsNonNullableFields;
2925
+ orderValidationErrors: ApplicationErrorNonNullableFields[];
2926
+ membershipError?: DetailsNonNullableFields;
2927
+ discountsCalculationError?: DetailsNonNullableFields;
2928
+ }
2929
+ interface GiftCardNonNullableFields {
2930
+ _id: string;
2931
+ obfuscatedCode: string;
2932
+ amount?: MultiCurrencyPriceNonNullableFields;
2933
+ appId: string;
2934
+ }
2935
+ interface CouponNonNullableFields {
2936
+ _id: string;
2937
+ code: string;
2938
+ amount?: MultiCurrencyPriceNonNullableFields;
2939
+ name: string;
2940
+ couponType: string;
2941
+ }
2942
+ interface MerchantDiscountNonNullableFields {
2943
+ amount?: MultiCurrencyPriceNonNullableFields;
2944
+ }
2945
+ interface DiscountRuleNameNonNullableFields {
2946
+ original: string;
2947
+ }
2948
+ interface DiscountRuleNonNullableFields {
2949
+ _id: string;
2950
+ name?: DiscountRuleNameNonNullableFields;
2951
+ amount?: MultiCurrencyPriceNonNullableFields;
2952
+ }
2953
+ interface LineItemDiscountNonNullableFields {
2954
+ _id: string;
2955
+ totalDiscountAmount?: MultiCurrencyPriceNonNullableFields;
2956
+ }
2957
+ interface AppliedDiscountNonNullableFields {
2958
+ coupon?: CouponNonNullableFields;
2959
+ merchantDiscount?: MerchantDiscountNonNullableFields;
2960
+ discountRule?: DiscountRuleNonNullableFields;
2961
+ discountType: DiscountType;
2962
+ lineItemIds: string[];
2963
+ lineItemDiscounts: LineItemDiscountNonNullableFields[];
2964
+ }
2965
+ interface CustomFieldNonNullableFields {
2966
+ title: string;
2967
+ }
2968
+ interface AutoTaxFallbackCalculationDetailsNonNullableFields {
2969
+ fallbackReason: FallbackReason;
2970
+ error?: ApplicationErrorNonNullableFields;
2971
+ }
2972
+ interface TaxCalculationDetailsNonNullableFields {
2973
+ manualRateReason: ManualCalculationReason;
2974
+ autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetailsNonNullableFields;
2975
+ rateType: RateType;
2976
+ }
2977
+ interface AggregatedTaxBreakdownNonNullableFields {
2978
+ taxName: string;
2979
+ taxType: string;
2980
+ jurisdiction: string;
2981
+ jurisdictionTypeEnum: JurisdictionType;
2982
+ rate: string;
2983
+ aggregatedTaxAmount?: MultiCurrencyPriceNonNullableFields;
2984
+ aggregatedTaxableAmount?: MultiCurrencyPriceNonNullableFields;
2985
+ }
2986
+ interface TaxSummaryNonNullableFields {
2987
+ taxableAmount?: MultiCurrencyPriceNonNullableFields;
2988
+ totalTax?: MultiCurrencyPriceNonNullableFields;
2989
+ manualTaxRate: string;
2990
+ calculationDetails?: TaxCalculationDetailsNonNullableFields;
2991
+ totalExempt?: MultiCurrencyPriceNonNullableFields;
2992
+ aggregatedTaxBreakdown: AggregatedTaxBreakdownNonNullableFields[];
2993
+ }
2994
+ interface CreatedByNonNullableFields {
2995
+ userId: string;
2996
+ memberId: string;
2997
+ visitorId: string;
2998
+ appId: string;
2999
+ }
3000
+ interface MembershipNameNonNullableFields {
3001
+ original: string;
3002
+ }
3003
+ interface MembershipPaymentCreditsNonNullableFields {
3004
+ total: number;
3005
+ remaining: number;
3006
+ }
3007
+ interface MembershipNonNullableFields {
3008
+ _id: string;
3009
+ appId: string;
3010
+ name?: MembershipNameNonNullableFields;
3011
+ lineItemIds: string[];
3012
+ credits?: MembershipPaymentCreditsNonNullableFields;
3013
+ }
3014
+ interface InvalidMembershipNonNullableFields {
3015
+ membership?: MembershipNonNullableFields;
3016
+ reason: string;
3017
+ }
3018
+ interface SelectedMembershipNonNullableFields {
3019
+ _id: string;
3020
+ appId: string;
3021
+ lineItemIds: string[];
3022
+ }
3023
+ interface SelectedMembershipsNonNullableFields {
3024
+ memberships: SelectedMembershipNonNullableFields[];
3025
+ }
3026
+ interface MembershipOptionsNonNullableFields {
3027
+ eligibleMemberships: MembershipNonNullableFields[];
3028
+ invalidMemberships: InvalidMembershipNonNullableFields[];
3029
+ selectedMemberships?: SelectedMembershipsNonNullableFields;
3030
+ }
3031
+ interface AdditionalFeeNonNullableFields {
3032
+ name: string;
3033
+ price?: MultiCurrencyPriceNonNullableFields;
3034
+ taxDetails?: ItemTaxFullDetailsNonNullableFields;
3035
+ priceBeforeTax?: MultiCurrencyPriceNonNullableFields;
3036
+ priceAfterTax?: MultiCurrencyPriceNonNullableFields;
3037
+ lineItemIds: string[];
3038
+ source: AdditionalFeeSource;
3039
+ }
3040
+ interface ConversionInfoNonNullableFields {
3041
+ siteCurrency: string;
3042
+ conversionRate: string;
3043
+ }
3044
+ interface OtherNonNullableFields {
3045
+ name: NameInOther;
3046
+ }
3047
+ interface TargetLineItemNonNullableFields {
3048
+ name: NameInLineItem;
3049
+ /** @internal */
3050
+ suggestedFix: SuggestedFix;
3051
+ }
3052
+ interface TargetNonNullableFields {
3053
+ other?: OtherNonNullableFields;
3054
+ lineItem?: TargetLineItemNonNullableFields;
3055
+ }
3056
+ interface ViolationNonNullableFields {
3057
+ severity: Severity;
3058
+ target?: TargetNonNullableFields;
3059
+ }
3060
+ interface CustomSettingsNonNullableFields {
3061
+ lockGiftCard: boolean;
3062
+ lockCouponCode: boolean;
3063
+ disabledPolicyAgreementCheckbox: boolean;
3064
+ disabledManualPayment: boolean;
3065
+ }
3066
+ interface CustomContentReferenceNonNullableFields {
3067
+ appId: string;
3068
+ componentId: string;
3069
+ }
3070
+ interface ExternalReferenceNonNullableFields {
3071
+ appId: string;
3072
+ }
3073
+ export interface CheckoutNonNullableFields {
3074
+ lineItems: LineItemNonNullableFields[];
3075
+ billingInfo?: AddressWithContactNonNullableFields;
3076
+ shippingInfo?: ShippingInfoNonNullableFields;
3077
+ buyerInfo?: BuyerInfoNonNullableFields;
3078
+ conversionCurrency: string;
3079
+ priceSummary?: PriceSummaryNonNullableFields;
3080
+ calculationErrors?: CalculationErrorsNonNullableFields;
3081
+ giftCard?: GiftCardNonNullableFields;
3082
+ appliedDiscounts: AppliedDiscountNonNullableFields[];
3083
+ customFields: CustomFieldNonNullableFields[];
3084
+ weightUnit: WeightUnit;
3085
+ taxSummary?: TaxSummaryNonNullableFields;
3086
+ currency: string;
3087
+ channelType: ChannelType;
3088
+ siteLanguage: string;
3089
+ buyerLanguage: string;
3090
+ completed: boolean;
3091
+ taxIncludedInPrice: boolean;
3092
+ createdBy?: CreatedByNonNullableFields;
3093
+ payNow?: PriceSummaryNonNullableFields;
3094
+ payLater?: PriceSummaryNonNullableFields;
3095
+ membershipOptions?: MembershipOptionsNonNullableFields;
3096
+ additionalFees: AdditionalFeeNonNullableFields[];
3097
+ conversionInfo?: ConversionInfoNonNullableFields;
3098
+ payNowTotalAfterGiftCard?: MultiCurrencyPriceNonNullableFields;
3099
+ violations: ViolationNonNullableFields[];
3100
+ totalAfterGiftCard?: MultiCurrencyPriceNonNullableFields;
3101
+ customSettings?: CustomSettingsNonNullableFields;
3102
+ customContentReference?: CustomContentReferenceNonNullableFields;
3103
+ externalReference?: ExternalReferenceNonNullableFields;
3104
+ /** @internal */
3105
+ payAfterFreeTrial?: PriceSummaryNonNullableFields;
3106
+ /** @internal */
3107
+ paymentRequired: boolean;
3108
+ }
3109
+ export interface CreateCheckoutResponseNonNullableFields {
3110
+ checkout?: CheckoutNonNullableFields;
3111
+ }
3112
+ export interface GetCheckoutResponseNonNullableFields {
3113
+ checkout?: CheckoutNonNullableFields;
3114
+ }
3115
+ export interface GetCheckoutByCartIdResponseNonNullableFields {
3116
+ checkout?: CheckoutNonNullableFields;
3117
+ }
3118
+ export interface GetWixCheckoutURLResponseNonNullableFields {
3119
+ checkoutUrl: string;
3120
+ }
3121
+ export interface GetCheckoutURLResponseNonNullableFields {
3122
+ checkoutUrl: string;
3123
+ }
3124
+ export interface UpdateCheckoutResponseNonNullableFields {
3125
+ checkout?: CheckoutNonNullableFields;
3126
+ }
3127
+ export interface RemoveCouponResponseNonNullableFields {
3128
+ checkout?: CheckoutNonNullableFields;
3129
+ }
3130
+ export interface RemoveGiftCardResponseNonNullableFields {
3131
+ checkout?: CheckoutNonNullableFields;
3132
+ }
3133
+ export interface RemoveOverrideCheckoutUrlResponseNonNullableFields {
3134
+ checkout?: CheckoutNonNullableFields;
3135
+ }
3136
+ export interface AddToCheckoutResponseNonNullableFields {
3137
+ checkout?: CheckoutNonNullableFields;
3138
+ }
3139
+ export interface RemoveLineItemsResponseNonNullableFields {
3140
+ checkout?: CheckoutNonNullableFields;
3141
+ }
3142
+ export interface CreateOrderResponseNonNullableFields {
3143
+ orderId: string;
3144
+ subscriptionId: string;
3145
+ }
3146
+ export interface CreateOrderAndChargeResponseNonNullableFields {
3147
+ orderId: string;
3148
+ subscriptionId: string;
3149
+ }
3150
+ export interface UpdateLineItemsQuantityResponseNonNullableFields {
3151
+ checkout?: CheckoutNonNullableFields;
3152
+ }
3153
+ export interface GetCheckoutPaymentSettingsResponseNonNullableFields {
3154
+ blockedPaymentOptions: GetCheckoutPaymentSettingsResponsePaymentOption[];
3155
+ }
3156
+ export interface BaseEventMetadata {
3157
+ /** App instance ID. */
3158
+ instanceId?: string | null;
3159
+ /** Event type. */
3160
+ eventType?: string;
3161
+ /** The identification type and identity data. */
3162
+ identity?: IdentificationData;
3163
+ }
3164
+ export interface EventMetadata extends BaseEventMetadata {
3165
+ /**
3166
+ * Unique event ID.
3167
+ * Allows clients to ignore duplicate webhooks.
3168
+ */
3169
+ _id?: string;
3170
+ /**
3171
+ * Assumes actions are also always typed to an entity_type
3172
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3173
+ */
3174
+ entityFqdn?: string;
3175
+ /**
3176
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3177
+ * This is although the created/updated/deleted notion is duplication of the oneof types
3178
+ * Example: created/updated/deleted/started/completed/email_opened
3179
+ */
3180
+ slug?: string;
3181
+ /** ID of the entity associated with the event. */
3182
+ entityId?: string;
3183
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3184
+ eventTime?: Date | null;
3185
+ /**
3186
+ * Whether the event was triggered as a result of a privacy regulation application
3187
+ * (for example, GDPR).
3188
+ */
3189
+ triggeredByAnonymizeRequest?: boolean | null;
3190
+ /** If present, indicates the action that triggered the event. */
3191
+ originatedFrom?: string | null;
3192
+ /**
3193
+ * A sequence number defining the order of updates to the underlying entity.
3194
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
3195
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3196
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3197
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
3198
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3199
+ */
3200
+ entityEventSequence?: string | null;
3201
+ }
3202
+ export interface CheckoutCompletedEnvelope {
3203
+ data: CheckoutMarkedAsCompleted;
3204
+ metadata: EventMetadata;
3205
+ }
3206
+ /**
3207
+ * Triggered when an order created from this checkout is
3208
+ * successfully paid for or when a checkout is marked as completed.
3209
+ * @permissionScope Manage Stores - all permissions
3210
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3211
+ * @permissionScope Read eCommerce - all read permissions
3212
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3213
+ * @permissionScope Read Orders
3214
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
3215
+ * @permissionScope Read Stores - all read permissions
3216
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3217
+ * @permissionScope Manage Restaurants - all permissions
3218
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3219
+ * @permissionScope Manage eCommerce - all permissions
3220
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3221
+ * @permissionScope Manage Orders
3222
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3223
+ * @permissionId ECOM.READ_CHECKOUTS
3224
+ * @webhook
3225
+ * @eventType wix.ecom.v1.checkout_completed
3226
+ */
3227
+ export declare function onCheckoutCompleted(handler: (event: CheckoutCompletedEnvelope) => void | Promise<void>): void;
3228
+ export interface CheckoutCreatedEnvelope {
3229
+ entity: Checkout;
3230
+ metadata: EventMetadata;
3231
+ }
3232
+ /**
3233
+ * Triggered when a checkout is created.
3234
+ * @permissionScope Manage Stores - all permissions
3235
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3236
+ * @permissionScope Read eCommerce - all read permissions
3237
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3238
+ * @permissionScope Read Orders
3239
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
3240
+ * @permissionScope Read Stores - all read permissions
3241
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3242
+ * @permissionScope Manage Restaurants - all permissions
3243
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3244
+ * @permissionScope Manage eCommerce - all permissions
3245
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3246
+ * @permissionScope Manage Orders
3247
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3248
+ * @permissionId ECOM.READ_CHECKOUTS
3249
+ * @webhook
3250
+ * @eventType wix.ecom.v1.checkout_created
3251
+ */
3252
+ export declare function onCheckoutCreated(handler: (event: CheckoutCreatedEnvelope) => void | Promise<void>): void;
3253
+ export interface CheckoutUpdatedEnvelope {
3254
+ entity: Checkout;
3255
+ metadata: EventMetadata;
3256
+ }
3257
+ /**
3258
+ * Triggered when a checkout is updated.
3259
+ * @permissionScope Manage Stores - all permissions
3260
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3261
+ * @permissionScope Read eCommerce - all read permissions
3262
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3263
+ * @permissionScope Read Orders
3264
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
3265
+ * @permissionScope Read Stores - all read permissions
3266
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3267
+ * @permissionScope Manage Restaurants - all permissions
3268
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3269
+ * @permissionScope Manage eCommerce - all permissions
3270
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3271
+ * @permissionScope Manage Orders
3272
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3273
+ * @permissionId ECOM.READ_CHECKOUTS
3274
+ * @webhook
3275
+ * @eventType wix.ecom.v1.checkout_updated
3276
+ */
3277
+ export declare function onCheckoutUpdated(handler: (event: CheckoutUpdatedEnvelope) => void | Promise<void>): void;
3278
+ /**
3279
+ * Creates a checkout.
3280
+ *
3281
+ *
3282
+ * The `createCheckout()` function returns a Promise that resolves to the new checkout when it's created.
3283
+ *
3284
+ * > **Notes:**
3285
+ * > + Checkout must include at least 1 item in the `options.lineItems` array.
3286
+ * > + `options.channelType` is required.
3287
+ * > + If `_id` for `options.lineItems` is added, make sure that each `_id` is unique.
3288
+ * > + If `options.checkoutInfo.customFields` are added, then `options.checkoutInfo.customFields.value` is required.
3289
+ * @public
3290
+ * @requiredField options.channelType
3291
+ * @requiredField options.checkoutInfo.customFields.value
3292
+ * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships._id
3293
+ * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.appId
3294
+ * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.lineItemIds
3295
+ * @requiredField options.customLineItems.descriptionLines
3296
+ * @requiredField options.customLineItems.descriptionLines.name
3297
+ * @requiredField options.customLineItems.itemType
3298
+ * @requiredField options.customLineItems.price
3299
+ * @requiredField options.customLineItems.productName
3300
+ * @requiredField options.customLineItems.quantity
3301
+ * @requiredField options.lineItems.catalogReference
3302
+ * @requiredField options.lineItems.catalogReference.appId
3303
+ * @requiredField options.lineItems.catalogReference.catalogItemId
3304
+ * @requiredField options.lineItems.quantity
3305
+ * @param options - Checkout creation options.
3306
+ * @permissionId ECOM.MODIFY_CHECKOUTS
3307
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
3308
+ * @permissionScope Manage Stores - all permissions
3309
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3310
+ * @permissionScope Manage Restaurants - all permissions
3311
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3312
+ * @permissionScope Manage eCommerce - all permissions
3313
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3314
+ * @permissionScope Manage Orders
3315
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3316
+ * @permissionScope Manage Stores - all permissions
3317
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3318
+ * @permissionScope Manage eCommerce - Admin Permissions
3319
+ * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
3320
+ * @permissionScope Manage eCommerce - all permissions
3321
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3322
+ * @applicableIdentity APP
3323
+ * @applicableIdentity VISITOR
3324
+ * @returns Fulfilled - the newly created checkout.
3325
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateCheckout
3326
+ */
3327
+ export declare function createCheckout(options?: CreateCheckoutOptions): Promise<Checkout & CheckoutNonNullableFields>;
3328
+ export interface CreateCheckoutOptions {
3329
+ /** Checkout information. */
3330
+ checkoutInfo?: Checkout;
3331
+ /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
3332
+ couponCode?: string | null;
3333
+ /** Catalog line items to add to the checkout. */
3334
+ lineItems?: LineItem[];
3335
+ /**
3336
+ * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
3337
+ *
3338
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3339
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3340
+ */
3341
+ customLineItems?: CustomLineItem[];
3342
+ /**
3343
+ * Sales channel that submitted the order.
3344
+ * + `"UNSPECIFIED"`: Unspecified sales channel. This value is not supported.
3345
+ * + `"WEB"`: A web client.
3346
+ * + `"POS"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)
3347
+ * + `"EBAY"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)
3348
+ * + `"AMAZON"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)
3349
+ * + `"WISH"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)
3350
+ * + `"WIX_INVOICES"`: 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)
3351
+ * + `"WIX_APP_STORE"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)
3352
+ * + `"BACKOFFICE_MERCHANT"`: Wix merchant backoffice
3353
+ * + `"OTHER_PLATFORM"`: Other sales platform.
3354
+ */
3355
+ channelType: ChannelType;
3356
+ /**
3357
+ * Gift card code.
3358
+ *
3359
+ * The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.
3360
+ *
3361
+ * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/wix-stores-setting-up-wix-gift-cards).
3362
+ */
3363
+ giftCardCode?: string | null;
3364
+ /**
3365
+ * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
3366
+ *
3367
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
3368
+ */
3369
+ overrideCheckoutUrl?: string | null;
3370
+ }
3371
+ /**
3372
+ * Retrieves a checkout.
3373
+ *
3374
+ *
3375
+ * The `getCheckout()` function returns a Promise that resolves when the specified checkout is retrieved.
3376
+ * @param _id - Checkout ID.
3377
+ * @public
3378
+ * @requiredField _id
3379
+ * @permissionId ECOM.READ_CHECKOUTS
3380
+ * @permissionScope Manage Stores - all permissions
3381
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3382
+ * @permissionScope Read eCommerce - all read permissions
3383
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3384
+ * @permissionScope Read Orders
3385
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
3386
+ * @permissionScope Read Stores - all read permissions
3387
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3388
+ * @permissionScope Manage Restaurants - all permissions
3389
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3390
+ * @permissionScope Manage eCommerce - all permissions
3391
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3392
+ * @permissionScope Manage Orders
3393
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3394
+ * @applicableIdentity APP
3395
+ * @applicableIdentity VISITOR
3396
+ * @returns Fulfilled - the requested checkout.
3397
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckout
3398
+ */
3399
+ export declare function getCheckout(_id: string): Promise<Checkout & CheckoutNonNullableFields>;
3400
+ /**
3401
+ * Retrieves the checkout associated with a specified cart.
3402
+ * @param _id - Cart ID.
3403
+ * @public
3404
+ * @documentationMaturity preview
3405
+ * @requiredField _id
3406
+ * @permissionId ECOM.READ_CHECKOUTS
3407
+ * @permissionScope Manage Stores - all permissions
3408
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3409
+ * @permissionScope Read eCommerce - all read permissions
3410
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3411
+ * @permissionScope Read Orders
3412
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
3413
+ * @permissionScope Read Stores - all read permissions
3414
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3415
+ * @permissionScope Manage Restaurants - all permissions
3416
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3417
+ * @permissionScope Manage eCommerce - all permissions
3418
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3419
+ * @permissionScope Manage Orders
3420
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3421
+ * @applicableIdentity APP
3422
+ * @applicableIdentity VISITOR
3423
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutByCartId
3424
+ */
3425
+ export declare function getCheckoutByCartId(_id: string): Promise<GetCheckoutByCartIdResponse & GetCheckoutByCartIdResponseNonNullableFields>;
3426
+ /**
3427
+ * Deprecated and will be removed soon, use GetCheckoutURL
3428
+ * @param _id - Checkout ID.
3429
+ * @internal
3430
+ * @documentationMaturity preview
3431
+ * @requiredField _id
3432
+ * @permissionId ECOM.READ_CHECKOUTS
3433
+ * @permissionScope Manage Stores - all permissions
3434
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3435
+ * @permissionScope Read eCommerce - all read permissions
3436
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3437
+ * @permissionScope Read Orders
3438
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
3439
+ * @permissionScope Read Stores - all read permissions
3440
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3441
+ * @permissionScope Manage Restaurants - all permissions
3442
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3443
+ * @permissionScope Manage eCommerce - all permissions
3444
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3445
+ * @permissionScope Manage Orders
3446
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3447
+ * @applicableIdentity APP
3448
+ * @applicableIdentity VISITOR
3449
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetWixCheckoutURL
3450
+ */
3451
+ export declare function getWixCheckoutUrl(_id: string): Promise<GetWixCheckoutURLResponse & GetWixCheckoutURLResponseNonNullableFields>;
3452
+ /**
3453
+ * Retrieves the checkout page URL of a specified checkout.
3454
+ *
3455
+ * By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page.
3456
+ * However, if `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
3457
+ * @param _id - Checkout ID.
3458
+ * @public
3459
+ * @requiredField _id
3460
+ * @permissionId ECOM.READ_CHECKOUTS
3461
+ * @permissionScope Manage Stores - all permissions
3462
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3463
+ * @permissionScope Read eCommerce - all read permissions
3464
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3465
+ * @permissionScope Read Orders
3466
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
3467
+ * @permissionScope Read Stores - all read permissions
3468
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
3469
+ * @permissionScope Manage Restaurants - all permissions
3470
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3471
+ * @permissionScope Manage eCommerce - all permissions
3472
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3473
+ * @permissionScope Manage Orders
3474
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3475
+ * @applicableIdentity APP
3476
+ * @applicableIdentity VISITOR
3477
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutURL
3478
+ */
3479
+ export declare function getCheckoutUrl(_id: string): Promise<GetCheckoutURLResponse & GetCheckoutURLResponseNonNullableFields>;
3480
+ /**
3481
+ * Updates a checkout.
3482
+ *
3483
+ *
3484
+ * The `updateCheckout()` function returns a Promise that resolves to the updated checkout when the specified properties are updated.
3485
+ *
3486
+ * >**Notes:**
3487
+ * > + If nothing is passed in the request, the call will fail.
3488
+ * > + The `checkout.buyerInfo.email` may not be removed once it is set.
3489
+ * @param _id - Checkout ID.
3490
+ * @public
3491
+ * @requiredField _id
3492
+ * @requiredField checkout
3493
+ * @requiredField checkout.customFields.value
3494
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships._id
3495
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships.appId
3496
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships.lineItemIds
3497
+ * @requiredField options.customLineItems.descriptionLines
3498
+ * @requiredField options.customLineItems.descriptionLines.name
3499
+ * @requiredField options.customLineItems.itemType
3500
+ * @requiredField options.customLineItems.productName
3501
+ * @requiredField options.customLineItems.quantity
3502
+ * @requiredField options.lineItems.catalogReference
3503
+ * @requiredField options.lineItems.catalogReference.appId
3504
+ * @requiredField options.lineItems.catalogReference.catalogItemId
3505
+ * @requiredField options.lineItems.quantity
3506
+ * @param options - Checkout update options.
3507
+ * @permissionId ECOM.MODIFY_CHECKOUTS
3508
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
3509
+ * @permissionScope Manage Stores - all permissions
3510
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3511
+ * @permissionScope Manage Restaurants - all permissions
3512
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3513
+ * @permissionScope Manage eCommerce - all permissions
3514
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3515
+ * @permissionScope Manage Orders
3516
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3517
+ * @permissionScope Manage Stores - all permissions
3518
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3519
+ * @permissionScope Manage eCommerce - Admin Permissions
3520
+ * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
3521
+ * @permissionScope Manage eCommerce - all permissions
3522
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3523
+ * @applicableIdentity APP
3524
+ * @applicableIdentity VISITOR
3525
+ * @returns Updated checkout.
3526
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateCheckout
3527
+ */
3528
+ export declare function updateCheckout(_id: string | null, checkout: UpdateCheckout, options?: UpdateCheckoutOptions): Promise<Checkout & CheckoutNonNullableFields>;
3529
+ export interface UpdateCheckout {
3530
+ /**
3531
+ * Checkout ID.
3532
+ * @readonly
3533
+ */
3534
+ _id?: string | null;
3535
+ /**
3536
+ * Line items.
3537
+ *
3538
+ * Max: 300 items
3539
+ * @readonly
3540
+ */
3541
+ lineItems?: LineItem[];
3542
+ /** Billing information. */
3543
+ billingInfo?: AddressWithContact;
3544
+ /** Shipping information. */
3545
+ shippingInfo?: ShippingInfo;
3546
+ /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
3547
+ buyerNote?: string | null;
3548
+ /** Buyer information. */
3549
+ buyerInfo?: BuyerInfo;
3550
+ /**
3551
+ * All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
3552
+ * @readonly
3553
+ */
3554
+ conversionCurrency?: string;
3555
+ /**
3556
+ * Calculated price summary for the checkout.
3557
+ * @readonly
3558
+ */
3559
+ priceSummary?: PriceSummary;
3560
+ /**
3561
+ * Errors when calculating totals.
3562
+ * @readonly
3563
+ */
3564
+ calculationErrors?: CalculationErrors;
3565
+ /**
3566
+ * Applied gift card details.
3567
+ *
3568
+ * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/wix-stores-setting-up-wix-gift-cards).
3569
+ * @readonly
3570
+ */
3571
+ giftCard?: GiftCard;
3572
+ /**
3573
+ * Applied discounts.
3574
+ * @readonly
3575
+ */
3576
+ appliedDiscounts?: AppliedDiscount[];
3577
+ /** Custom fields. */
3578
+ customFields?: CustomField[];
3579
+ /**
3580
+ * Weight measurement unit - defaults to site's weight unit.
3581
+ * @readonly
3582
+ */
3583
+ weightUnit?: WeightUnit;
3584
+ /**
3585
+ * Tax summary.
3586
+ * @readonly
3587
+ */
3588
+ taxSummary?: TaxSummary;
3589
+ /**
3590
+ * The currency used when submitting the order.
3591
+ * @readonly
3592
+ */
3593
+ currency?: string;
3594
+ /**
3595
+ * Sales channel that submitted the order.
3596
+ * @readonly
3597
+ */
3598
+ channelType?: ChannelType;
3599
+ /**
3600
+ * Site language in which original values are shown.
3601
+ * @readonly
3602
+ */
3603
+ siteLanguage?: string;
3604
+ /**
3605
+ * Language for communication with the buyer. Defaults to the site language.
3606
+ * For a site that supports multiple languages, this is the language the buyer selected.
3607
+ * @readonly
3608
+ */
3609
+ buyerLanguage?: string;
3610
+ /**
3611
+ * Whether an order was successfully created from this checkout.
3612
+ * For an order to be successful, it must be successfully paid for (unless the total is 0).
3613
+ * @readonly
3614
+ */
3615
+ completed?: boolean;
3616
+ /**
3617
+ * Whether tax is included in line item prices.
3618
+ * @readonly
3619
+ */
3620
+ taxIncludedInPrice?: boolean;
3621
+ /**
3622
+ * ID of the checkout's initiator.
3623
+ * @readonly
3624
+ */
3625
+ createdBy?: CreatedBy;
3626
+ /**
3627
+ * Date and time the checkout was created.
3628
+ * @readonly
3629
+ */
3630
+ _createdDate?: Date | null;
3631
+ /**
3632
+ * Date and time the checkout was updated.
3633
+ * @readonly
3634
+ */
3635
+ _updatedDate?: Date | null;
3636
+ /**
3637
+ * Minimal amount to pay in order to place the order.
3638
+ * @readonly
3639
+ */
3640
+ payNow?: PriceSummary;
3641
+ /**
3642
+ * Remaining amount for the order to be fully paid.
3643
+ * @readonly
3644
+ */
3645
+ payLater?: PriceSummary;
3646
+ /** Memberships to apply when creating the order. */
3647
+ membershipOptions?: MembershipOptions;
3648
+ /** Additional Fees. */
3649
+ additionalFees?: AdditionalFee[];
3650
+ /** Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart. */
3651
+ cartId?: string | null;
3652
+ /**
3653
+ * List of validation violations raised by the [Validations Custom Extension SPI](https://www.wix.com/velo/reference/spis/wix-ecom/ecom-validations/introduction).
3654
+ * @readonly
3655
+ */
3656
+ violations?: Violation[];
3657
+ /**
3658
+ * Custom field data for the checkout object.
3659
+ *
3660
+ * [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.
3661
+ */
3662
+ extendedFields?: ExtendedFields;
3663
+ /**
3664
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
3665
+ * @readonly
3666
+ */
3667
+ purchaseFlowId?: string | null;
3668
+ /**
3669
+ * Additional settings for customization of the checkout process.
3670
+ *
3671
+ * Custom settings can only be defined when [creating a checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).
3672
+ */
3673
+ customSettings?: CustomSettings;
3674
+ /**
3675
+ * Reference IDs for the app and component providing custom checkout page content.
3676
+ *
3677
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3678
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3679
+ */
3680
+ customContentReference?: CustomContentReference;
3681
+ /**
3682
+ * Order ID.
3683
+ *
3684
+ * This field is empty until the checkout completes and becomes an order.
3685
+ * @internal
3686
+ * @readonly
3687
+ */
3688
+ orderId?: string | null;
3689
+ /**
3690
+ * Payment for subscriptions after free trial period.
3691
+ * @internal
3692
+ * @readonly
3693
+ */
3694
+ payAfterFreeTrial?: PriceSummary;
3695
+ /**
3696
+ * The business location ID associated with the checkout.
3697
+ * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
3698
+ * @internal
3699
+ */
3700
+ businessLocationId?: string | null;
3701
+ /**
3702
+ * Whether payment is required to create an order.
3703
+ *
3704
+ * Payment is required if any of the following conditions are met:
3705
+ * 1. At least one item requires a payment method. This can be because the item has the `savePaymentMethod` field set to `true`, or the item is a subscription with a price greater than zero.
3706
+ * 2. The calculated total amount due for immediate payment is greater than zero - `checkout.payNow > 0`.
3707
+ * @internal
3708
+ * @readonly
3709
+ */
3710
+ paymentRequired?: boolean;
3711
+ }
3712
+ export interface UpdateCheckoutOptions {
3713
+ /** The code of an existing coupon to apply to checkout. For more information, see the [Coupons API](https://www.wix.com/velo/reference/wix-marketing-backend/coupons). */
3714
+ couponCode?: string | null;
3715
+ /** Gift card code. */
3716
+ giftCardCode?: string | null;
3717
+ /**
3718
+ * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
3719
+ *
3720
+ * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
3721
+ */
3722
+ overrideCheckoutUrl?: string | null;
3723
+ /** Catalog line items. */
3724
+ lineItems?: LineItem[];
3725
+ /**
3726
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
3727
+ *
3728
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3729
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3730
+ */
3731
+ customLineItems?: CustomLineItem[];
3732
+ }
3733
+ /**
3734
+ * Removes the coupon from a specified checkout.
3735
+ *
3736
+ *
3737
+ * The `removeCoupon()` function returns a Promise that resolves to the updated checkout when the coupon is removed from the specified checkout.
3738
+ *
3739
+ * >**Note:** A checkout can only hold 1 coupon.
3740
+ * @param _id - ID of the checkout to remove the coupon from.
3741
+ * @public
3742
+ * @requiredField _id
3743
+ * @permissionId ECOM.MODIFY_CHECKOUTS
3744
+ * @permissionScope Manage Stores - all permissions
3745
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3746
+ * @permissionScope Manage Restaurants - all permissions
3747
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3748
+ * @permissionScope Manage eCommerce - all permissions
3749
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3750
+ * @permissionScope Manage Orders
3751
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3752
+ * @applicableIdentity APP
3753
+ * @applicableIdentity VISITOR
3754
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveCoupon
3755
+ */
3756
+ export declare function removeCoupon(_id: string): Promise<RemoveCouponResponse & RemoveCouponResponseNonNullableFields>;
3757
+ /**
3758
+ * Removes the gift card from a specified checkout.
3759
+ *
3760
+ *
3761
+ * The `removeGiftCard()` function returns a Promise that resolves to the updated checkout when the gift card is removed from the specified checkout.
3762
+ *
3763
+ * >**Note:** A checkout can only hold 1 gift card.
3764
+ * @param _id - ID of the checkout to remove the gift card from.
3765
+ * @public
3766
+ * @requiredField _id
3767
+ * @permissionId ECOM.MODIFY_CHECKOUTS
3768
+ * @permissionScope Manage Stores - all permissions
3769
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3770
+ * @permissionScope Manage Restaurants - all permissions
3771
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3772
+ * @permissionScope Manage eCommerce - all permissions
3773
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3774
+ * @permissionScope Manage Orders
3775
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3776
+ * @applicableIdentity APP
3777
+ * @applicableIdentity VISITOR
3778
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveGiftCard
3779
+ */
3780
+ export declare function removeGiftCard(_id: string): Promise<RemoveGiftCardResponse & RemoveGiftCardResponseNonNullableFields>;
3781
+ /**
3782
+ * Removes the `overrideCheckoutUrl` from a specified checkout.
3783
+ *
3784
+ * When `overrideCheckoutUrl` is removed, the `checkoutUrl` will be set to the default, standard
3785
+ * Wix checkout page URL.
3786
+ * @param _id - ID of the checkout to remove the override checkout url from.
3787
+ * @public
3788
+ * @requiredField _id
3789
+ * @permissionId ECOM.MODIFY_CHECKOUTS
3790
+ * @permissionScope Manage Stores - all permissions
3791
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3792
+ * @permissionScope Manage Restaurants - all permissions
3793
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3794
+ * @permissionScope Manage eCommerce - all permissions
3795
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3796
+ * @permissionScope Manage Orders
3797
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3798
+ * @applicableIdentity APP
3799
+ * @applicableIdentity VISITOR
3800
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveOverrideCheckoutUrl
3801
+ */
3802
+ export declare function removeOverrideCheckoutUrl(_id: string): Promise<RemoveOverrideCheckoutUrlResponse & RemoveOverrideCheckoutUrlResponseNonNullableFields>;
3803
+ /**
3804
+ * Adds catalog line items and/or custom line items to a checkout.
3805
+ *
3806
+ *
3807
+ * The `addToCheckout()` function returns a Promise that resolves to the updated checkout when the specified items have been added.
3808
+ * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
3809
+ * @param _id - Checkout ID.
3810
+ * @public
3811
+ * @requiredField _id
3812
+ * @requiredField options.customLineItems.descriptionLines
3813
+ * @requiredField options.customLineItems.descriptionLines.name
3814
+ * @requiredField options.customLineItems.itemType
3815
+ * @requiredField options.customLineItems.productName
3816
+ * @requiredField options.customLineItems.quantity
3817
+ * @requiredField options.lineItems.catalogReference
3818
+ * @requiredField options.lineItems.catalogReference.appId
3819
+ * @requiredField options.lineItems.catalogReference.catalogItemId
3820
+ * @requiredField options.lineItems.quantity
3821
+ * @param options - Items to be added to checkout.
3822
+ * @permissionId ECOM.MODIFY_CHECKOUTS
3823
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
3824
+ * @permissionScope Manage Stores - all permissions
3825
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3826
+ * @permissionScope Manage Restaurants - all permissions
3827
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3828
+ * @permissionScope Manage eCommerce - all permissions
3829
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3830
+ * @permissionScope Manage Orders
3831
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3832
+ * @permissionScope Manage Stores - all permissions
3833
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3834
+ * @permissionScope Manage eCommerce - Admin Permissions
3835
+ * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
3836
+ * @permissionScope Manage eCommerce - all permissions
3837
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3838
+ * @applicableIdentity APP
3839
+ * @applicableIdentity VISITOR
3840
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.AddToCheckout
3841
+ */
3842
+ export declare function addToCheckout(_id: string, options?: AddToCheckoutOptions): Promise<AddToCheckoutResponse & AddToCheckoutResponseNonNullableFields>;
3843
+ export interface AddToCheckoutOptions {
3844
+ /** Catalog line items. */
3845
+ lineItems?: LineItem[];
3846
+ /**
3847
+ * Custom line items. Custom line items don't trigger the Catalog service plugin.
3848
+ *
3849
+ * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
3850
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
3851
+ */
3852
+ customLineItems?: CustomLineItem[];
3853
+ }
3854
+ /**
3855
+ * Removes line items from the specified checkout.
3856
+ *
3857
+ *
3858
+ * The `removeLineItems()` function returns a Promise that resolves to the updated checkout when the line items are removed from the specified checkout.
3859
+ * @param _id - ID of the checkout to remove line items from.
3860
+ * @public
3861
+ * @requiredField _id
3862
+ * @requiredField lineItemIds
3863
+ * @param lineItemIds - IDs of the line items to be removed.
3864
+ * To find the IDs of the checkout line items you'd like to remove, pass the `checkout._id` to [getCheckout()](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and look for the IDs under `lineItems` and/or `customLineItems`.
3865
+ * @permissionId ECOM.MODIFY_CHECKOUTS
3866
+ * @permissionScope Manage Stores - all permissions
3867
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3868
+ * @permissionScope Manage Restaurants - all permissions
3869
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3870
+ * @permissionScope Manage eCommerce - all permissions
3871
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3872
+ * @permissionScope Manage Orders
3873
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3874
+ * @applicableIdentity APP
3875
+ * @applicableIdentity VISITOR
3876
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveLineItems
3877
+ */
3878
+ export declare function removeLineItems(_id: string, lineItemIds: string[]): Promise<RemoveLineItemsResponse & RemoveLineItemsResponseNonNullableFields>;
3879
+ /**
3880
+ * Creates an order from a specified checkout.
3881
+ *
3882
+ * The `createOrder()` function returns a Promise that resolves to the new order's ID and `paymentGatewayOrderID` when the order is created.
3883
+ * Pass the `paymentGatewayOrderId` as the `paymentId` param to the [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function to allow a customer to pay for their order.
3884
+ *
3885
+ * > **Note:** The following requirements must be met for an order to be created from a checkout.
3886
+ * > + A checkout cannot have calculation errors. Pass the `checkout._id` to [Get Checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and take a look at the `calculationErrors` field.
3887
+ * > + A checkout must have at least 1 line item.
3888
+ * > + All of the line Items have an `availability.status` of `"AVAILABLE"` or `"PARTIALLY_AVAILABLE"`.
3889
+ * > + If there is a payment to be made, meaning that `priceSummary.total` is greater than 0, the `billingInfo.address` field must be provided.
3890
+ * > + When a checkout has line items to be shipped, the `shippingInfo.shippingDestination.address` and `shippingInfo.selectedCarrierServiceOption` fields must be provided.
3891
+ * > + When a checkout has line items for pickup, the `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails` field must be provided.
3892
+ * @param _id - Checkout ID.
3893
+ * @public
3894
+ * @requiredField _id
3895
+ * @param options - Further order creation options.
3896
+ * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT
3897
+ * @permissionScope Manage Stores - all permissions
3898
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3899
+ * @permissionScope Manage Restaurants - all permissions
3900
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3901
+ * @permissionScope Manage eCommerce - all permissions
3902
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3903
+ * @permissionScope Manage Orders
3904
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3905
+ * @applicableIdentity APP
3906
+ * @applicableIdentity VISITOR
3907
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateOrder
3908
+ */
3909
+ export declare function createOrder(_id: string, options?: CreateOrderOptions): Promise<CreateOrderResponse & CreateOrderResponseNonNullableFields>;
3910
+ export interface CreateOrderOptions {
3911
+ /** Indicates the payment method should be saved on the order */
3912
+ savePaymentMethod?: boolean;
3913
+ /** Indicates whether to authorize the payment and delay the capture */
3914
+ delayCapture?: boolean;
3915
+ }
3916
+ /**
3917
+ * Deprecated (use createOrder instead)
3918
+ * @param _id - Checkout ID.
3919
+ * @internal
3920
+ * @documentationMaturity preview
3921
+ * @requiredField _id
3922
+ * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT
3923
+ * @permissionScope Manage Stores - all permissions
3924
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3925
+ * @permissionScope Manage Restaurants - all permissions
3926
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3927
+ * @permissionScope Manage eCommerce - all permissions
3928
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3929
+ * @permissionScope Manage Orders
3930
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3931
+ * @applicableIdentity APP
3932
+ * @applicableIdentity VISITOR
3933
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateOrderAndCharge
3934
+ */
3935
+ export declare function createOrderAndCharge(_id: string, options?: CreateOrderAndChargeOptions): Promise<CreateOrderAndChargeResponse & CreateOrderAndChargeResponseNonNullableFields>;
3936
+ export interface CreateOrderAndChargeOptions {
3937
+ /** Payment token. */
3938
+ paymentToken?: string | null;
3939
+ /** Indicates the payment method should be saved on the order */
3940
+ savePaymentMethod?: boolean;
3941
+ /** Indicates whether to authorize the payment and delay the capture */
3942
+ delayCapture?: boolean;
3943
+ }
3944
+ /**
3945
+ * Marks a checkout as completed - `checkout.complete` boolean is set to `true`.
3946
+ *
3947
+ *
3948
+ * The `markCheckoutAsCompleted()` function returns a Promise that resolves when the specified checkout is marked as completed.
3949
+ * @param _id - Checkout ID.
3950
+ * @public
3951
+ * @requiredField _id
3952
+ * @permissionId ECOM.MODIFY_CHECKOUTS
3953
+ * @permissionScope Manage Stores - all permissions
3954
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3955
+ * @permissionScope Manage Restaurants - all permissions
3956
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3957
+ * @permissionScope Manage eCommerce - all permissions
3958
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3959
+ * @permissionScope Manage Orders
3960
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3961
+ * @applicableIdentity APP
3962
+ * @applicableIdentity VISITOR
3963
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.MarkCheckoutAsCompleted
3964
+ */
3965
+ export declare function markCheckoutAsCompleted(_id: string): Promise<void>;
3966
+ /**
3967
+ * Updates the quantity of one or more line items in a checkout.
3968
+ *
3969
+ * This endpoint is only for updating the quantity of line items. To entirely remove a line item from
3970
+ * the checkout, use [`removeLineItems()`](#removelineitems).
3971
+ * To add a new line item to the checkout, use [`addToCheckout()`](#addtocheckout).
3972
+ *
3973
+ * This endpoint checks the amount of stock remaining for this line item. If the specified `quantity`
3974
+ * is greater than the remaining stock, then the `quantity` returned in the response is the total amount
3975
+ * of remaining stock.
3976
+ * @param _id - Checkout ID.
3977
+ * @param lineItems - Line item info to update.
3978
+ * @public
3979
+ * @requiredField _id
3980
+ * @requiredField lineItems
3981
+ * @requiredField lineItems._id
3982
+ * @requiredField lineItems.quantity
3983
+ * @permissionId ECOM.MODIFY_CHECKOUTS
3984
+ * @permissionScope Manage Stores - all permissions
3985
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3986
+ * @permissionScope Manage Restaurants - all permissions
3987
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3988
+ * @permissionScope Manage eCommerce - all permissions
3989
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3990
+ * @permissionScope Manage Orders
3991
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
3992
+ * @applicableIdentity APP
3993
+ * @applicableIdentity VISITOR
3994
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateLineItemsQuantity
3995
+ */
3996
+ export declare function updateLineItemsQuantity(_id: string, lineItems: LineItemQuantityUpdate[]): Promise<UpdateLineItemsQuantityResponse & UpdateLineItemsQuantityResponseNonNullableFields>;
3997
+ /** @param _id - Checkout ID.
3998
+ * @internal
3999
+ * @documentationMaturity preview
4000
+ * @requiredField _id
4001
+ * @permissionId ECOM.READ_PAYMENT_SETTINGS
4002
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutPaymentSettings
4003
+ */
4004
+ export declare function getCheckoutPaymentSettings(_id: string): Promise<GetCheckoutPaymentSettingsResponse & GetCheckoutPaymentSettingsResponseNonNullableFields>;
4005
+ export {};