@wix/auto_sdk_ecom_checkout 1.0.16 → 1.0.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/build/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 +34 -0
  11. package/build/cjs/src/ecom-v1-checkout-checkout.context.js +77 -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 +122 -0
  14. package/build/cjs/src/ecom-v1-checkout-checkout.http.js +1338 -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 +59 -0
  17. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js +351 -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 +358 -0
  21. package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -0
  22. package/build/{ecom-v1-checkout-checkout.universal-C4Y04uL3.d.mts → cjs/src/ecom-v1-checkout-checkout.types.d.ts} +382 -658
  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/{internal/ecom-v1-checkout-checkout.universal-ClmAJ_ss.d.mts → cjs/src/ecom-v1-checkout-checkout.universal.d.ts} +743 -449
  26. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +1559 -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 +34 -0
  39. package/build/es/src/ecom-v1-checkout-checkout.context.js +42 -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 +122 -0
  42. package/build/es/src/ecom-v1-checkout-checkout.http.js +1318 -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 +59 -0
  45. package/build/es/src/ecom-v1-checkout-checkout.meta.js +308 -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 +306 -0
  49. package/build/es/src/ecom-v1-checkout-checkout.public.js.map +1 -0
  50. package/build/{ecom-v1-checkout-checkout.universal-C4Y04uL3.d.ts → es/src/ecom-v1-checkout-checkout.types.d.ts} +382 -658
  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/{internal/ecom-v1-checkout-checkout.universal-ClmAJ_ss.d.ts → es/src/ecom-v1-checkout-checkout.universal.d.ts} +743 -449
  54. package/build/es/src/ecom-v1-checkout-checkout.universal.js +1516 -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 +42 -0
  66. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +77 -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 +122 -0
  69. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +1338 -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 +59 -0
  72. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js +351 -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 +219 -0
  75. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +358 -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 +3406 -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 +4468 -0
  81. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +1559 -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 +42 -0
  93. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +42 -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 +122 -0
  96. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +1318 -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 +59 -0
  99. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js +308 -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 +219 -0
  102. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +306 -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 +3406 -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 +4468 -0
  108. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +1516 -0
  109. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
  110. package/package.json +11 -12
  111. package/build/index.d.mts +0 -211
  112. package/build/index.d.ts +0 -211
  113. package/build/index.js +0 -2781
  114. package/build/index.js.map +0 -1
  115. package/build/index.mjs +0 -2707
  116. package/build/index.mjs.map +0 -1
  117. package/build/internal/index.d.mts +0 -252
  118. package/build/internal/index.d.ts +0 -252
  119. package/build/internal/index.js +0 -2781
  120. package/build/internal/index.js.map +0 -1
  121. package/build/internal/index.mjs +0 -2707
  122. package/build/internal/index.mjs.map +0 -1
  123. package/build/internal/meta.d.mts +0 -2322
  124. package/build/internal/meta.d.ts +0 -2322
  125. package/build/internal/meta.js +0 -1587
  126. package/build/internal/meta.js.map +0 -1
  127. package/build/internal/meta.mjs +0 -1544
  128. package/build/internal/meta.mjs.map +0 -1
  129. package/build/meta.d.mts +0 -2322
  130. package/build/meta.d.ts +0 -2322
  131. package/build/meta.js +0 -1587
  132. package/build/meta.js.map +0 -1
  133. package/build/meta.mjs +0 -1544
  134. package/build/meta.mjs.map +0 -1
@@ -1,2322 +0,0 @@
1
- import { bG as CreateCheckoutRequest$1, bJ as CreateCheckoutResponse$1, bM as GetCheckoutRequest$1, bN as GetCheckoutResponse$1, bQ as GetCheckoutByCartIdRequest$1, G as GetCheckoutByCartIdResponse$1, bR as GetWixCheckoutURLRequest$1, b as GetWixCheckoutURLResponse$1, bS as GetCheckoutURLRequest$1, c as GetCheckoutURLResponse$1, bT as UpdateCheckoutRequest$1, bU as UpdateCheckoutResponse$1, bV as RemoveCouponRequest$1, R as RemoveCouponResponse$1, bW as RemoveGiftCardRequest$1, e as RemoveGiftCardResponse$1, bX as RemoveOverrideCheckoutUrlRequest$1, f as RemoveOverrideCheckoutUrlResponse$1, bY as AddToCheckoutRequest$1, g as AddToCheckoutResponse$1, bZ as RemoveLineItemsRequest$1, h as RemoveLineItemsResponse$1, b_ as CreateOrderRequest$1, j as CreateOrderResponse$1, c5 as CreateOrderAndChargeRequest$1, l as CreateOrderAndChargeResponse$1, c7 as MarkCheckoutAsCompletedAndRedirectToUrlRequest$1, m as RawHttpResponse$1, c9 as MarkCheckoutAsCompletedRequest$1, ca as MarkCheckoutAsCompletedResponse$1, cc as UpdateLineItemsQuantityRequest$1, n as UpdateLineItemsQuantityResponse$1, cd as GetCheckoutPaymentSettingsRequest$1, o as GetCheckoutPaymentSettingsResponse$1 } from './ecom-v1-checkout-checkout.universal-ClmAJ_ss.js';
2
-
3
- interface Checkout {
4
- /**
5
- * Checkout ID.
6
- * @format GUID
7
- * @readonly
8
- */
9
- id?: string | null;
10
- /**
11
- * Line items.
12
- *
13
- * Max: 300 items
14
- * @minSize 1
15
- * @maxSize 300
16
- * @readonly
17
- */
18
- lineItems?: LineItem[];
19
- /** Billing information. */
20
- billingInfo?: AddressWithContact;
21
- /** Shipping information. */
22
- shippingInfo?: ShippingInfo;
23
- /**
24
- * [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
25
- * @maxLength 1000
26
- */
27
- buyerNote?: string | null;
28
- /** Buyer information. */
29
- buyerInfo?: BuyerInfo;
30
- /**
31
- * All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
32
- * @readonly
33
- * @format CURRENCY
34
- */
35
- conversionCurrency?: string;
36
- /**
37
- * Calculated price summary for the checkout.
38
- * @readonly
39
- */
40
- priceSummary?: PriceSummary;
41
- /**
42
- * Errors when calculating totals.
43
- * @readonly
44
- */
45
- calculationErrors?: CalculationErrors;
46
- /**
47
- * Applied gift card details.
48
- *
49
- * >**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/setting-up-wix-gift-cards-9451439).
50
- * @readonly
51
- */
52
- giftCard?: GiftCard;
53
- /**
54
- * Applied discounts.
55
- * @readonly
56
- */
57
- appliedDiscounts?: AppliedDiscount[];
58
- /** Custom fields. */
59
- customFields?: CustomField[];
60
- /**
61
- * Weight measurement unit. Defaults to a site's weight unit.
62
- * @readonly
63
- */
64
- weightUnit?: WeightUnit;
65
- /**
66
- * Tax summary.
67
- * @readonly
68
- */
69
- taxSummary?: TaxSummary;
70
- /**
71
- * The currency used when submitting the order.
72
- * @format CURRENCY
73
- * @readonly
74
- */
75
- currency?: string;
76
- /**
77
- * Sales channel that submitted the order.
78
- * @readonly
79
- */
80
- channelType?: ChannelType;
81
- /**
82
- * Site language in which original values are shown.
83
- * @readonly
84
- */
85
- siteLanguage?: string;
86
- /**
87
- * Language for communication with the buyer. Defaults to the site language.
88
- * For a site that supports multiple languages, this is the language the buyer selected.
89
- * @readonly
90
- */
91
- buyerLanguage?: string;
92
- /**
93
- * Whether an order was successfully created from this checkout.
94
- * For an order to be successful, it must be successfully paid for (unless the total is 0).
95
- * @readonly
96
- */
97
- completed?: boolean;
98
- /**
99
- * Whether tax is included in line item prices.
100
- * @readonly
101
- */
102
- taxIncludedInPrice?: boolean;
103
- /**
104
- * ID of the checkout's initiator.
105
- * @readonly
106
- */
107
- createdBy?: CreatedBy;
108
- /**
109
- * Date and time the checkout was created.
110
- * @readonly
111
- */
112
- createdDate?: Date | null;
113
- /**
114
- * Date and time the checkout was updated.
115
- * @readonly
116
- */
117
- updatedDate?: Date | null;
118
- /**
119
- * Minimal amount to pay in order to place the order.
120
- * @readonly
121
- */
122
- payNow?: PriceSummary;
123
- /**
124
- * Remaining amount for the order to be fully paid.
125
- * @readonly
126
- */
127
- payLater?: PriceSummary;
128
- /** Memberships to apply when creating the order. */
129
- membershipOptions?: MembershipOptions;
130
- /**
131
- * Additional Fees.
132
- * @maxSize 100
133
- */
134
- additionalFees?: AdditionalFee[];
135
- /**
136
- * Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
137
- * @format GUID
138
- */
139
- cartId?: string | null;
140
- /**
141
- * List of validation violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
142
- * @readonly
143
- */
144
- violations?: Violation[];
145
- /**
146
- * Custom field data for the checkout object.
147
- *
148
- * [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.
149
- */
150
- extendedFields?: ExtendedFields;
151
- /**
152
- * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
153
- * @format GUID
154
- * @readonly
155
- */
156
- purchaseFlowId?: string | null;
157
- /**
158
- * Additional settings for customization of the checkout process.
159
- *
160
- * > **Notes:**
161
- * > * Custom settings can only be set when creating a checkout.
162
- * > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
163
- * @immutable
164
- */
165
- customSettings?: CustomSettings;
166
- /**
167
- * Reference IDs for the app and component providing custom checkout page content.
168
- *
169
- * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
170
- * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
171
- */
172
- customContentReference?: CustomContentReference;
173
- /**
174
- * The business location ID associated with the checkout.
175
- *
176
- * To learn more, see the Locations API.
177
- * @format GUID
178
- */
179
- businessLocationId?: string | null;
180
- }
181
- interface LineItem {
182
- /**
183
- * Line item ID.
184
- * @format GUID
185
- * @readonly
186
- */
187
- id?: string | null;
188
- /**
189
- * Item quantity.
190
- *
191
- * Min: `"1"`
192
- * Max: `"100000"`
193
- * @min 1
194
- * @max 100000
195
- */
196
- quantity?: number;
197
- /** 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. */
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?: PageUrlV2;
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 display purposes for the cart, checkout and order.
254
- * @readonly
255
- */
256
- descriptionLines?: DescriptionLine[];
257
- /**
258
- * Line item image details.
259
- * @readonly
260
- */
261
- media?: CommonImage;
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.
284
- *
285
- * Default: `FULL_PAYMENT_ONLINE`
286
- * @readonly
287
- */
288
- paymentOption?: PaymentOptionType;
289
- /**
290
- * Service properties. When relevant, this contains information such as date and number of participants.
291
- * @readonly
292
- */
293
- serviceProperties?: ServiceProperties;
294
- /**
295
- * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
296
- * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
297
- * + In most cases, this field has the same value as `catalogReference.catalogItemId`.
298
- * + Used in membership validation.
299
- * @minLength 1
300
- * @maxLength 36
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
- * Delivery profile ID.
316
- * @format GUID
317
- * @readonly
318
- */
319
- deliveryProfileId?: string | null;
320
- /**
321
- * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
322
- * @readonly
323
- */
324
- customLineItem?: boolean;
325
- /**
326
- * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
327
- * @minLength 1
328
- * @maxLength 2500
329
- * @readonly
330
- */
331
- consentRequiredPaymentPolicy?: string | null;
332
- /**
333
- * Overriding values for catalog item properties.
334
- *
335
- * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
336
- * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
337
- */
338
- catalogOverrideFields?: CatalogOverrideFields;
339
- /**
340
- * Whether to save the payment method on the order.
341
- *
342
- * Default: `false`
343
- * @readonly
344
- */
345
- savePaymentMethod?: boolean;
346
- }
347
- /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
348
- interface CatalogReference {
349
- /**
350
- * ID of the item within the catalog it belongs to.
351
- * @minLength 1
352
- * @maxLength 36
353
- */
354
- catalogItemId?: string;
355
- /**
356
- * ID of the app providing the catalog.
357
- *
358
- * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
359
- *
360
- * For items from Wix catalogs, the following values always apply:
361
- * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
362
- * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
363
- * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
364
- * @minLength 1
365
- */
366
- appId?: string;
367
- /**
368
- * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
369
- *
370
- * For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
371
- */
372
- options?: Record<string, any> | null;
373
- }
374
- interface ProductName {
375
- /**
376
- * __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).
377
- *
378
- * Min: 1 character.
379
- * Max: 200 characters.
380
- * @minLength 1
381
- * @maxLength 200
382
- */
383
- original?: string;
384
- /**
385
- * Item name translated into the buyer's language.
386
- *
387
- * Min: 1 character.
388
- * Max: 400 characters.
389
- * Default: Same as `original`.
390
- * @minLength 1
391
- * @maxLength 400
392
- */
393
- translated?: string | null;
394
- }
395
- interface PageUrlV2 {
396
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
397
- relativePath?: string;
398
- /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
399
- url?: string | null;
400
- }
401
- interface MultiCurrencyPrice {
402
- /**
403
- * Amount.
404
- * @decimalValue options { gte:0, lte:1000000000000000 }
405
- */
406
- amount?: string;
407
- /**
408
- * Converted amount.
409
- * @readonly
410
- * @decimalValue options { gte:0, lte:1000000000000000 }
411
- */
412
- convertedAmount?: string;
413
- /**
414
- * Amount formatted with currency symbol.
415
- * @readonly
416
- */
417
- formattedAmount?: string;
418
- /**
419
- * Converted amount formatted with currency symbol.
420
- * @readonly
421
- */
422
- formattedConvertedAmount?: string;
423
- }
424
- interface ItemTaxFullDetails {
425
- /** Amount for which tax is calculated. */
426
- taxableAmount?: MultiCurrencyPrice;
427
- /**
428
- * Tax rate %, as a decimal point between 0 and 1.
429
- * @decimalValue options { gte:0, lte:1, maxScale:6 }
430
- */
431
- taxRate?: string;
432
- /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
433
- totalTax?: MultiCurrencyPrice;
434
- /**
435
- * If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.
436
- * @readonly
437
- * @deprecated
438
- */
439
- rateBreakdown?: TaxRateBreakdown[];
440
- }
441
- interface TaxRateBreakdown {
442
- /**
443
- * Name of tax against which the calculation was performed.
444
- * @maxLength 100
445
- */
446
- name?: string;
447
- /**
448
- * Rate at which this tax detail was calculated.
449
- * @decimalValue options { gte:0, lte:1, maxScale:6 }
450
- */
451
- rate?: string;
452
- /** Amount of tax for this tax detail. */
453
- tax?: MultiCurrencyPrice;
454
- }
455
- interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
456
- /** Description line plain text value. */
457
- plainText?: PlainTextValue;
458
- /** Description line color value. */
459
- colorInfo?: Color;
460
- /** Description line name. */
461
- name?: DescriptionLineName;
462
- }
463
- /** @oneof */
464
- interface DescriptionLineValueOneOf {
465
- /** Description line plain text value. */
466
- plainText?: PlainTextValue;
467
- /** Description line color value. */
468
- colorInfo?: Color;
469
- }
470
- /** @oneof */
471
- interface DescriptionLineDescriptionLineValueOneOf {
472
- }
473
- interface DescriptionLineName {
474
- /**
475
- * 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).
476
- * @maxLength 100
477
- */
478
- original?: string;
479
- /**
480
- * Description line name translated into the buyer's language.
481
- *
482
- * Default: Same as `original`.
483
- * @maxLength 200
484
- */
485
- translated?: string | null;
486
- }
487
- interface PlainTextValue {
488
- /**
489
- * 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).
490
- * @maxLength 600
491
- */
492
- original?: string;
493
- /**
494
- * Description line plain text value translated into the buyer's language.
495
- *
496
- * Default: Same as `original`.
497
- * @maxLength 600
498
- */
499
- translated?: string | null;
500
- }
501
- interface Color {
502
- /**
503
- * 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).
504
- * @maxLength 500
505
- */
506
- original?: string;
507
- /**
508
- * Description line color name translated into the buyer's language.
509
- *
510
- * Default: Same as `original`.
511
- * @maxLength 500
512
- */
513
- translated?: string | null;
514
- /** HEX or RGB color code for display. */
515
- code?: string | null;
516
- }
517
- interface CommonImage {
518
- /** WixMedia image ID. */
519
- id?: string;
520
- /** Image URL. */
521
- url?: string;
522
- /**
523
- * Original image height.
524
- * @readonly
525
- */
526
- height?: number;
527
- /**
528
- * Original image width.
529
- * @readonly
530
- */
531
- width?: number;
532
- /** Image alt text. */
533
- altText?: string | null;
534
- /**
535
- * Image filename.
536
- * @readonly
537
- */
538
- filename?: string | null;
539
- }
540
- interface ItemAvailabilityInfo {
541
- /** Item availability status. */
542
- status?: ItemAvailabilityStatus;
543
- /** Quantity available. */
544
- quantityAvailable?: number | null;
545
- }
546
- declare enum ItemAvailabilityStatus {
547
- AVAILABLE = "AVAILABLE",
548
- /** Item does not exist. */
549
- NOT_FOUND = "NOT_FOUND",
550
- /** Item is not in stock. */
551
- NOT_AVAILABLE = "NOT_AVAILABLE",
552
- /** Available quantity is less than requested. */
553
- PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
554
- }
555
- interface PhysicalProperties {
556
- /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
557
- weight?: number | null;
558
- /**
559
- * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
560
- * @maxLength 40
561
- */
562
- sku?: string | null;
563
- /** Whether this line item is shippable. */
564
- shippable?: boolean;
565
- }
566
- interface ItemType extends ItemTypeItemTypeDataOneOf {
567
- /** Preset item type. */
568
- preset?: ItemTypeItemType;
569
- /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
570
- custom?: string;
571
- }
572
- /** @oneof */
573
- interface ItemTypeItemTypeDataOneOf {
574
- /** Preset item type. */
575
- preset?: ItemTypeItemType;
576
- /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
577
- custom?: string;
578
- }
579
- declare enum ItemTypeItemType {
580
- UNRECOGNISED = "UNRECOGNISED",
581
- PHYSICAL = "PHYSICAL",
582
- DIGITAL = "DIGITAL",
583
- GIFT_CARD = "GIFT_CARD",
584
- SERVICE = "SERVICE"
585
- }
586
- interface SubscriptionOptionInfo {
587
- /** Subscription option settings. */
588
- subscriptionSettings?: SubscriptionSettings;
589
- /** Subscription option title. */
590
- title?: Title;
591
- /** Subscription option description. */
592
- description?: Description;
593
- }
594
- interface SubscriptionSettings {
595
- /** Frequency of recurring payment. */
596
- frequency?: SubscriptionFrequency;
597
- /**
598
- * Interval of recurring payment.
599
- *
600
- * Default: `1`.
601
- * If SubscriptionFrequency is Day the minimum interval is 7
602
- * @min 1
603
- * @max 50
604
- */
605
- interval?: number | null;
606
- /** Whether subscription is renewed automatically at the end of each period. */
607
- autoRenewal?: boolean;
608
- /**
609
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
610
- * @min 1
611
- */
612
- billingCycles?: number | null;
613
- }
614
- /** Frequency unit of recurring payment */
615
- declare enum SubscriptionFrequency {
616
- UNDEFINED = "UNDEFINED",
617
- DAY = "DAY",
618
- WEEK = "WEEK",
619
- MONTH = "MONTH",
620
- YEAR = "YEAR"
621
- }
622
- interface Title {
623
- /**
624
- * 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).
625
- * @minLength 1
626
- * @maxLength 150
627
- */
628
- original?: string;
629
- /**
630
- * Subscription option name translated into the buyer's language.
631
- *
632
- * Default: Same as `original`.
633
- * @minLength 1
634
- * @maxLength 150
635
- */
636
- translated?: string | null;
637
- }
638
- interface Description {
639
- /**
640
- * Subscription option description.
641
- * @maxLength 500
642
- */
643
- original?: string;
644
- /**
645
- * Translated subscription option description.
646
- * @maxLength 500
647
- */
648
- translated?: string | null;
649
- }
650
- /** Type of selected payment option for catalog item */
651
- declare enum PaymentOptionType {
652
- /** The entire payment for this item happens as part of the checkout. */
653
- FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
654
- /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
655
- FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
656
- /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
657
- MEMBERSHIP = "MEMBERSHIP",
658
- /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
659
- DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
660
- /** 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`. */
661
- MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
662
- }
663
- interface ServiceProperties {
664
- /**
665
- * 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.
666
- * For example, the start time of a class.
667
- */
668
- scheduledDate?: Date | null;
669
- /**
670
- * 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.
671
- * @min 1
672
- * @max 10000
673
- */
674
- numberOfParticipants?: number | null;
675
- }
676
- interface PriceDescription {
677
- /**
678
- * __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).
679
- * @minLength 1
680
- * @maxLength 100
681
- */
682
- original?: string;
683
- /**
684
- * Price description translated into the buyer's language.
685
- *
686
- * Default: Same as `original`.
687
- * @minLength 1
688
- * @maxLength 100
689
- */
690
- translated?: string | null;
691
- }
692
- interface CatalogOverrideFields {
693
- /** Item name. */
694
- productName?: ProductName;
695
- /**
696
- * Item price **after** discounts.
697
- * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
698
- */
699
- price?: string | null;
700
- /**
701
- * Item price **before** discounts.
702
- * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
703
- */
704
- fullPrice?: string | null;
705
- /**
706
- * Item description lines. Used when displaying the line item to customers.
707
- * @maxSize 20
708
- */
709
- descriptionLines?: DescriptionLine[];
710
- /** Physical properties of the item. */
711
- physicalProperties?: PhysicalProperties;
712
- /** Item image. */
713
- image?: Image;
714
- /** Payment method selected for the item. */
715
- paymentOption?: PaymentOption;
716
- /**
717
- * Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
718
- * @format DECIMAL_VALUE
719
- * @decimalValue options { gt:0, lte:999999999, maxScale:3 }
720
- */
721
- depositAmount?: string | null;
722
- /**
723
- * Whether to save the payment method on the order.
724
- *
725
- * Default: `false`
726
- */
727
- savePaymentMethod?: boolean | null;
728
- }
729
- interface Image {
730
- /** WixMedia image ID. */
731
- id?: string;
732
- /** Original image height. */
733
- height?: number;
734
- /** Original image width. */
735
- width?: number;
736
- /** Image alt text. Optional. */
737
- altText?: string | null;
738
- /** Image filename. Optional. */
739
- filename?: string | null;
740
- }
741
- interface PaymentOption {
742
- /**
743
- * Type of selected payment option for current item.
744
- *
745
- * Default: `FULL_PAYMENT_ONLINE`
746
- */
747
- value?: PaymentOptionType;
748
- }
749
- interface ExtendedFields {
750
- /**
751
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
752
- * The value of each key is structured according to the schema defined when the extended fields were configured.
753
- *
754
- * You can only access fields for which you have the appropriate permissions.
755
- *
756
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
757
- */
758
- namespaces?: Record<string, Record<string, any>>;
759
- }
760
- /** Billing Info and shipping details */
761
- interface AddressWithContact {
762
- /** Address. */
763
- address?: ApiAddress;
764
- /** Contact details. */
765
- contactDetails?: FullAddressContactDetails;
766
- }
767
- /** Physical address */
768
- interface ApiAddress {
769
- /**
770
- * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
771
- * @format COUNTRY
772
- */
773
- country?: string | null;
774
- /**
775
- * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
776
- * @maxLength 50
777
- */
778
- subdivision?: string | null;
779
- /**
780
- * City name.
781
- * @maxLength 50
782
- */
783
- city?: string | null;
784
- /**
785
- * Postal or zip code.
786
- * @maxLength 50
787
- */
788
- postalCode?: string | null;
789
- /** Street address. */
790
- streetAddress?: StreetAddress;
791
- /**
792
- * Main address line (usually street name and number).
793
- * @maxLength 150
794
- */
795
- addressLine?: string | null;
796
- /**
797
- * Free text providing more detailed address info. Usually contains apt, suite, floor.
798
- * @maxLength 100
799
- */
800
- addressLine2?: string | null;
801
- /**
802
- * Country's full name.
803
- * @readonly
804
- */
805
- countryFullname?: string | null;
806
- /**
807
- * Subdivision full-name.
808
- * @readonly
809
- */
810
- subdivisionFullname?: string | null;
811
- }
812
- interface StreetAddress {
813
- /** Street number. */
814
- number?: string;
815
- /** Street name. */
816
- name?: string;
817
- }
818
- /** Full contact details for an address */
819
- interface FullAddressContactDetails {
820
- /**
821
- * First name.
822
- * @maxLength 100
823
- */
824
- firstName?: string | null;
825
- /**
826
- * Last name.
827
- * @maxLength 100
828
- */
829
- lastName?: string | null;
830
- /**
831
- * Phone number.
832
- * @format PHONE
833
- */
834
- phone?: string | null;
835
- /**
836
- * Company name.
837
- * @maxLength 1000
838
- */
839
- company?: string | null;
840
- /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
841
- vatId?: CommonVatId;
842
- }
843
- interface CommonVatId {
844
- /** Customer's tax ID. */
845
- id?: string;
846
- /**
847
- * Tax type.
848
- *
849
- * Supported values:
850
- * + `CPF`: for individual tax payers
851
- * + `CNPJ`: for corporations
852
- */
853
- type?: CommonVatType;
854
- }
855
- /** tax info types */
856
- declare enum CommonVatType {
857
- UNSPECIFIED = "UNSPECIFIED",
858
- /** CPF - for individual tax payers. */
859
- CPF = "CPF",
860
- /** CNPJ - for corporations */
861
- CNPJ = "CNPJ"
862
- }
863
- interface ShippingInfo {
864
- /** Shipping address and contact details. */
865
- shippingDestination?: AddressWithContact;
866
- /** Selected option out of the options allowed for the `region`. */
867
- selectedCarrierServiceOption?: SelectedCarrierServiceOption;
868
- /**
869
- * Shipping region. Based on the address provided.
870
- * @readonly
871
- */
872
- region?: ShippingRegion;
873
- /**
874
- * All carrier options for this shipping rule.
875
- * @readonly
876
- */
877
- carrierServiceOptions?: CarrierServiceOption[];
878
- }
879
- interface SelectedCarrierServiceOption {
880
- /**
881
- * Unique identifier of selected option. For example, "usps_std_overnight".
882
- * @maxLength 100
883
- */
884
- code?: string;
885
- /**
886
- * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
887
- * For example, "Standard" or "First-Class Package International".
888
- * @maxLength 250
889
- * @readonly
890
- */
891
- title?: string;
892
- /**
893
- * Delivery logistics.
894
- * @readonly
895
- */
896
- logistics?: DeliveryLogistics;
897
- /**
898
- * Shipping costs.
899
- * @readonly
900
- */
901
- cost?: SelectedCarrierServiceOptionPrices;
902
- /**
903
- * Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)
904
- * @readonly
905
- */
906
- requestedShippingOption?: boolean;
907
- /** Other charges */
908
- otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
909
- /**
910
- * This carrier's unique ID
911
- * @format GUID
912
- */
913
- carrierId?: string | null;
914
- /**
915
- * Delivery solution allocations to different delivery carriers and delivery regions
916
- * @maxSize 300
917
- */
918
- deliveryAllocations?: DeliveryAllocation[];
919
- /** If the delivery solution is a partial and doesn't apply to all items. */
920
- partial?: boolean | null;
921
- }
922
- interface DeliveryLogistics {
923
- /**
924
- * Expected delivery time, in free text. For example, "3-5 business days".
925
- * @maxLength 500
926
- */
927
- deliveryTime?: string | null;
928
- /**
929
- * Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
930
- * @maxLength 1000
931
- */
932
- instructions?: string | null;
933
- /** Pickup details. */
934
- pickupDetails?: PickupDetails;
935
- }
936
- interface PickupDetails {
937
- /** Pickup address. */
938
- address?: ApiAddress;
939
- /**
940
- * Whether the pickup address is that of a business - this may effect tax calculation.
941
- * @deprecated
942
- */
943
- businessLocation?: boolean;
944
- /** Pickup method */
945
- pickupMethod?: PickupMethod;
946
- }
947
- declare enum PickupMethod {
948
- UNKNOWN_METHOD = "UNKNOWN_METHOD",
949
- STORE_PICKUP = "STORE_PICKUP",
950
- PICKUP_POINT = "PICKUP_POINT"
951
- }
952
- interface SelectedCarrierServiceOptionPrices {
953
- /** Total shipping price, after discount and after tax. */
954
- totalPriceAfterTax?: MultiCurrencyPrice;
955
- /** Total price of shipping after discounts (when relevant), and before tax. */
956
- totalPriceBeforeTax?: MultiCurrencyPrice;
957
- /** Tax details. */
958
- taxDetails?: ItemTaxFullDetails;
959
- /** Shipping discount before tax. */
960
- totalDiscount?: MultiCurrencyPrice;
961
- /** Shipping price before discount and before tax. */
962
- price?: MultiCurrencyPrice;
963
- }
964
- interface SelectedCarrierServiceOptionOtherCharge {
965
- /** Type of additional cost. */
966
- type?: ChargeType;
967
- /**
968
- * Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
969
- * @maxLength 200
970
- */
971
- details?: string | null;
972
- /** Price of added charge. */
973
- cost?: SelectedCarrierServiceOptionPrices;
974
- }
975
- declare enum ChargeType {
976
- HANDLING_FEE = "HANDLING_FEE",
977
- INSURANCE = "INSURANCE"
978
- }
979
- interface DeliveryAllocation {
980
- /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
981
- deliveryCarrier?: Carrier;
982
- /** The delivery region that are relevant for this delivery solution. */
983
- deliveryRegion?: Region;
984
- /** Populated if the delivery solution is a partially supplied by this carrier. */
985
- applicableLineItems?: ApplicableLineItems;
986
- }
987
- interface Carrier {
988
- /**
989
- * The carrier app id
990
- * @format GUID
991
- */
992
- appId?: string | null;
993
- /**
994
- * Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
995
- * @maxLength 250
996
- */
997
- code?: string;
998
- }
999
- interface Region {
1000
- /**
1001
- * The delivery region id.
1002
- * @format GUID
1003
- */
1004
- id?: string | null;
1005
- /**
1006
- * The delivery region name.
1007
- * @maxLength 100
1008
- */
1009
- name?: string | null;
1010
- }
1011
- interface ApplicableLineItems {
1012
- /**
1013
- * Line items that the delivery solution is for.
1014
- * @maxSize 300
1015
- * @minLength 1
1016
- * @maxLength 100
1017
- */
1018
- lineItemIds?: string[];
1019
- }
1020
- interface ShippingRegion {
1021
- /**
1022
- * Shipping region ID.
1023
- * @format GUID
1024
- * @readonly
1025
- */
1026
- id?: string;
1027
- /**
1028
- * Shipping region name.
1029
- * @maxLength 100
1030
- */
1031
- name?: string;
1032
- }
1033
- interface CarrierServiceOption {
1034
- /**
1035
- * Carrier ID.
1036
- * @format GUID
1037
- */
1038
- carrierId?: string;
1039
- /** Shipping options offered by this carrier for this request. */
1040
- shippingOptions?: ShippingOption[];
1041
- }
1042
- interface ShippingOption {
1043
- /**
1044
- * Unique code of provided shipping option like "usps_std_overnight".
1045
- * For legacy calculators this would be the UUID of the option.
1046
- * @maxLength 100
1047
- */
1048
- code?: string;
1049
- /**
1050
- * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
1051
- * For example, "Standard" or "First-Class Package International".
1052
- * @maxLength 250
1053
- */
1054
- title?: string;
1055
- /** Delivery logistics. */
1056
- logistics?: DeliveryLogistics;
1057
- /** Sipping price information. */
1058
- cost?: ShippingPrice;
1059
- /**
1060
- * Delivery solution allocations to different delivery carriers and delivery regions
1061
- * @maxSize 300
1062
- */
1063
- deliveryAllocations?: DeliveryAllocation[];
1064
- /** If the delivery solution is a partial and doesn't apply to all items. */
1065
- partial?: boolean | null;
1066
- }
1067
- interface ShippingPrice {
1068
- /** Shipping price. */
1069
- price?: MultiCurrencyPrice;
1070
- /** Other costs such as insurance, handling & packaging for fragile items, etc. */
1071
- otherCharges?: OtherCharge[];
1072
- }
1073
- interface OtherCharge {
1074
- /** Type of additional cost. */
1075
- type?: ChargeType;
1076
- /** Price of added cost. */
1077
- price?: MultiCurrencyPrice;
1078
- }
1079
- interface BuyerInfo extends BuyerInfoIdOneOf {
1080
- /**
1081
- * Visitor ID (if site visitor is **not** a member).
1082
- * @format GUID
1083
- * @readonly
1084
- */
1085
- visitorId?: string;
1086
- /**
1087
- * Member ID (if site visitor is a site member).
1088
- * @format GUID
1089
- * @readonly
1090
- */
1091
- memberId?: string;
1092
- /**
1093
- * Contact ID. Auto-created if one does not yet exist. For more information, see the Contacts API.
1094
- * @format GUID
1095
- * @readonly
1096
- */
1097
- contactId?: string | null;
1098
- /**
1099
- * Buyer email address.
1100
- * @format EMAIL
1101
- */
1102
- email?: string | null;
1103
- }
1104
- /** @oneof */
1105
- interface BuyerInfoIdOneOf {
1106
- /**
1107
- * Visitor ID (if site visitor is **not** a member).
1108
- * @format GUID
1109
- * @readonly
1110
- */
1111
- visitorId?: string;
1112
- /**
1113
- * Member ID (if site visitor is a site member).
1114
- * @format GUID
1115
- * @readonly
1116
- */
1117
- memberId?: string;
1118
- }
1119
- interface PriceSummary {
1120
- /** Subtotal of all line items, before discounts and before tax. */
1121
- subtotal?: MultiCurrencyPrice;
1122
- /** Total shipping price, before discounts and before tax. */
1123
- shipping?: MultiCurrencyPrice;
1124
- /** Total tax. */
1125
- tax?: MultiCurrencyPrice;
1126
- /** Total calculated discount value. */
1127
- discount?: MultiCurrencyPrice;
1128
- /** Total price after discounts, gift cards, and tax. */
1129
- total?: MultiCurrencyPrice;
1130
- /** Total additional fees price before tax. */
1131
- additionalFees?: MultiCurrencyPrice;
1132
- }
1133
- interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1134
- /** General shipping calculation error. */
1135
- generalShippingCalculationError?: Details;
1136
- /** Carrier errors. */
1137
- carrierErrors?: CarrierErrors;
1138
- /** Tax calculation error. */
1139
- taxCalculationError?: Details;
1140
- /** Coupon calculation error. */
1141
- couponCalculationError?: Details;
1142
- /** Gift card calculation error. */
1143
- giftCardCalculationError?: Details;
1144
- /** Order validation errors. */
1145
- orderValidationErrors?: ApplicationError[];
1146
- /**
1147
- * Membership payment methods calculation errors
1148
- * For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid
1149
- */
1150
- membershipError?: Details;
1151
- /** Discount Rule calculation error. */
1152
- discountsCalculationError?: Details;
1153
- }
1154
- /** @oneof */
1155
- interface CalculationErrorsShippingCalculationErrorOneOf {
1156
- /** General shipping calculation error. */
1157
- generalShippingCalculationError?: Details;
1158
- /** Carrier errors. */
1159
- carrierErrors?: CarrierErrors;
1160
- }
1161
- interface Details extends DetailsKindOneOf {
1162
- applicationError?: ApplicationError;
1163
- validationError?: ValidationError;
1164
- systemError?: SystemError;
1165
- /**
1166
- * deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
1167
- * @deprecated
1168
- */
1169
- tracing?: Record<string, string>;
1170
- }
1171
- /** @oneof */
1172
- interface DetailsKindOneOf {
1173
- applicationError?: ApplicationError;
1174
- validationError?: ValidationError;
1175
- systemError?: SystemError;
1176
- }
1177
- interface ApplicationError {
1178
- /** Error code. */
1179
- code?: string;
1180
- /** Description of the error. */
1181
- description?: string;
1182
- /** Data related to the error. */
1183
- data?: Record<string, any> | null;
1184
- }
1185
- /**
1186
- * example result:
1187
- * {
1188
- * "fieldViolations": [
1189
- * {
1190
- * "field": "fieldA",
1191
- * "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
1192
- * "violatedRule": "OTHER",
1193
- * "ruleName": "INVALID_NOTE",
1194
- * "data": {
1195
- * "value": "FI"
1196
- * }
1197
- * },
1198
- * {
1199
- * "field": "fieldB",
1200
- * "description": "field value out of range. supported range: [0-20]",
1201
- * "violatedRule": "MAX",
1202
- * "data": {
1203
- * "threshold": 20
1204
- * }
1205
- * },
1206
- * {
1207
- * "field": "fieldC",
1208
- * "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
1209
- * "violatedRule": "FORMAT",
1210
- * "data": {
1211
- * "type": "PHONE"
1212
- * }
1213
- * }
1214
- * ]
1215
- * }
1216
- */
1217
- interface ValidationError {
1218
- fieldViolations?: FieldViolation[];
1219
- }
1220
- declare enum RuleType {
1221
- VALIDATION = "VALIDATION",
1222
- OTHER = "OTHER",
1223
- MAX = "MAX",
1224
- MIN = "MIN",
1225
- MAX_LENGTH = "MAX_LENGTH",
1226
- MIN_LENGTH = "MIN_LENGTH",
1227
- MAX_SIZE = "MAX_SIZE",
1228
- MIN_SIZE = "MIN_SIZE",
1229
- FORMAT = "FORMAT",
1230
- DECIMAL_LTE = "DECIMAL_LTE",
1231
- DECIMAL_GTE = "DECIMAL_GTE",
1232
- DECIMAL_LT = "DECIMAL_LT",
1233
- DECIMAL_GT = "DECIMAL_GT",
1234
- DECIMAL_MAX_SCALE = "DECIMAL_MAX_SCALE",
1235
- INVALID_ENUM_VALUE = "INVALID_ENUM_VALUE",
1236
- REQUIRED_FIELD = "REQUIRED_FIELD",
1237
- FIELD_NOT_ALLOWED = "FIELD_NOT_ALLOWED",
1238
- ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT",
1239
- EXACT_LENGTH = "EXACT_LENGTH",
1240
- EXACT_SIZE = "EXACT_SIZE",
1241
- REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1242
- }
1243
- interface FieldViolation {
1244
- field?: string;
1245
- description?: string;
1246
- violatedRule?: RuleType;
1247
- /** applicable when violated_rule=OTHER */
1248
- ruleName?: string | null;
1249
- data?: Record<string, any> | null;
1250
- }
1251
- interface SystemError {
1252
- /** Error code. */
1253
- errorCode?: string | null;
1254
- }
1255
- interface CarrierErrors {
1256
- /** Carrier errors. */
1257
- errors?: CarrierError[];
1258
- }
1259
- interface CarrierError {
1260
- /** Carrier ID. */
1261
- carrierId?: string;
1262
- /** Error details. */
1263
- error?: Details;
1264
- }
1265
- interface GiftCard {
1266
- /**
1267
- * Gift Card ID.
1268
- * @deprecated
1269
- */
1270
- id?: string;
1271
- /** Gift card obfuscated code. */
1272
- obfuscatedCode?: string;
1273
- /** Gift card value. */
1274
- amount?: MultiCurrencyPrice;
1275
- /**
1276
- * App ID of the gift card provider.
1277
- * @format GUID
1278
- */
1279
- appId?: string;
1280
- /**
1281
- * External ID in the gift card provider's system.
1282
- * Used for integration and tracking across different platforms.
1283
- * @minLength 1
1284
- * @maxLength 50
1285
- */
1286
- externalId?: string | null;
1287
- }
1288
- interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1289
- /** Coupon details. */
1290
- coupon?: Coupon;
1291
- /** Merchant discount. */
1292
- merchantDiscount?: MerchantDiscount;
1293
- /** Discount rule */
1294
- discountRule?: DiscountRule;
1295
- /** Discount type. */
1296
- discountType?: DiscountType;
1297
- /**
1298
- * IDs of line items the discount applies to.
1299
- * @format GUID
1300
- * @deprecated IDs of line items the discount applies to.
1301
- * @replacedBy line_items_discounts
1302
- * @targetRemovalDate 2024-06-01
1303
- */
1304
- lineItemIds?: string[];
1305
- }
1306
- /** @oneof */
1307
- interface AppliedDiscountDiscountSourceOneOf {
1308
- /** Coupon details. */
1309
- coupon?: Coupon;
1310
- /** Merchant discount. */
1311
- merchantDiscount?: MerchantDiscount;
1312
- /** Discount rule */
1313
- discountRule?: DiscountRule;
1314
- }
1315
- declare enum DiscountType {
1316
- GLOBAL = "GLOBAL",
1317
- SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1318
- SHIPPING = "SHIPPING"
1319
- }
1320
- /** Coupon */
1321
- interface Coupon {
1322
- /** Coupon ID. */
1323
- id?: string;
1324
- /** Coupon code. */
1325
- code?: string;
1326
- /** Coupon value. */
1327
- amount?: MultiCurrencyPrice;
1328
- /** Coupon name. */
1329
- name?: string;
1330
- }
1331
- interface MerchantDiscount {
1332
- /** Discount value. */
1333
- amount?: MultiCurrencyPrice;
1334
- /**
1335
- * Discount Percentage. Will be calculated from items price before other discounts.
1336
- * @min 1
1337
- * @max 100
1338
- */
1339
- percentage?: number | null;
1340
- }
1341
- interface DiscountRule {
1342
- /**
1343
- * Discount rule ID
1344
- * @format GUID
1345
- */
1346
- id?: string;
1347
- /** Discount rule name */
1348
- name?: DiscountRuleName;
1349
- /** Discount value. */
1350
- amount?: MultiCurrencyPrice;
1351
- }
1352
- interface DiscountRuleName {
1353
- /**
1354
- * Original discount rule name (in site's default language).
1355
- * @minLength 1
1356
- * @maxLength 256
1357
- */
1358
- original?: string;
1359
- /**
1360
- * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
1361
- * @minLength 1
1362
- * @maxLength 500
1363
- */
1364
- translated?: string | null;
1365
- }
1366
- interface CustomField {
1367
- /** Custom field value. */
1368
- value?: any;
1369
- /**
1370
- * Custom field title.
1371
- * @minLength 1
1372
- * @maxLength 500
1373
- */
1374
- title?: string;
1375
- /**
1376
- * Translated custom field title.
1377
- * @minLength 1
1378
- * @maxLength 500
1379
- */
1380
- translatedTitle?: string | null;
1381
- }
1382
- declare enum WeightUnit {
1383
- /** Weight unit can't be classified due to an error. */
1384
- UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
1385
- /** Kilograms. */
1386
- KG = "KG",
1387
- /** Pounds. */
1388
- LB = "LB"
1389
- }
1390
- interface TaxSummary {
1391
- /**
1392
- * Amount for which tax is calculated, added from line items.
1393
- * @readonly
1394
- */
1395
- taxableAmount?: MultiCurrencyPrice;
1396
- /**
1397
- * Calculated tax, added from line items.
1398
- * @readonly
1399
- */
1400
- totalTax?: MultiCurrencyPrice;
1401
- /**
1402
- * Tax calculator that was active when the order was created.
1403
- * @deprecated
1404
- */
1405
- calculationDetails?: TaxCalculationDetails;
1406
- }
1407
- interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
1408
- /** Reason the manual calculation was used. */
1409
- manualRateReason?: ManualCalculationReason;
1410
- /** Details of the fallback rate calculation. */
1411
- autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
1412
- /** Rate calculation type. */
1413
- rateType?: RateType;
1414
- }
1415
- /** @oneof */
1416
- interface TaxCalculationDetailsCalculationDetailsOneOf {
1417
- /** Reason the manual calculation was used. */
1418
- manualRateReason?: ManualCalculationReason;
1419
- /** Details of the fallback rate calculation. */
1420
- autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
1421
- }
1422
- declare enum RateType {
1423
- /** no tax being collected for this request due to location of purchase */
1424
- NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
1425
- /** manual rate used for calculation */
1426
- MANUAL_RATE = "MANUAL_RATE",
1427
- /** autotax rate used for calculation */
1428
- AUTO_RATE = "AUTO_RATE",
1429
- /** fallback rate used for calculation */
1430
- FALLBACK_RATE = "FALLBACK_RATE"
1431
- }
1432
- declare enum ManualCalculationReason {
1433
- /** user set calculator in Business Manager to be Manual */
1434
- GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
1435
- /** specific region is on manual even though Global setting is Auto-tax */
1436
- REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
1437
- }
1438
- interface AutoTaxFallbackCalculationDetails {
1439
- /** reason for fallback */
1440
- fallbackReason?: FallbackReason;
1441
- /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
1442
- error?: ApplicationError;
1443
- }
1444
- declare enum FallbackReason {
1445
- /** auto-tax failed to be calculated */
1446
- AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
1447
- /** auto-tax was temporarily deactivated on a system-level */
1448
- AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
1449
- }
1450
- declare enum ChannelType {
1451
- /** Unspecified sales channel. This value is not supported. */
1452
- UNSPECIFIED = "UNSPECIFIED",
1453
- /** A web client. */
1454
- WEB = "WEB",
1455
- /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */
1456
- POS = "POS",
1457
- /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */
1458
- EBAY = "EBAY",
1459
- /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */
1460
- AMAZON = "AMAZON",
1461
- /** Other sales platform. */
1462
- OTHER_PLATFORM = "OTHER_PLATFORM",
1463
- /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */
1464
- WIX_APP_STORE = "WIX_APP_STORE",
1465
- /** 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) */
1466
- WIX_INVOICES = "WIX_INVOICES",
1467
- /** Wix merchant backoffice. */
1468
- BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
1469
- /** Wish sales channel. */
1470
- WISH = "WISH",
1471
- /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */
1472
- CLASS_PASS = "CLASS_PASS",
1473
- /** Global-E sales channel. */
1474
- GLOBAL_E = "GLOBAL_E",
1475
- /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */
1476
- FACEBOOK = "FACEBOOK",
1477
- /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */
1478
- ETSY = "ETSY",
1479
- /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */
1480
- TIKTOK = "TIKTOK",
1481
- /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
1482
- FAIRE_COM = "FAIRE_COM"
1483
- }
1484
- interface CreatedBy extends CreatedByIdOneOf {
1485
- /**
1486
- * User ID. When the order was created by a Wix user on behalf of a buyer.
1487
- * For example, via POS (point of service).
1488
- * @format GUID
1489
- */
1490
- userId?: string;
1491
- /**
1492
- * Member ID. When the order was created by a **logged in** site visitor.
1493
- * @format GUID
1494
- */
1495
- memberId?: string;
1496
- /**
1497
- * Visitor ID. When the order was created by a site visitor that was **not** logged in.
1498
- * @format GUID
1499
- */
1500
- visitorId?: string;
1501
- /**
1502
- * App ID. When the order was created by an external application or Wix service.
1503
- * @format GUID
1504
- */
1505
- appId?: string;
1506
- }
1507
- /** @oneof */
1508
- interface CreatedByIdOneOf {
1509
- /**
1510
- * User ID. When the order was created by a Wix user on behalf of a buyer.
1511
- * For example, via POS (point of service).
1512
- * @format GUID
1513
- */
1514
- userId?: string;
1515
- /**
1516
- * Member ID. When the order was created by a **logged in** site visitor.
1517
- * @format GUID
1518
- */
1519
- memberId?: string;
1520
- /**
1521
- * Visitor ID. When the order was created by a site visitor that was **not** logged in.
1522
- * @format GUID
1523
- */
1524
- visitorId?: string;
1525
- /**
1526
- * App ID. When the order was created by an external application or Wix service.
1527
- * @format GUID
1528
- */
1529
- appId?: string;
1530
- }
1531
- /** Reserved for internal use. */
1532
- interface MembershipOptions {
1533
- /**
1534
- * Reserved for internal use.
1535
- * @readonly
1536
- * @maxSize 300
1537
- */
1538
- eligibleMemberships?: Membership[];
1539
- /**
1540
- * Reserved for internal use.
1541
- * @readonly
1542
- * @maxSize 300
1543
- */
1544
- invalidMemberships?: InvalidMembership[];
1545
- /** Selected membership to apply to this checkout. */
1546
- selectedMemberships?: SelectedMemberships;
1547
- }
1548
- interface Membership {
1549
- /**
1550
- * Membership ID.
1551
- * @minLength 1
1552
- * @maxLength 100
1553
- */
1554
- id?: string;
1555
- /**
1556
- * ID of the application providing this payment option.
1557
- * @format GUID
1558
- */
1559
- appId?: string;
1560
- /** The name of this membership. */
1561
- name?: MembershipName;
1562
- /**
1563
- * Line item IDs which are "paid" for by this membership.
1564
- * @minSize 1
1565
- * @maxSize 300
1566
- * @minLength 1
1567
- * @maxLength 100
1568
- */
1569
- lineItemIds?: string[];
1570
- /** Optional - For a membership that has limited credits, information about credit usage. */
1571
- credits?: MembershipPaymentCredits;
1572
- /** Optional - TMembership expiry date. */
1573
- expirationDate?: Date | null;
1574
- /** Additional data about this membership. */
1575
- additionalData?: Record<string, any> | null;
1576
- }
1577
- interface MembershipName {
1578
- /**
1579
- * Membership name.
1580
- * @maxLength 100
1581
- */
1582
- original?: string;
1583
- /**
1584
- * Translated membership name. Defaults to `original` when not provided.
1585
- * @maxLength 100
1586
- */
1587
- translated?: string | null;
1588
- }
1589
- interface MembershipPaymentCredits {
1590
- /**
1591
- * Membership's total amount of credits.
1592
- * @min 1
1593
- */
1594
- total?: number;
1595
- /** Membership's remaining amount of credits. */
1596
- remaining?: number;
1597
- }
1598
- interface InvalidMembership {
1599
- /** Membership details. */
1600
- membership?: Membership;
1601
- /**
1602
- * Reason why this membership is invalid and cannot be used.
1603
- * @minLength 1
1604
- * @maxLength 100
1605
- */
1606
- reason?: string;
1607
- }
1608
- interface SelectedMemberships {
1609
- /**
1610
- * Selected memberships.
1611
- * @maxSize 300
1612
- */
1613
- memberships?: SelectedMembership[];
1614
- }
1615
- interface SelectedMembership {
1616
- /**
1617
- * Membership ID.
1618
- * @minLength 1
1619
- * @maxLength 100
1620
- */
1621
- id?: string;
1622
- /**
1623
- * ID of the app providing this payment option.
1624
- * @format GUID
1625
- */
1626
- appId?: string;
1627
- /**
1628
- * IDs of the line items this membership applies to.
1629
- * @minSize 1
1630
- * @maxSize 300
1631
- * @minLength 1
1632
- * @maxLength 100
1633
- */
1634
- lineItemIds?: string[];
1635
- }
1636
- interface AdditionalFee {
1637
- /**
1638
- * Additional fee's unique code (or ID) for future processing.
1639
- * @minLength 1
1640
- * @maxLength 100
1641
- */
1642
- code?: string | null;
1643
- /**
1644
- * Translated additional fee's name.
1645
- * @minLength 1
1646
- * @maxLength 50
1647
- */
1648
- name?: string;
1649
- /** Additional fee's price. */
1650
- price?: MultiCurrencyPrice;
1651
- /** Tax details. */
1652
- taxDetails?: ItemTaxFullDetails;
1653
- /**
1654
- * Provider's app id.
1655
- * @minLength 1
1656
- * @maxLength 100
1657
- */
1658
- providerAppId?: string | null;
1659
- /** Additional fee's price before tax. */
1660
- priceBeforeTax?: MultiCurrencyPrice;
1661
- /** Additional fee's price after tax. */
1662
- priceAfterTax?: MultiCurrencyPrice;
1663
- /**
1664
- * Optional - Line items associated with this additional fee.
1665
- * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
1666
- * @format GUID
1667
- */
1668
- lineItemIds?: string[];
1669
- /** the source the additional fee was added from */
1670
- source?: AdditionalFeeSource;
1671
- }
1672
- declare enum AdditionalFeeSource {
1673
- UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
1674
- /** The additional fee was added by an additional fee service plugin */
1675
- SERVICE_PLUGIN = "SERVICE_PLUGIN",
1676
- /** The additional fee was added on the item either via the catalog or on custom line item */
1677
- ITEM = "ITEM",
1678
- /** The additional fee was added manually on the request */
1679
- MANUAL = "MANUAL"
1680
- }
1681
- interface Violation {
1682
- /** 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. */
1683
- severity?: Severity;
1684
- /** Target location on a checkout or cart page where the violation will be displayed. */
1685
- target?: Target;
1686
- /**
1687
- * 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>`.
1688
- * @minLength 1
1689
- * @maxLength 1000
1690
- */
1691
- description?: string | null;
1692
- }
1693
- declare enum Severity {
1694
- /** The user is allowed to move forward in the flow. */
1695
- WARNING = "WARNING",
1696
- /**
1697
- * The user is blocked from moving forward in the flow.
1698
- * For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.
1699
- */
1700
- ERROR = "ERROR"
1701
- }
1702
- interface Target extends TargetTargetTypeOneOf {
1703
- /** General (other) violation. */
1704
- other?: Other;
1705
- /** Specific line item violation. */
1706
- lineItem?: TargetLineItem;
1707
- }
1708
- /** @oneof */
1709
- interface TargetTargetTypeOneOf {
1710
- /** General (other) violation. */
1711
- other?: Other;
1712
- /** Specific line item violation. */
1713
- lineItem?: TargetLineItem;
1714
- }
1715
- /** Available locations on the webpage */
1716
- declare enum NameInOther {
1717
- /** Default location, in case no specific location is specified. */
1718
- OTHER_DEFAULT = "OTHER_DEFAULT"
1719
- }
1720
- /** Available locations on the line item */
1721
- declare enum NameInLineItem {
1722
- /** Default location, in case no specific location is specified. */
1723
- LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
1724
- }
1725
- /** General (other) violation. */
1726
- interface Other {
1727
- /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
1728
- name?: NameInOther;
1729
- }
1730
- /** Specific line item violation. */
1731
- interface TargetLineItem {
1732
- /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
1733
- name?: NameInLineItem;
1734
- /** ID of the line item containing the violation. */
1735
- id?: string | null;
1736
- }
1737
- interface CustomSettings {
1738
- /**
1739
- * Whether to restrict the option to add or remove a gift card on the checkout page.
1740
- *
1741
- * Default: `false`
1742
- */
1743
- lockGiftCard?: boolean;
1744
- /**
1745
- * Whether to restrict the option to add or remove a coupon code on the checkout page.
1746
- *
1747
- * Default: `false`
1748
- */
1749
- lockCouponCode?: boolean;
1750
- /**
1751
- * Whether to disable policy agreement checkout in the checkout page
1752
- *
1753
- * Default: `false`
1754
- */
1755
- disabledPolicyAgreementCheckbox?: boolean;
1756
- /**
1757
- * Whether to disable manual payment option for this checkout.
1758
- *
1759
- * Default: `false`
1760
- */
1761
- disabledManualPayment?: boolean;
1762
- }
1763
- interface CustomContentReference {
1764
- /**
1765
- * ID of the app providing the content.
1766
- *
1767
- * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
1768
- * @format GUID
1769
- */
1770
- appId?: string;
1771
- /**
1772
- * ID of the component within the app it belongs to.
1773
- *
1774
- * You can get your component's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
1775
- * @format GUID
1776
- */
1777
- componentId?: string;
1778
- }
1779
- interface CreateCheckoutRequest {
1780
- /** Checkout information. */
1781
- checkoutInfo?: Checkout;
1782
- /** Coupon code. */
1783
- couponCode?: string | null;
1784
- /**
1785
- * Catalog line items to add to the checkout.
1786
- * @maxSize 300
1787
- */
1788
- lineItems?: LineItem[];
1789
- /**
1790
- * Custom line items to add to the checkout. Custom line items don't trigger the Catalog service plugin.
1791
- *
1792
- * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1793
- * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
1794
- * @maxSize 300
1795
- */
1796
- customLineItems?: CustomLineItem[];
1797
- /** Sales channel that submitted the order. */
1798
- channelType: ChannelType;
1799
- /**
1800
- * Gift card code.
1801
- *
1802
- * The checkout can only hold 1 `giftCardCode` at a time. If an additional `giftCardCode` is added, it will override the existing `giftCardCode`.
1803
- *
1804
- * >**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/setting-up-wix-gift-cards-9451439).
1805
- */
1806
- giftCardCode?: string | null;
1807
- /**
1808
- * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
1809
- *
1810
- * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
1811
- * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
1812
- * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
1813
- * @maxLength 1000
1814
- */
1815
- overrideCheckoutUrl?: string | null;
1816
- }
1817
- interface CustomLineItem {
1818
- /**
1819
- * Custom line item quantity.
1820
- *
1821
- * Min: `1`
1822
- * Max: `100000`
1823
- * @min 1
1824
- * @max 100000
1825
- */
1826
- quantity?: number;
1827
- /**
1828
- * Custom line item price.
1829
- *
1830
- * Must be a number or a decimal without symbols.
1831
- * @format DECIMAL_VALUE
1832
- * @decimalValue options { gte:0, lte:1000000000000000 }
1833
- */
1834
- price?: string;
1835
- /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
1836
- priceDescription?: PriceDescription;
1837
- /**
1838
- * Custom line item description lines. Used for display purposes for the cart, checkout and order.
1839
- * @maxSize 10
1840
- */
1841
- descriptionLines?: DescriptionLine[];
1842
- /** Custom line item's media. */
1843
- media?: Image;
1844
- /**
1845
- * Custom line item ID. If passed, `id` must be unique.
1846
- *
1847
- * Default: auto-generated ID
1848
- * @format GUID
1849
- */
1850
- id?: string | null;
1851
- /**
1852
- * Tax group ID for this custom line item.
1853
- * @format GUID
1854
- */
1855
- taxGroupId?: string | null;
1856
- /** Name of the item or product. */
1857
- productName?: ProductName;
1858
- /** 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. */
1859
- url?: PageUrlV2;
1860
- /** Item type. Either a preset type or custom. */
1861
- itemType?: ItemType;
1862
- /**
1863
- * Item price **before** catalog-defined discount. Defaults to `price` when not provided.
1864
- * @format DECIMAL_VALUE
1865
- */
1866
- fullPrice?: string | null;
1867
- /**
1868
- * Item quantity available for purchase. Only return this if inventory is managed.
1869
- * Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
1870
- * @max 100000
1871
- */
1872
- quantityAvailable?: number | null;
1873
- /** Physical properties of the item. */
1874
- physicalProperties?: PhysicalProperties;
1875
- /**
1876
- * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
1877
- *
1878
- * + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.
1879
- * + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
1880
- * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
1881
- * + `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.
1882
- */
1883
- paymentOption?: PaymentOptionType;
1884
- /**
1885
- * Service properties. When relevant, this contains information such as date and number of participants.
1886
- * Used, among other things, when checking for valid memberships.
1887
- */
1888
- serviceProperties?: ServiceProperties;
1889
- /**
1890
- * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
1891
- *
1892
- * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
1893
- * + In most cases, this field is the same as `catalogReference.catalogItemId`.
1894
- * + Used in membership validation.
1895
- * @minLength 1
1896
- * @maxLength 36
1897
- */
1898
- rootCatalogItemId?: string | null;
1899
- /**
1900
- * Partial payment for the given item to be paid upfront during the checkout.
1901
- *
1902
- * Eligible for catalog items with type `DEPOSIT_ONLINE`.
1903
- * When omitted, the item's price will not be split and is expected to be paid in a single installment.
1904
- * @format DECIMAL_VALUE
1905
- */
1906
- depositAmount?: string | null;
1907
- /**
1908
- * Delivery profile ID.
1909
- * @format GUID
1910
- */
1911
- deliveryProfileId?: string | null;
1912
- /** 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. */
1913
- catalogReference?: CatalogReference;
1914
- /**
1915
- * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
1916
- * @minLength 1
1917
- * @maxLength 1000
1918
- * @readonly
1919
- */
1920
- consentRequiredPaymentPolicy?: string | null;
1921
- /**
1922
- * Whether to save the payment method on the order.
1923
- *
1924
- * Default: `false`
1925
- * @readonly
1926
- */
1927
- savePaymentMethod?: boolean;
1928
- }
1929
- interface CreateCheckoutResponse {
1930
- /** Newly created checkout. */
1931
- checkout?: Checkout;
1932
- }
1933
- interface GetCheckoutRequest {
1934
- /**
1935
- * Checkout ID.
1936
- * @format GUID
1937
- */
1938
- id: string;
1939
- }
1940
- interface GetCheckoutResponse {
1941
- /** Retrieved checkout. */
1942
- checkout?: Checkout;
1943
- }
1944
- interface GetCheckoutByCartIdRequest {
1945
- /**
1946
- * Cart ID.
1947
- * @format GUID
1948
- */
1949
- id: string;
1950
- }
1951
- interface GetCheckoutByCartIdResponse {
1952
- /** Retrieved checkout. */
1953
- checkout?: Checkout;
1954
- }
1955
- interface GetWixCheckoutURLRequest {
1956
- /**
1957
- * Checkout ID.
1958
- * @format GUID
1959
- */
1960
- id: string;
1961
- }
1962
- interface GetWixCheckoutURLResponse {
1963
- /** Checkout URL. */
1964
- checkoutUrl?: string;
1965
- }
1966
- interface GetCheckoutURLRequest {
1967
- /**
1968
- * Checkout ID.
1969
- * @format GUID
1970
- */
1971
- id: string;
1972
- }
1973
- interface GetCheckoutURLResponse {
1974
- /** Checkout URL. */
1975
- checkoutUrl?: string;
1976
- }
1977
- interface UpdateCheckoutRequest {
1978
- /** Checkout information. */
1979
- checkout: Checkout;
1980
- /**
1981
- * Coupon code.
1982
- *
1983
- * The checkout can only hold 1 `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.
1984
- */
1985
- couponCode?: string | null;
1986
- /** Gift card code. */
1987
- giftCardCode?: string | null;
1988
- /**
1989
- * `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.
1990
- *
1991
- * This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API
1992
- * to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a
1993
- * standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
1994
- * @maxLength 1000
1995
- */
1996
- overrideCheckoutUrl?: string | null;
1997
- /**
1998
- * Catalog line items.
1999
- * @maxSize 300
2000
- */
2001
- lineItems?: LineItem[];
2002
- /**
2003
- * Custom line items. Custom line items don't trigger the Catalog service plugin.
2004
- *
2005
- * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
2006
- * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2007
- * @maxSize 300
2008
- */
2009
- customLineItems?: CustomLineItem[];
2010
- }
2011
- interface UpdateCheckoutResponse {
2012
- /** Updated checkout. */
2013
- checkout?: Checkout;
2014
- }
2015
- interface RemoveCouponRequest {
2016
- /**
2017
- * ID of the checkout to remove the coupon from.
2018
- * @format GUID
2019
- */
2020
- id: string;
2021
- }
2022
- interface RemoveCouponResponse {
2023
- /** Updated checkout after removal of coupon. */
2024
- checkout?: Checkout;
2025
- }
2026
- interface RemoveGiftCardRequest {
2027
- /**
2028
- * ID of the checkout to remove the gift card from.
2029
- * @format GUID
2030
- */
2031
- id: string;
2032
- }
2033
- interface RemoveGiftCardResponse {
2034
- /** Updated checkout after removal of gift card. */
2035
- checkout?: Checkout;
2036
- }
2037
- interface RemoveOverrideCheckoutUrlRequest {
2038
- /**
2039
- * ID of the checkout to remove the override checkout url from.
2040
- * @format GUID
2041
- */
2042
- id: string;
2043
- }
2044
- interface RemoveOverrideCheckoutUrlResponse {
2045
- /** Updated checkout after removal of override checkout url. */
2046
- checkout?: Checkout;
2047
- }
2048
- interface AddToCheckoutRequest {
2049
- /**
2050
- * Checkout ID.
2051
- * @format GUID
2052
- */
2053
- id: string;
2054
- /**
2055
- * Catalog line items.
2056
- * @maxSize 100
2057
- */
2058
- lineItems?: LineItem[];
2059
- /**
2060
- * Custom line items. Custom line items don't trigger the Catalog service plugin.
2061
- *
2062
- * To access and manage custom line items, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
2063
- * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
2064
- * @maxSize 100
2065
- */
2066
- customLineItems?: CustomLineItem[];
2067
- }
2068
- interface AddToCheckoutResponse {
2069
- /** Updated checkout. */
2070
- checkout?: Checkout;
2071
- }
2072
- interface RemoveLineItemsRequest {
2073
- /**
2074
- * ID of the checkout to remove line items from.
2075
- * @format GUID
2076
- */
2077
- id: string;
2078
- /**
2079
- * IDs of the line items to remove from the checkout.
2080
- *
2081
- * To find the IDs of the checkout line items you'd like to remove,
2082
- * pass the checkout ID to Get Checkout and look for the IDs under
2083
- * `lineItems`.
2084
- * @format GUID
2085
- * @minSize 1
2086
- * @maxSize 300
2087
- */
2088
- lineItemIds: string[];
2089
- }
2090
- interface RemoveLineItemsResponse {
2091
- /** Updated checkout after removal of line items. */
2092
- checkout?: Checkout;
2093
- }
2094
- interface CreateOrderRequest {
2095
- /**
2096
- * Checkout ID.
2097
- * @format GUID
2098
- */
2099
- id: string;
2100
- /** Whether the payment method should be saved on the order. */
2101
- savePaymentMethod?: boolean;
2102
- /** Whether to authorize the payment and delay the capture. */
2103
- delayCapture?: boolean;
2104
- }
2105
- interface CreateOrderResponse extends CreateOrderResponseIdOneOf {
2106
- /**
2107
- * ID of newly created order.
2108
- * @format GUID
2109
- */
2110
- orderId?: string;
2111
- /**
2112
- * ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions).
2113
- * @format GUID
2114
- */
2115
- subscriptionId?: string;
2116
- /**
2117
- * Payment gateway order ID.
2118
- *
2119
- * 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.
2120
- * `paymentGatewayOrderId` will be returned if money needs to be charged.
2121
- *
2122
- * In some cases, money cannot be charged:
2123
- * + 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.
2124
- * + If the total price is not `0`, but the payment is covered by alternative payment methods, such as a gift card.
2125
- */
2126
- paymentGatewayOrderId?: string | null;
2127
- }
2128
- /** @oneof */
2129
- interface CreateOrderResponseIdOneOf {
2130
- /**
2131
- * ID of newly created order.
2132
- * @format GUID
2133
- */
2134
- orderId?: string;
2135
- /**
2136
- * ID of newly created subscription. Learn more about your site's [Subscriptions](https://support.wix.com/en/article/wix-stores-managing-product-subscriptions).
2137
- * @format GUID
2138
- */
2139
- subscriptionId?: string;
2140
- }
2141
- interface CreateOrderAndChargeRequest {
2142
- /**
2143
- * Checkout ID.
2144
- * @format GUID
2145
- */
2146
- id: string;
2147
- /** Payment token. */
2148
- paymentToken?: string | null;
2149
- /** Whether the payment method should be saved on the order. */
2150
- savePaymentMethod?: boolean;
2151
- /** Whether to authorize the payment and delay the capture. */
2152
- delayCapture?: boolean;
2153
- }
2154
- interface CreateOrderAndChargeResponse extends CreateOrderAndChargeResponseIdOneOf {
2155
- /**
2156
- * ID of newly created order.
2157
- * @format GUID
2158
- */
2159
- orderId?: string;
2160
- /**
2161
- * ID of newly created subscription.
2162
- * @format GUID
2163
- */
2164
- subscriptionId?: string;
2165
- /** Payment response token. */
2166
- paymentResponseToken?: string | null;
2167
- /**
2168
- * The payment gateway is cashier.
2169
- * payment_gateway_order_id will be returned given that money was charged.
2170
- * In some cases, money will not be charged:
2171
- * If the total price is 0 - For example, could be a free item or a an item with 100% discount
2172
- * If the total price is not 0, but the payment is covered by alternative payment methods such as gift card
2173
- */
2174
- paymentGatewayOrderId?: string | null;
2175
- }
2176
- /** @oneof */
2177
- interface CreateOrderAndChargeResponseIdOneOf {
2178
- /**
2179
- * ID of newly created order.
2180
- * @format GUID
2181
- */
2182
- orderId?: string;
2183
- /**
2184
- * ID of newly created subscription.
2185
- * @format GUID
2186
- */
2187
- subscriptionId?: string;
2188
- }
2189
- interface MarkCheckoutAsCompletedAndRedirectToUrlRequest {
2190
- /**
2191
- * Server-signed JWT token with required information to complete checkout
2192
- * @maxLength 4096
2193
- */
2194
- token: string;
2195
- }
2196
- interface RawHttpResponse {
2197
- body?: Uint8Array;
2198
- statusCode?: number | null;
2199
- headers?: HeadersEntry[];
2200
- }
2201
- interface HeadersEntry {
2202
- key?: string;
2203
- value?: string;
2204
- }
2205
- interface MarkCheckoutAsCompletedRequest {
2206
- /**
2207
- * Checkout ID.
2208
- * @format GUID
2209
- */
2210
- id: string;
2211
- }
2212
- interface MarkCheckoutAsCompletedResponse {
2213
- }
2214
- interface UpdateLineItemsQuantityRequest {
2215
- /**
2216
- * Checkout ID.
2217
- * @format GUID
2218
- */
2219
- id: string;
2220
- /**
2221
- * Line item info to update.
2222
- * @minSize 1
2223
- * @maxSize 100
2224
- */
2225
- lineItems: LineItemQuantityUpdate[];
2226
- }
2227
- interface LineItemQuantityUpdate {
2228
- /**
2229
- * ID of the line item to update.
2230
- * @format GUID
2231
- */
2232
- id?: string;
2233
- /**
2234
- * New total amount of the line item,
2235
- * not the amount to add to the current `quantity`.
2236
- *
2237
- * Min: `1`
2238
- *
2239
- * Max: `100000`
2240
- * @min 1
2241
- * @max 100000
2242
- */
2243
- quantity?: number;
2244
- }
2245
- interface UpdateLineItemsQuantityResponse {
2246
- /** Updated checkout. */
2247
- checkout?: Checkout;
2248
- }
2249
- interface GetCheckoutPaymentSettingsRequest {
2250
- /**
2251
- * Checkout ID.
2252
- * @format GUID
2253
- */
2254
- id: string;
2255
- }
2256
- interface GetCheckoutPaymentSettingsResponse {
2257
- blockedPaymentOptions?: GetCheckoutPaymentSettingsResponsePaymentOption[];
2258
- }
2259
- declare enum GetCheckoutPaymentSettingsResponsePaymentOption {
2260
- UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
2261
- MANUAL = "MANUAL"
2262
- }
2263
-
2264
- type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
2265
- getUrl: (context: any) => string;
2266
- httpMethod: K;
2267
- path: string;
2268
- pathParams: M;
2269
- __requestType: T;
2270
- __originalRequestType: S;
2271
- __responseType: Q;
2272
- __originalResponseType: R;
2273
- };
2274
- declare function createCheckout(): __PublicMethodMetaInfo<'POST', {}, CreateCheckoutRequest$1, CreateCheckoutRequest, CreateCheckoutResponse$1, CreateCheckoutResponse>;
2275
- declare function getCheckout(): __PublicMethodMetaInfo<'GET', {
2276
- id: string;
2277
- }, GetCheckoutRequest$1, GetCheckoutRequest, GetCheckoutResponse$1, GetCheckoutResponse>;
2278
- declare function getCheckoutByCartId(): __PublicMethodMetaInfo<'GET', {
2279
- id: string;
2280
- }, GetCheckoutByCartIdRequest$1, GetCheckoutByCartIdRequest, GetCheckoutByCartIdResponse$1, GetCheckoutByCartIdResponse>;
2281
- declare function getWixCheckoutUrl(): __PublicMethodMetaInfo<'GET', {
2282
- id: string;
2283
- }, GetWixCheckoutURLRequest$1, GetWixCheckoutURLRequest, GetWixCheckoutURLResponse$1, GetWixCheckoutURLResponse>;
2284
- declare function getCheckoutUrl(): __PublicMethodMetaInfo<'GET', {
2285
- id: string;
2286
- }, GetCheckoutURLRequest$1, GetCheckoutURLRequest, GetCheckoutURLResponse$1, GetCheckoutURLResponse>;
2287
- declare function updateCheckout(): __PublicMethodMetaInfo<'PATCH', {
2288
- checkoutId: string;
2289
- }, UpdateCheckoutRequest$1, UpdateCheckoutRequest, UpdateCheckoutResponse$1, UpdateCheckoutResponse>;
2290
- declare function removeCoupon(): __PublicMethodMetaInfo<'POST', {
2291
- id: string;
2292
- }, RemoveCouponRequest$1, RemoveCouponRequest, RemoveCouponResponse$1, RemoveCouponResponse>;
2293
- declare function removeGiftCard(): __PublicMethodMetaInfo<'POST', {
2294
- id: string;
2295
- }, RemoveGiftCardRequest$1, RemoveGiftCardRequest, RemoveGiftCardResponse$1, RemoveGiftCardResponse>;
2296
- declare function removeOverrideCheckoutUrl(): __PublicMethodMetaInfo<'POST', {
2297
- id: string;
2298
- }, RemoveOverrideCheckoutUrlRequest$1, RemoveOverrideCheckoutUrlRequest, RemoveOverrideCheckoutUrlResponse$1, RemoveOverrideCheckoutUrlResponse>;
2299
- declare function addToCheckout(): __PublicMethodMetaInfo<'POST', {
2300
- id: string;
2301
- }, AddToCheckoutRequest$1, AddToCheckoutRequest, AddToCheckoutResponse$1, AddToCheckoutResponse>;
2302
- declare function removeLineItems(): __PublicMethodMetaInfo<'POST', {
2303
- id: string;
2304
- }, RemoveLineItemsRequest$1, RemoveLineItemsRequest, RemoveLineItemsResponse$1, RemoveLineItemsResponse>;
2305
- declare function createOrder(): __PublicMethodMetaInfo<'POST', {
2306
- id: string;
2307
- }, CreateOrderRequest$1, CreateOrderRequest, CreateOrderResponse$1, CreateOrderResponse>;
2308
- declare function createOrderAndCharge(): __PublicMethodMetaInfo<'POST', {
2309
- id: string;
2310
- }, CreateOrderAndChargeRequest$1, CreateOrderAndChargeRequest, CreateOrderAndChargeResponse$1, CreateOrderAndChargeResponse>;
2311
- declare function markCheckoutAsCompletedAndRedirectToUrl(): __PublicMethodMetaInfo<'GET', {}, MarkCheckoutAsCompletedAndRedirectToUrlRequest$1, MarkCheckoutAsCompletedAndRedirectToUrlRequest, RawHttpResponse$1, RawHttpResponse>;
2312
- declare function markCheckoutAsCompleted(): __PublicMethodMetaInfo<'POST', {
2313
- id: string;
2314
- }, MarkCheckoutAsCompletedRequest$1, MarkCheckoutAsCompletedRequest, MarkCheckoutAsCompletedResponse$1, MarkCheckoutAsCompletedResponse>;
2315
- declare function updateLineItemsQuantity(): __PublicMethodMetaInfo<'POST', {
2316
- id: string;
2317
- }, UpdateLineItemsQuantityRequest$1, UpdateLineItemsQuantityRequest, UpdateLineItemsQuantityResponse$1, UpdateLineItemsQuantityResponse>;
2318
- declare function getCheckoutPaymentSettings(): __PublicMethodMetaInfo<'GET', {
2319
- id: string;
2320
- }, GetCheckoutPaymentSettingsRequest$1, GetCheckoutPaymentSettingsRequest, GetCheckoutPaymentSettingsResponse$1, GetCheckoutPaymentSettingsResponse>;
2321
-
2322
- export { type __PublicMethodMetaInfo, addToCheckout, createCheckout, createOrder, createOrderAndCharge, getCheckout, getCheckoutByCartId, getCheckoutPaymentSettings, getCheckoutUrl, getWixCheckoutUrl, markCheckoutAsCompleted, markCheckoutAsCompletedAndRedirectToUrl, removeCoupon, removeGiftCard, removeLineItems, removeOverrideCheckoutUrl, updateCheckout, updateLineItemsQuantity };