@wix/ditto-codegen-public 1.0.170 → 1.0.171

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 (16) hide show
  1. package/dist/docs-output/api-docs/ecom-cart-addToCart-doc.txt +255 -345
  2. package/dist/docs-output/api-docs/ecom-cart-createCart-doc.txt +298 -387
  3. package/dist/docs-output/api-docs/ecom-cart-createCheckout-doc.txt +24 -30
  4. package/dist/docs-output/api-docs/ecom-cart-getCart-doc.txt +174 -266
  5. package/dist/docs-output/api-docs/ecom-cart-removeLineItemsFromCart-doc.txt +175 -204
  6. package/dist/docs-output/api-docs/ecom-cart-updateCart-doc.txt +301 -398
  7. package/dist/docs-output/api-docs/ecom-checkout-addToCheckout-doc.txt +433 -816
  8. package/dist/docs-output/api-docs/ecom-checkout-createCheckout-doc.txt +519 -1282
  9. package/dist/docs-output/api-docs/ecom-checkout-getCheckout-doc.txt +353 -886
  10. package/dist/docs-output/api-docs/ecom-checkout-removeLineItemsFromCheckout-doc.txt +354 -734
  11. package/dist/docs-output/api-docs/ecom-checkout-updateCheckout-doc.txt +513 -794
  12. package/dist/docs-output/api-docs/ecom-currentCart-getCurrentCart-doc.txt +174 -301
  13. package/dist/docs-output/api-docs/ecom-currentCart-updateCurrentCart-doc.txt +301 -398
  14. package/dist/docs-output/api-docs/ecom-orders-bulkUpdateOrders-doc.txt +589 -641
  15. package/dist/docs-output/api-docs/ecom-orders-getOrder-doc.txt +425 -726
  16. package/package.json +2 -2
package/dist/docs-output/api-docs/ecom-checkout-addToCheckout-doc.txt CHANGED
@@ -28,7 +28,7 @@ undefined
28
28
 
29
29
  # Method Code Examples:
30
30
 
31
- ## Add a catalog item to a checkout
31
+ ## Add a catalog item to a checkout
32
32
 
33
33
  ```javascript
34
34
  /*****************************************
@@ -86,389 +86,6 @@ myAddToCheckoutFunction(_id, options)
86
86
  console.error(error);
87
87
  // Handle the error
88
88
  });
89
-
90
- /* Promise resolves to:
91
- *
92
- * {
93
- * "_id": "63879d9f-0d1c-49aa-a0c5-5fc612a24ec7",
94
- * "lineItems": [
95
- * {
96
- * "_id": "00000000-0000-0000-0000-000000000001",
97
- * "quantity": 1,
98
- * "catalogReference": {
99
- * "catalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a",
100
- * "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
101
- * },
102
- * "productName": {
103
- * "original": "Shirt",
104
- * "translated": "Shirt"
105
- * },
106
- * "url": "https://example.wixsite.com/ep-tester/product-page/shirt",
107
- * "price": {
108
- * "amount": "10",
109
- * "convertedAmount": "10",
110
- * "formattedAmount": "$10.00",
111
- * "formattedConvertedAmount": "$10.00"
112
- * },
113
- * "lineItemPrice": {
114
- * "amount": "10",
115
- * "convertedAmount": "10",
116
- * "formattedAmount": "$10.00",
117
- * "formattedConvertedAmount": "$10.00"
118
- * },
119
- * "fullPrice": {
120
- * "amount": "10",
121
- * "convertedAmount": "10",
122
- * "formattedAmount": "$10.00",
123
- * "formattedConvertedAmount": "$10.00"
124
- * },
125
- * "priceBeforeDiscounts": {
126
- * "amount": "10",
127
- * "convertedAmount": "10",
128
- * "formattedAmount": "$10.00",
129
- * "formattedConvertedAmount": "$10.00"
130
- * },
131
- * "totalPriceAfterTax": {
132
- * "amount": "10",
133
- * "convertedAmount": "10",
134
- * "formattedAmount": "$10.00",
135
- * "formattedConvertedAmount": "$10.00"
136
- * },
137
- * "totalPriceBeforeTax": {
138
- * "amount": "10",
139
- * "convertedAmount": "10",
140
- * "formattedAmount": "$10.00",
141
- * "formattedConvertedAmount": "$10.00"
142
- * },
143
- * "taxDetails": {
144
- * "taxableAmount": {
145
- * "amount": "10",
146
- * "convertedAmount": "10",
147
- * "formattedAmount": "$10.00",
148
- * "formattedConvertedAmount": "$10.00"
149
- * },
150
- * "taxRate": "0",
151
- * "totalTax": {
152
- * "amount": "0",
153
- * "convertedAmount": "0",
154
- * "formattedAmount": "$0.00",
155
- * "formattedConvertedAmount": "$0.00"
156
- * },
157
- * "rateBreakdown": []
158
- * },
159
- * "discount": {
160
- * "amount": "0",
161
- * "convertedAmount": "0",
162
- * "formattedAmount": "$0.00",
163
- * "formattedConvertedAmount": "$0.00"
164
- * },
165
- * "descriptionLines": [],
166
- * "media": "wix:image://v1/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg#originWidth=1000&originHeight=1000",
167
- * "availability": {
168
- * "status": "AVAILABLE"
169
- * },
170
- * "physicalProperties": {
171
- * "sku": "364115376135191",
172
- * "shippable": true
173
- * },
174
- * "couponScopes": [
175
- * {
176
- * "namespace": "stores",
177
- * "group": {
178
- * "name": "collection",
179
- * "entityId": "00000000-000000-000000-000000000001"
180
- * }
181
- * },
182
- * {
183
- * "namespace": "stores",
184
- * "group": {
185
- * "name": "product",
186
- * "entityId": "c8539b66-7a44-fe18-affc-afec4be8562a"
187
- * }
188
- * }
189
- * ],
190
- * "itemType": {
191
- * "preset": "PHYSICAL"
192
- * },
193
- * "paymentOption": "FULL_PAYMENT_ONLINE",
194
- * "rootCatalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a"
195
- * },
196
- * {
197
- * "_id": "00000000-0000-0000-0000-000000000002",
198
- * "quantity": 1,
199
- * "catalogReference": {
200
- * "catalogItemId": "df19c1f7-07d8-a265-42f8-e8dfa824cc6e",
201
- * "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
202
- * "options": {
203
- * "variantId": "e62fee23-7878-437a-bf0e-292f17d11cb5"
204
- * }
205
- * },
206
- * "productName": {
207
- * "original": "Shoe",
208
- * "translated": "Shoe"
209
- * },
210
- * "url": "https://example.wixsite.com/ep-tester/product-page/shoe",
211
- * "price": {
212
- * "amount": "85",
213
- * "convertedAmount": "85",
214
- * "formattedAmount": "$85.00",
215
- * "formattedConvertedAmount": "$85.00"
216
- * },
217
- * "lineItemPrice": {
218
- * "amount": "85",
219
- * "convertedAmount": "85",
220
- * "formattedAmount": "$85.00",
221
- * "formattedConvertedAmount": "$85.00"
222
- * },
223
- * "fullPrice": {
224
- * "amount": "85",
225
- * "convertedAmount": "85",
226
- * "formattedAmount": "$85.00",
227
- * "formattedConvertedAmount": "$85.00"
228
- * },
229
- * "priceBeforeDiscounts": {
230
- * "amount": "85",
231
- * "convertedAmount": "85",
232
- * "formattedAmount": "$85.00",
233
- * "formattedConvertedAmount": "$85.00"
234
- * },
235
- * "totalPriceAfterTax": {
236
- * "amount": "85",
237
- * "convertedAmount": "85",
238
- * "formattedAmount": "$85.00",
239
- * "formattedConvertedAmount": "$85.00"
240
- * },
241
- * "totalPriceBeforeTax": {
242
- * "amount": "85",
243
- * "convertedAmount": "85",
244
- * "formattedAmount": "$85.00",
245
- * "formattedConvertedAmount": "$85.00"
246
- * },
247
- * "taxDetails": {
248
- * "taxableAmount": {
249
- * "amount": "85",
250
- * "convertedAmount": "85",
251
- * "formattedAmount": "$85.00",
252
- * "formattedConvertedAmount": "$85.00"
253
- * },
254
- * "taxRate": "0",
255
- * "totalTax": {
256
- * "amount": "0",
257
- * "convertedAmount": "0",
258
- * "formattedAmount": "$0.00",
259
- * "formattedConvertedAmount": "$0.00"
260
- * },
261
- * "rateBreakdown": []
262
- * },
263
- * "discount": {
264
- * "amount": "0",
265
- * "convertedAmount": "0",
266
- * "formattedAmount": "$0.00",
267
- * "formattedConvertedAmount": "$0.00"
268
- * },
269
- * "descriptionLines": [
270
- * {
271
- * "name": {
272
- * "original": "Color",
273
- * "translated": "Color"
274
- * },
275
- * "colorInfo": {
276
- * "original": "Black",
277
- * "translated": "Black",
278
- * "code": "#000"
279
- * },
280
- * "lineType": "COLOR",
281
- * "color": "Black"
282
- * }
283
- * ],
284
- * "media": "wix:image://v1/3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg#originWidth=1000&originHeight=1000",
285
- * "availability": {
286
- * "status": "AVAILABLE",
287
- * "quantityAvailable": 30
288
- * },
289
- * "physicalProperties": {
290
- * "sku": "364215376135191",
291
- * "shippable": true
292
- * },
293
- * "couponScopes": [
294
- * {
295
- * "namespace": "stores",
296
- * "group": {
297
- * "name": "collection",
298
- * "entityId": "00000000-000000-000000-000000000001"
299
- * }
300
- * },
301
- * {
302
- * "namespace": "stores",
303
- * "group": {
304
- * "name": "product",
305
- * "entityId": "df19c1f7-07d8-a265-42f8-e8dfa824cc6e"
306
- * }
307
- * }
308
- * ],
309
- * "itemType": {
310
- * "preset": "PHYSICAL"
311
- * },
312
- * "paymentOption": "FULL_PAYMENT_ONLINE",
313
- * "rootCatalogItemId": "df19c1f7-07d8-a265-42f8-e8dfa824cc6e"
314
- * }
315
- * ],
316
- * "shippingInfo": {
317
- * "carrierServiceOptions": []
318
- * },
319
- * "buyerInfo": {
320
- * "contactId": "f7dc17a6-825a-466e-a78e-c4abea0217db",
321
- * "memberId": "c43190d2-eea3-493e-b6e8-f146850c6873"
322
- * },
323
- * "conversionCurrency": "USD",
324
- * "priceSummary": {
325
- * "subtotal": {
326
- * "amount": "95",
327
- * "convertedAmount": "95",
328
- * "formattedAmount": "$95.00",
329
- * "formattedConvertedAmount": "$95.00"
330
- * },
331
- * "shipping": {
332
- * "amount": "0",
333
- * "convertedAmount": "0",
334
- * "formattedAmount": "$0.00",
335
- * "formattedConvertedAmount": "$0.00"
336
- * },
337
- * "tax": {
338
- * "amount": "0",
339
- * "convertedAmount": "0",
340
- * "formattedAmount": "$0.00",
341
- * "formattedConvertedAmount": "$0.00"
342
- * },
343
- * "discount": {
344
- * "amount": "0",
345
- * "convertedAmount": "0",
346
- * "formattedAmount": "$0.00",
347
- * "formattedConvertedAmount": "$0.00"
348
- * },
349
- * "total": {
350
- * "amount": "95",
351
- * "convertedAmount": "95",
352
- * "formattedAmount": "$95.00",
353
- * "formattedConvertedAmount": "$95.00"
354
- * },
355
- * "additionalFees": {
356
- * "amount": "0",
357
- * "convertedAmount": "0",
358
- * "formattedAmount": "$0.00",
359
- * "formattedConvertedAmount": "$0.00"
360
- * }
361
- * },
362
- * "calculationErrors": {
363
- * "orderValidationErrors": []
364
- * },
365
- * "appliedDiscounts": [],
366
- * "customFields": [],
367
- * "weightUnit": "KG",
368
- * "currency": "USD",
369
- * "channelType": "WEB",
370
- * "siteLanguage": "en",
371
- * "buyerLanguage": "en",
372
- * "completed": false,
373
- * "taxIncludedInPrice": false,
374
- * "createdBy": {
375
- * "memberId": "c43190d2-eea3-493e-b6e8-f146850c6873"
376
- * },
377
- * "_createdDate": "2023-01-04T15:11:20.762Z",
378
- * "_updatedDate": "2023-01-04T15:15:24.035Z",
379
- * "payNow": {
380
- * "subtotal": {
381
- * "amount": "95",
382
- * "convertedAmount": "95",
383
- * "formattedAmount": "$95.00",
384
- * "formattedConvertedAmount": "$95.00"
385
- * },
386
- * "shipping": {
387
- * "amount": "0",
388
- * "convertedAmount": "0",
389
- * "formattedAmount": "$0.00",
390
- * "formattedConvertedAmount": "$0.00"
391
- * },
392
- * "tax": {
393
- * "amount": "0",
394
- * "convertedAmount": "0",
395
- * "formattedAmount": "$0.00",
396
- * "formattedConvertedAmount": "$0.00"
397
- * },
398
- * "discount": {
399
- * "amount": "0",
400
- * "convertedAmount": "0",
401
- * "formattedAmount": "$0.00",
402
- * "formattedConvertedAmount": "$0.00"
403
- * },
404
- * "total": {
405
- * "amount": "95",
406
- * "convertedAmount": "95",
407
- * "formattedAmount": "$95.00",
408
- * "formattedConvertedAmount": "$95.00"
409
- * },
410
- * "additionalFees": {
411
- * "amount": "0",
412
- * "convertedAmount": "0",
413
- * "formattedAmount": "$0.00",
414
- * "formattedConvertedAmount": "$0.00"
415
- * }
416
- * },
417
- * "payLater": {
418
- * "subtotal": {
419
- * "amount": "0",
420
- * "convertedAmount": "0",
421
- * "formattedAmount": "$0.00",
422
- * "formattedConvertedAmount": "$0.00"
423
- * },
424
- * "shipping": {
425
- * "amount": "0",
426
- * "convertedAmount": "0",
427
- * "formattedAmount": "$0.00",
428
- * "formattedConvertedAmount": "$0.00"
429
- * },
430
- * "tax": {
431
- * "amount": "0",
432
- * "convertedAmount": "0",
433
- * "formattedAmount": "$0.00",
434
- * "formattedConvertedAmount": "$0.00"
435
- * },
436
- * "discount": {
437
- * "amount": "0",
438
- * "convertedAmount": "0",
439
- * "formattedAmount": "$0.00",
440
- * "formattedConvertedAmount": "$0.00"
441
- * },
442
- * "total": {
443
- * "amount": "0",
444
- * "convertedAmount": "0",
445
- * "formattedAmount": "$0.00",
446
- * "formattedConvertedAmount": "$0.00"
447
- * },
448
- * "additionalFees": {
449
- * "amount": "0",
450
- * "convertedAmount": "0",
451
- * "formattedAmount": "$0.00",
452
- * "formattedConvertedAmount": "$0.00"
453
- * }
454
- * },
455
- * "membershipOptions": {
456
- * "eligibleMemberships": [],
457
- * "invalidMemberships": [],
458
- * "selectedMemberships": {
459
- * "memberships": []
460
- * }
461
- * },
462
- * "additionalFees": [],
463
- * "payNowTotalAfterGiftCard": {
464
- * "amount": "95",
465
- * "convertedAmount": "95",
466
- * "formattedAmount": "$95.00",
467
- * "formattedConvertedAmount": "$95.00"
468
- * }
469
- * }
470
- *
471
- */
472
89
  ```
473
90
 
474
91
 
@@ -501,224 +118,224 @@ Method: ecom.checkout.addToCheckout(_id, options)
501
118
  Description: Adds catalog line items and/or custom line items to a checkout. When adding [catalog](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration) items to a checkout, the `lineItems.catalogReference.appId` and `lineItems.catalogReference.catalogItemId` fields are required.
502
119
  Method parameters:
503
120
  param name: _id | type: string | description: Checkout GUID. | required: true
504
- param name: options | type: AddToCheckoutOptions | description: Items to be added to checkout.
505
- - name: customLineItems | type: Array<CustomLineItem> | description: Custom line items. Custom line items don't trigger the Catalog service plugin. To access and manage custom line items, 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).
506
- - name: catalogReference | type: CatalogReference | description: Catalog and item reference. Includes GUIDs 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.
507
- - name: appId | type: string | description: GUID of the app providing the catalog. You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). For items from Wix catalogs, the following values always apply: + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"` + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"` + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
508
- - name: catalogItemId | type: string | description: GUID of the item within the catalog it belongs to.
509
- - name: options | type: Record<string, any> | description: 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. For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
510
- - name: deliveryProfileId | type: string | description: Delivery profile GUID.
511
- - name: depositAmount | type: string | description: Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE`. When omitted, the item's price will not be split and is expected to be paid in a single installment.
512
- - name: descriptionLines | type: Array<DescriptionLine> | description: Custom line item description lines. Used for display purposes for the cart, checkout and order.
513
- - name: name | type: DescriptionLineName | description: Description line name.
514
- - name: original | type: string | description: 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).
515
- - name: translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`.
516
- - ONE-OF:
517
- - name: colorInfo | type: Color | description: Description line color value.
518
- - name: code | type: string | description: HEX or RGB color code for display.
519
- - name: original | type: string | description: 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).
520
- - name: translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`.
521
- - name: plainText | type: PlainTextValue | description: Description line plain text value.
522
- - name: original | type: string | description: 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).
523
- - name: translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`.
524
- - ONE-OF:
525
- - name: fixedQuantity | type: boolean | description: Whether the line item quantity is fixed and cannot be changed. Default: `false`
526
- - name: fullPrice | type: string | description: Item price **before** catalog-defined discount. Defaults to `price` when not provided.
121
+ param name: options | type: AddToCheckoutOptions | description: Items to be added to checkout.
122
+ - name: customLineItems | type: Array<CustomLineItem> | description: Custom line items. Custom line items don't trigger the Catalog service plugin. To access and manage custom line items, 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).
123
+ - name: catalogReference | type: CatalogReference | description: Catalog and item reference. Includes GUIDs 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.
124
+ - name: appId | type: string | description: GUID of the app providing the catalog. You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). For items from Wix catalogs, the following values always apply: + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"` + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"` + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
125
+ - name: catalogItemId | type: string | description: GUID of the item within the catalog it belongs to.
126
+ - name: options | type: Record<string, any> | description: 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. For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
127
+ - name: deliveryProfileId | type: string | description: Delivery profile GUID.
128
+ - name: depositAmount | type: string | description: Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE`. When omitted, the item's price will not be split and is expected to be paid in a single installment.
129
+ - name: descriptionLines | type: Array<DescriptionLine> | description: Custom line item description lines. Used for display purposes for the cart, checkout and order.
130
+ - name: name | type: DescriptionLineName | description: Description line name.
131
+ - name: original | type: string | description: 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).
132
+ - name: translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`.
133
+ - ONE-OF:
134
+ - name: colorInfo | type: Color | description: Description line color value.
135
+ - name: code | type: string | description: HEX or RGB color code for display.
136
+ - name: original | type: string | description: 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).
137
+ - name: translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`.
138
+ - name: plainText | type: PlainTextValue | description: Description line plain text value.
139
+ - name: original | type: string | description: 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).
140
+ - name: translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`.
141
+ - ONE-OF:
142
+ - name: fixedQuantity | type: boolean | description: Whether the line item quantity is fixed and cannot be changed. Default: `false`
143
+ - name: fullPrice | type: string | description: Item price **before** catalog-defined discount. Defaults to `price` when not provided.
527
144
  - name: itemType | type: ItemType | description: Item type. Either a preset type or custom. | required: true
528
- - ONE-OF:
529
- - name: custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type.
530
- - name: preset | type: ItemTypePreset | description: Preset item type.
145
+ - ONE-OF:
146
+ - name: custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type.
147
+ - name: preset | type: ItemTypePreset | description: Preset item type.
531
148
  enum: DIGITAL, GIFT_CARD, PHYSICAL, SERVICE, UNRECOGNISED
532
- - name: media | type: string | description: Custom line item media. + We only support images coming from Wix media manager, if you want to use an image from another source you must first upload it to [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"`.
533
- - name: membersOnly | type: boolean | description: Whether the item can only be purchased by site members. Default: `false`
534
- - name: modifierGroups | type: Array<V1ModifierGroup> | description: Modifier groups that were added to the item.
535
- - name: _id | type: string | description: Modifier group GUID.
536
- - name: modifiers | type: Array<V1ItemModifier> | description: List of modifiers in this group.
537
- - name: _id | type: string | description: Modifier GUID.
538
- - name: details | type: TranslatableString | description: Additional details.
539
- - name: original | type: string | description: __Required.__ String 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). Min: 1 character. Max: 200 characters.
540
- - name: translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
541
- - name: label | type: TranslatableString | description: Primary display label for the modifier.
542
- - name: price | type: string | description: The price of the modifier.
543
- - name: quantity | type: number | description: The quantity of this modifier.
544
- - name: name | type: TranslatableString | description: Modifier group name.
545
- - name: paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`. + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout. + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0. + `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.
546
- enum:
149
+ - name: media | type: string | description: Custom line item media. + We only support images coming from Wix media manager, if you want to use an image from another source you must first upload it to [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"`.
150
+ - name: membersOnly | type: boolean | description: Whether the item can only be purchased by site members. Default: `false`
151
+ - name: modifierGroups | type: Array<V1ModifierGroup> | description: Modifier groups that were added to the item.
152
+ - name: _id | type: string | description: Modifier group GUID.
153
+ - name: modifiers | type: Array<V1ItemModifier> | description: List of modifiers in this group.
154
+ - name: _id | type: string | description: Modifier GUID.
155
+ - name: details | type: TranslatableString | description: Additional details.
156
+ - name: original | type: string | description: __Required.__ String 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). Min: 1 character. Max: 200 characters.
157
+ - name: translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
158
+ - name: label | type: TranslatableString | description: Primary display label for the modifier.
159
+ - name: price | type: string | description: The price of the modifier.
160
+ - name: quantity | type: number | description: The quantity of this modifier.
161
+ - name: name | type: TranslatableString | description: Modifier group name.
162
+ - name: paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`. + `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout. + `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0. + `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.
163
+ enum:
547
164
  DEPOSIT_ONLINE: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`.
548
165
  FULL_PAYMENT_OFFLINE: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods.
549
166
  FULL_PAYMENT_ONLINE: The entire payment for this item happens as part of the checkout.
550
167
  MEMBERSHIP: Payment for this item is done by charging a membership. Any remaining amount not covered by the membership, such as item modifiers, is paid online.
551
168
  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`.
552
169
  MEMBERSHIP_ONLINE_WITH_OFFLINE_REMAINDER: Item price is charged to online membership. Any remaining amount not covered by the membership, such as item modifiers, is paid offline.
553
- - name: physicalProperties | type: PhysicalProperties | description: Physical properties of the item.
554
- - name: shippable | type: boolean | description: Whether this line item is shippable.
555
- - name: sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
556
- - name: weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
557
- - name: policies | type: Array<Policy> | description: Policies to be displayed to the customer on the checkout page.
558
- - name: content | type: string | description: Policy content - should be translated
559
- - name: title | type: string | description: Policy title - should be translated
560
- - name: price | type: string | description: Custom line item price. For security reasons, the `price` field should come from backend code, and not be passed from the frontend.
561
- - name: priceDescription | type: PriceDescription | description: Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
562
- - name: original | type: string | description: __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).
563
- - name: translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`.
564
- - name: priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created. Default: `false`
170
+ - name: physicalProperties | type: PhysicalProperties | description: Physical properties of the item.
171
+ - name: shippable | type: boolean | description: Whether this line item is shippable.
172
+ - name: sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
173
+ - name: weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
174
+ - name: policies | type: Array<Policy> | description: Policies to be displayed to the customer on the checkout page.
175
+ - name: content | type: string | description: Policy content - should be translated
176
+ - name: title | type: string | description: Policy title - should be translated
177
+ - name: price | type: string | description: Custom line item price. For security reasons, the `price` field should come from backend code, and not be passed from the frontend.
178
+ - name: priceDescription | type: PriceDescription | description: Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
179
+ - name: original | type: string | description: __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).
180
+ - name: translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`.
181
+ - name: priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created. Default: `false`
565
182
  - name: productName | type: ProductName | description: Name of the item or product. | required: true
566
- - name: original | type: string | description: __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). Min: 1 character. Max: 200 characters.
567
- - name: translated | type: string | description: Item name translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
568
- - name: quantity | type: number | description: Custom line item quantity. Min: `1` Max: `100000`
569
- - name: quantityAvailable | type: number | description: Item quantity available for purchase. Only return this if inventory is managed. Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
570
- - name: rootCatalogItemId | type: string | description: In cases where `catalogReference.catalogItemId` is NOT the actual catalog item GUID, this field will return the true item's GUID. + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking GUID. Therefore this value is set to the service GUID. + In most cases, this field is the same as `catalogReference.catalogItemId`. + Used in membership validation.
571
- - name: serviceProperties | type: ServiceProperties | description: Service properties. When relevant, this contains information such as date and number of participants. Used, among other things, when checking for valid memberships.
572
- - name: numberOfParticipants | type: number | description: 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.
573
- - name: scheduledDate | type: Date | description: 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. For example, the start time of a class.
574
- - name: taxGroupId | type: string | description: Tax group GUID for this custom line item.
575
- - name: taxableAddress | type: TaxableAddress | description: Address to use for tax calculation purposes.
576
- - ONE-OF:
577
- - name: addressType | type: TaxableAddressType | description: taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly.
183
+ - name: original | type: string | description: __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). Min: 1 character. Max: 200 characters.
184
+ - name: translated | type: string | description: Item name translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
185
+ - name: quantity | type: number | description: Custom line item quantity. Min: `1` Max: `100000`
186
+ - name: quantityAvailable | type: number | description: Item quantity available for purchase. Only return this if inventory is managed. Not returning this field means that the buyer can "infinitely" tick up the number of items in the cart.
187
+ - name: rootCatalogItemId | type: string | description: In cases where `catalogReference.catalogItemId` is NOT the actual catalog item GUID, this field will return the true item's GUID. + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking GUID. Therefore this value is set to the service GUID. + In most cases, this field is the same as `catalogReference.catalogItemId`. + Used in membership validation.
188
+ - name: serviceProperties | type: ServiceProperties | description: Service properties. When relevant, this contains information such as date and number of participants. Used, among other things, when checking for valid memberships.
189
+ - name: numberOfParticipants | type: number | description: 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.
190
+ - name: scheduledDate | type: Date | description: 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. For example, the start time of a class.
191
+ - name: taxGroupId | type: string | description: Tax group GUID for this custom line item.
192
+ - name: taxableAddress | type: TaxableAddress | description: Address to use for tax calculation purposes.
193
+ - ONE-OF:
194
+ - name: addressType | type: TaxableAddressType | description: taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly.
578
195
  enum: BILLING, BUSINESS, SHIPPING, UNKNOWN_TAXABLE_ADDRESS
579
- - name: url | type: string | description: 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.
580
- - name: lineItems | type: Array<LineItem> | description: Catalog line items.
581
- - name: catalogOverrideFields | type: CatalogOverrideFields | description: Overriding values for catalog item properties. To override catalog fields, 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).
582
- - name: depositAmount | type: string | description: Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
583
- - name: descriptionLines | type: Array<DescriptionLine> | description: Item description lines. Used when displaying the line item to customers.
584
- - name: fullPrice | type: string | description: Item price **before** discounts.
585
- - name: image | type: string | description: Item image.
586
- - name: paymentOption | type: PaymentOption | description: Payment method selected for the item.
587
- - name: value | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
588
- - name: physicalProperties | type: PhysicalProperties | description: Physical properties of the item.
589
- - name: price | type: string | description: Item price **after** discounts.
590
- - name: productName | type: ProductName | description: Item name.
591
- - name: savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false`
196
+ - name: url | type: string | description: 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.
197
+ - name: lineItems | type: Array<LineItem> | description: Catalog line items.
198
+ - name: catalogOverrideFields | type: CatalogOverrideFields | description: Overriding values for catalog item properties. To override catalog fields, 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).
199
+ - name: depositAmount | type: string | description: Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
200
+ - name: descriptionLines | type: Array<DescriptionLine> | description: Item description lines. Used when displaying the line item to customers.
201
+ - name: fullPrice | type: string | description: Item price **before** discounts.
202
+ - name: image | type: string | description: Item image.
203
+ - name: paymentOption | type: PaymentOption | description: Payment method selected for the item.
204
+ - name: value | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
205
+ - name: physicalProperties | type: PhysicalProperties | description: Physical properties of the item.
206
+ - name: price | type: string | description: Item price **after** discounts.
207
+ - name: productName | type: ProductName | description: Item name.
208
+ - name: savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false`
592
209
  - name: catalogReference | type: CatalogReference | description: Catalog and item reference. Includes GUIDs 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. | required: true
593
- - name: extendedFields | type: ExtendedFields | description: Custom extended fields for the line item object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured using the 'Checkout & Orders - Line Items Schema Plugin' in the app dashboard before they can be accessed with API calls.
594
- - name: namespaces | type: Record<string, undefined> | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
210
+ - name: extendedFields | type: ExtendedFields | description: Custom extended fields for the line item object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured using the 'Checkout & Orders - Line Items Schema Plugin' in the app dashboard before they can be accessed with API calls.
211
+ - name: namespaces | type: Record<string, undefined> | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
595
212
  - name: quantity | type: number | description: Item quantity. Min: `"1"` Max: `"100000"` | required: true
596
- - name: taxableAddress | type: TaxableAddress | description: Address to use for tax calculation purposes.
213
+ - name: taxableAddress | type: TaxableAddress | description: Address to use for tax calculation purposes.
597
214
  Return type: PROMISE<AddToCheckoutResponse>
598
- - name: checkout | type: Checkout | description: Updated checkout.
599
- - name: checkout._createdDate | type: Date | description: Date and time the checkout was created.
600
- - name: checkout._id | type: string | description: Checkout GUID.
601
- - name: checkout._updatedDate | type: Date | description: Date and time the checkout was updated.
602
- - name: checkout.additionalFees | type: Array<AdditionalFee> | description: Additional Fees.
603
- - name: checkout.additionalFees[].code | type: string | description: Additional fee's unique code (or GUID) for future processing.
604
- - name: checkout.additionalFees[].lineItemIds | type: Array<string> | description: Optional - Line items associated with this additional fee. If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
605
- - name: checkout.additionalFees[].name | type: string | description: Translated additional fee's name.
606
- - name: checkout.additionalFees[].price | type: MultiCurrencyPrice | description: Additional fee's price.
607
- - name: checkout.additionalFees[].price.amount | type: string | description: Amount.
608
- - name: checkout.additionalFees[].price.convertedAmount | type: string | description: Converted amount.
609
- - name: checkout.additionalFees[].price.formattedAmount | type: string | description: Amount formatted with currency symbol.
610
- - name: checkout.additionalFees[].price.formattedConvertedAmount | type: string | description: Converted amount formatted with currency symbol.
611
- - name: checkout.additionalFees[].priceAfterTax | type: MultiCurrencyPrice | description: Additional fee's price after tax.
612
- - name: checkout.additionalFees[].priceBeforeTax | type: MultiCurrencyPrice | description: Additional fee's price before tax.
613
- - name: checkout.additionalFees[].providerAppId | type: string | description: Provider's app id.
614
- - name: checkout.additionalFees[].source | type: AdditionalFeeSource | description: the source the additional fee was added from
615
- enum:
215
+ - name: checkout | type: Checkout | description: Updated checkout.
216
+ - name: checkout._createdDate | type: Date | description: Date and time the checkout was created.
217
+ - name: checkout._id | type: string | description: Checkout GUID.
218
+ - name: checkout._updatedDate | type: Date | description: Date and time the checkout was updated.
219
+ - name: checkout.additionalFees | type: Array<AdditionalFee> | description: Additional Fees.
220
+ - name: checkout.additionalFees[].code | type: string | description: Additional fee's unique code (or GUID) for future processing.
221
+ - name: checkout.additionalFees[].lineItemIds | type: Array<string> | description: Optional - Line items associated with this additional fee. If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
222
+ - name: checkout.additionalFees[].name | type: string | description: Translated additional fee's name.
223
+ - name: checkout.additionalFees[].price | type: MultiCurrencyPrice | description: Additional fee's price.
224
+ - name: checkout.additionalFees[].price.amount | type: string | description: Amount.
225
+ - name: checkout.additionalFees[].price.convertedAmount | type: string | description: Converted amount.
226
+ - name: checkout.additionalFees[].price.formattedAmount | type: string | description: Amount formatted with currency symbol.
227
+ - name: checkout.additionalFees[].price.formattedConvertedAmount | type: string | description: Converted amount formatted with currency symbol.
228
+ - name: checkout.additionalFees[].priceAfterTax | type: MultiCurrencyPrice | description: Additional fee's price after tax.
229
+ - name: checkout.additionalFees[].priceBeforeTax | type: MultiCurrencyPrice | description: Additional fee's price before tax.
230
+ - name: checkout.additionalFees[].providerAppId | type: string | description: Provider's app id.
231
+ - name: checkout.additionalFees[].source | type: AdditionalFeeSource | description: the source the additional fee was added from
232
+ enum:
616
233
  ITEM: The additional fee was added on the item either via the catalog or on custom line item
617
234
  MANUAL: The additional fee was added manually on the request
618
235
  SERVICE_PLUGIN: The additional fee was added by an additional fee service plugin
619
236
  SHIPPING: The additional fee was added by the shipping provider
620
237
  UNKNOWN_ADDITIONAL_FEE_SOURCE
621
- - name: checkout.additionalFees[].taxDetails | type: ItemTaxFullDetails | description: Tax details.
622
- - name: checkout.additionalFees[].taxDetails.taxBreakdown | type: Array<TaxBreakdown> | description: tax information for a line item.
623
- - name: checkout.additionalFees[].taxDetails.taxBreakdown[].jurisdiction | type: string | description: The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
624
- - name: checkout.additionalFees[].taxDetails.taxBreakdown[].jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies.
238
+ - name: checkout.additionalFees[].taxDetails | type: ItemTaxFullDetails | description: Tax details.
239
+ - name: checkout.additionalFees[].taxDetails.taxBreakdown | type: Array<TaxBreakdown> | description: tax information for a line item.
240
+ - name: checkout.additionalFees[].taxDetails.taxBreakdown[].jurisdiction | type: string | description: The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
241
+ - name: checkout.additionalFees[].taxDetails.taxBreakdown[].jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies.
625
242
  enum: CITY, COUNTRY, COUNTY, SPECIAL, STATE, UNDEFINED
626
- - name: checkout.additionalFees[].taxDetails.taxBreakdown[].nonTaxableAmount | type: MultiCurrencyPrice | description: The amount of this line item price that was considered nontaxable. (Decimal value)
627
- - name: checkout.additionalFees[].taxDetails.taxBreakdown[].rate | type: string | description: The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
628
- - name: checkout.additionalFees[].taxDetails.taxBreakdown[].taxAmount | type: MultiCurrencyPrice | description: The amount of tax estimated for this line item. (Decimal value)
629
- - name: checkout.additionalFees[].taxDetails.taxBreakdown[].taxName | type: string | description: The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc. This name should be explicit enough to allow the merchant to understand what tax was calculated.
630
- - name: checkout.additionalFees[].taxDetails.taxBreakdown[].taxType | type: string | description: The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
631
- - name: checkout.additionalFees[].taxDetails.taxBreakdown[].taxableAmount | type: MultiCurrencyPrice | description: The taxable amount of this line item.
632
- - name: checkout.additionalFees[].taxDetails.taxRate | type: string | description: Tax rate %, as a decimal point between 0 and 1.
633
- - name: checkout.additionalFees[].taxDetails.taxableAmount | type: MultiCurrencyPrice | description: Amount for which tax is calculated.
634
- - name: checkout.additionalFees[].taxDetails.totalTax | type: MultiCurrencyPrice | description: Calculated tax, based on `taxable_amount` and `tax_rate`.
635
- - name: checkout.additionalFees[].translatedName | type: string | description: The translated name of the additional fee. The translation language is determined by the `languages` field 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).
636
- - name: checkout.appliedDiscounts | type: Array<AppliedDiscount> | description: Applied discounts.
637
- - name: checkout.appliedDiscounts[].discountType | type: DiscountType | description: Discount type.
243
+ - name: checkout.additionalFees[].taxDetails.taxBreakdown[].nonTaxableAmount | type: MultiCurrencyPrice | description: The amount of this line item price that was considered nontaxable. (Decimal value)
244
+ - name: checkout.additionalFees[].taxDetails.taxBreakdown[].rate | type: string | description: The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
245
+ - name: checkout.additionalFees[].taxDetails.taxBreakdown[].taxAmount | type: MultiCurrencyPrice | description: The amount of tax estimated for this line item. (Decimal value)
246
+ - name: checkout.additionalFees[].taxDetails.taxBreakdown[].taxName | type: string | description: The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc. This name should be explicit enough to allow the merchant to understand what tax was calculated.
247
+ - name: checkout.additionalFees[].taxDetails.taxBreakdown[].taxType | type: string | description: The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
248
+ - name: checkout.additionalFees[].taxDetails.taxBreakdown[].taxableAmount | type: MultiCurrencyPrice | description: The taxable amount of this line item.
249
+ - name: checkout.additionalFees[].taxDetails.taxRate | type: string | description: Tax rate %, as a decimal point between 0 and 1.
250
+ - name: checkout.additionalFees[].taxDetails.taxableAmount | type: MultiCurrencyPrice | description: Amount for which tax is calculated.
251
+ - name: checkout.additionalFees[].taxDetails.totalTax | type: MultiCurrencyPrice | description: Calculated tax, based on `taxable_amount` and `tax_rate`.
252
+ - name: checkout.additionalFees[].translatedName | type: string | description: The translated name of the additional fee. The translation language is determined by the `languages` field 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).
253
+ - name: checkout.appliedDiscounts | type: Array<AppliedDiscount> | description: Applied discounts.
254
+ - name: checkout.appliedDiscounts[].discountType | type: DiscountType | description: Discount type.
638
255
  enum: GLOBAL, SHIPPING, SPECIFIC_ITEMS
639
- - ONE-OF:
640
- - name: checkout.appliedDiscounts[].coupon | type: Coupon | description: Coupon details.
641
- - name: checkout.appliedDiscounts[].coupon._id | type: string | description: Coupon GUID.
642
- - name: checkout.appliedDiscounts[].coupon.amount | type: MultiCurrencyPrice | description: Coupon value.
643
- - name: checkout.appliedDiscounts[].coupon.code | type: string | description: Coupon code.
644
- - name: checkout.appliedDiscounts[].coupon.name | type: string | description: Coupon name.
645
- - name: checkout.appliedDiscounts[].discountRule | type: DiscountRule | description: Discount rule
646
- - name: checkout.appliedDiscounts[].discountRule._id | type: string | description: Discount rule GUID
647
- - name: checkout.appliedDiscounts[].discountRule.amount | type: MultiCurrencyPrice | description: Discount value.
648
- - name: checkout.appliedDiscounts[].discountRule.name | type: DiscountRuleName | description: Discount rule name
649
- - name: checkout.appliedDiscounts[].discountRule.name.original | type: string | description: Original discount rule name (in site's default language).
650
- - name: checkout.appliedDiscounts[].discountRule.name.translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided.
651
- - name: checkout.appliedDiscounts[].merchantDiscount | type: MerchantDiscount | description: Merchant discount.
652
- - name: checkout.appliedDiscounts[].merchantDiscount.amount | type: MultiCurrencyPrice | description: Discount value.
653
- - name: checkout.appliedDiscounts[].merchantDiscount.percentage | type: number | description: Discount Percentage. Will be calculated from items price before other discounts.
654
- - name: checkout.billingInfo | type: AddressWithContact | description: Billing information.
655
- - name: checkout.billingInfo.address | type: ApiAddress | description: Address.
656
- - name: checkout.billingInfo.address.addressLine1 | type: string | description: Main address line (usually street name and number).
657
- - name: checkout.billingInfo.address.addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
658
- - name: checkout.billingInfo.address.city | type: string | description: City name.
659
- - name: checkout.billingInfo.address.country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
660
- - name: checkout.billingInfo.address.countryFullname | type: string | description: Country's full name.
661
- - name: checkout.billingInfo.address.location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
662
- - name: checkout.billingInfo.address.location.latitude | type: number | description: Address latitude.
663
- - name: checkout.billingInfo.address.location.longitude | type: number | description: Address longitude.
664
- - name: checkout.billingInfo.address.postalCode | type: string | description: Postal or zip code.
665
- - name: checkout.billingInfo.address.streetAddress | type: StreetAddress | description: Street address.
666
- - name: checkout.billingInfo.address.streetAddress.name | type: string | description: Street name.
667
- - name: checkout.billingInfo.address.streetAddress.number | type: string | description: Street number.
668
- - name: checkout.billingInfo.address.subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
669
- - name: checkout.billingInfo.address.subdivisionFullname | type: string | description: Subdivision full-name.
670
- - name: checkout.billingInfo.contactDetails | type: FullAddressContactDetails | description: Contact details.
671
- - name: checkout.billingInfo.contactDetails.company | type: string | description: Company name.
672
- - name: checkout.billingInfo.contactDetails.firstName | type: string | description: First name.
673
- - name: checkout.billingInfo.contactDetails.lastName | type: string | description: Last name.
674
- - name: checkout.billingInfo.contactDetails.phone | type: string | description: Phone number.
675
- - name: checkout.billingInfo.contactDetails.vatId | type: CommonVatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
676
- - name: checkout.billingInfo.contactDetails.vatId._id | type: string | description: Customer's tax GUID.
677
- - name: checkout.billingInfo.contactDetails.vatId.type | type: CommonVatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
678
- enum:
256
+ - ONE-OF:
257
+ - name: checkout.appliedDiscounts[].coupon | type: Coupon | description: Coupon details.
258
+ - name: checkout.appliedDiscounts[].coupon._id | type: string | description: Coupon GUID.
259
+ - name: checkout.appliedDiscounts[].coupon.amount | type: MultiCurrencyPrice | description: Coupon value.
260
+ - name: checkout.appliedDiscounts[].coupon.code | type: string | description: Coupon code.
261
+ - name: checkout.appliedDiscounts[].coupon.name | type: string | description: Coupon name.
262
+ - name: checkout.appliedDiscounts[].discountRule | type: DiscountRule | description: Discount rule
263
+ - name: checkout.appliedDiscounts[].discountRule._id | type: string | description: Discount rule GUID
264
+ - name: checkout.appliedDiscounts[].discountRule.amount | type: MultiCurrencyPrice | description: Discount value.
265
+ - name: checkout.appliedDiscounts[].discountRule.name | type: DiscountRuleName | description: Discount rule name
266
+ - name: checkout.appliedDiscounts[].discountRule.name.original | type: string | description: Original discount rule name (in site's default language).
267
+ - name: checkout.appliedDiscounts[].discountRule.name.translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided.
268
+ - name: checkout.appliedDiscounts[].merchantDiscount | type: MerchantDiscount | description: Merchant discount.
269
+ - name: checkout.appliedDiscounts[].merchantDiscount.amount | type: MultiCurrencyPrice | description: Discount value.
270
+ - name: checkout.appliedDiscounts[].merchantDiscount.percentage | type: number | description: Discount Percentage. Will be calculated from items price before other discounts.
271
+ - name: checkout.billingInfo | type: AddressWithContact | description: Billing information.
272
+ - name: checkout.billingInfo.address | type: ApiAddress | description: Address.
273
+ - name: checkout.billingInfo.address.addressLine1 | type: string | description: Main address line (usually street name and number).
274
+ - name: checkout.billingInfo.address.addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
275
+ - name: checkout.billingInfo.address.city | type: string | description: City name.
276
+ - name: checkout.billingInfo.address.country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
277
+ - name: checkout.billingInfo.address.countryFullname | type: string | description: Country's full name.
278
+ - name: checkout.billingInfo.address.location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
279
+ - name: checkout.billingInfo.address.location.latitude | type: number | description: Address latitude.
280
+ - name: checkout.billingInfo.address.location.longitude | type: number | description: Address longitude.
281
+ - name: checkout.billingInfo.address.postalCode | type: string | description: Postal or zip code.
282
+ - name: checkout.billingInfo.address.streetAddress | type: StreetAddress | description: Street address.
283
+ - name: checkout.billingInfo.address.streetAddress.name | type: string | description: Street name.
284
+ - name: checkout.billingInfo.address.streetAddress.number | type: string | description: Street number.
285
+ - name: checkout.billingInfo.address.subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
286
+ - name: checkout.billingInfo.address.subdivisionFullname | type: string | description: Subdivision full-name.
287
+ - name: checkout.billingInfo.contactDetails | type: FullAddressContactDetails | description: Contact details.
288
+ - name: checkout.billingInfo.contactDetails.company | type: string | description: Company name.
289
+ - name: checkout.billingInfo.contactDetails.firstName | type: string | description: First name.
290
+ - name: checkout.billingInfo.contactDetails.lastName | type: string | description: Last name.
291
+ - name: checkout.billingInfo.contactDetails.phone | type: string | description: Phone number.
292
+ - name: checkout.billingInfo.contactDetails.vatId | type: CommonVatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
293
+ - name: checkout.billingInfo.contactDetails.vatId._id | type: string | description: Customer's tax GUID.
294
+ - name: checkout.billingInfo.contactDetails.vatId.type | type: CommonVatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
295
+ enum:
679
296
  CNPJ: CNPJ - for corporations
680
297
  CPF: CPF - for individual tax payers.
681
298
  UNSPECIFIED
682
- - name: checkout.businessLocationId | type: string | description: The business location GUID associated with the checkout. To learn more, see the Locations API.
683
- - name: checkout.buyerInfo | type: BuyerInfo | description: Buyer information.
684
- - name: checkout.buyerInfo.contactId | type: string | description: Contact GUID. Auto-created if one does not yet exist. For more information, see the Contacts API.
685
- - name: checkout.buyerInfo.email | type: string | description: Buyer email address.
686
- - ONE-OF:
687
- - name: checkout.buyerInfo.memberId | type: string | description: Member GUID (if site visitor is a site member).
688
- - name: checkout.buyerInfo.visitorId | type: string | description: Visitor GUID (if site visitor is **not** a member).
689
- - name: checkout.buyerLanguage | type: string | description: Language for communication with the buyer. Defaults to the site language. For a site that supports multiple languages, this is the language the buyer selected.
690
- - name: checkout.buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
691
- - name: checkout.calculationErrors | type: CalculationErrors | description: Errors when calculating totals.
692
- - name: checkout.calculationErrors.couponCalculationError | type: Details | description: Coupon calculation error.
693
- - ONE-OF:
694
- - name: checkout.calculationErrors.couponCalculationError.applicationError | type: ApplicationError | description: none
695
- - name: checkout.calculationErrors.couponCalculationError.applicationError.code | type: string | description: Error code.
696
- - name: checkout.calculationErrors.couponCalculationError.applicationError.data | type: Record<string, any> | description: Data related to the error.
697
- - name: checkout.calculationErrors.couponCalculationError.applicationError.description | type: string | description: Description of the error.
698
- - name: checkout.calculationErrors.couponCalculationError.systemError | type: SystemError | description: none
699
- - name: checkout.calculationErrors.couponCalculationError.systemError.errorCode | type: string | description: Error code.
700
- - name: checkout.calculationErrors.couponCalculationError.validationError | type: ValidationError | description: none
701
- - name: checkout.calculationErrors.couponCalculationError.validationError.fieldViolations | type: Array<FieldViolation> | description: none
702
- - name: checkout.calculationErrors.couponCalculationError.validationError.fieldViolations[].data | type: Record<string, any> | description: none
703
- - name: checkout.calculationErrors.couponCalculationError.validationError.fieldViolations[].description | type: string | description: none
704
- - name: checkout.calculationErrors.couponCalculationError.validationError.fieldViolations[].field | type: string | description: none
705
- - name: checkout.calculationErrors.couponCalculationError.validationError.fieldViolations[].ruleName | type: string | description: applicable when violated_rule=OTHER
706
- - name: checkout.calculationErrors.couponCalculationError.validationError.fieldViolations[].violatedRule | type: RuleType | description: none
299
+ - name: checkout.businessLocationId | type: string | description: The business location GUID associated with the checkout. To learn more, see the Locations API.
300
+ - name: checkout.buyerInfo | type: BuyerInfo | description: Buyer information.
301
+ - name: checkout.buyerInfo.contactId | type: string | description: Contact GUID. Auto-created if one does not yet exist. For more information, see the Contacts API.
302
+ - name: checkout.buyerInfo.email | type: string | description: Buyer email address.
303
+ - ONE-OF:
304
+ - name: checkout.buyerInfo.memberId | type: string | description: Member GUID (if site visitor is a site member).
305
+ - name: checkout.buyerInfo.visitorId | type: string | description: Visitor GUID (if site visitor is **not** a member).
306
+ - name: checkout.buyerLanguage | type: string | description: Language for communication with the buyer. Defaults to the site language. For a site that supports multiple languages, this is the language the buyer selected.
307
+ - name: checkout.buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
308
+ - name: checkout.calculationErrors | type: CalculationErrors | description: Errors when calculating totals.
309
+ - name: checkout.calculationErrors.couponCalculationError | type: Details | description: Coupon calculation error.
310
+ - ONE-OF:
311
+ - name: checkout.calculationErrors.couponCalculationError.applicationError | type: ApplicationError | description: none
312
+ - name: checkout.calculationErrors.couponCalculationError.applicationError.code | type: string | description: Error code.
313
+ - name: checkout.calculationErrors.couponCalculationError.applicationError.data | type: Record<string, any> | description: Data related to the error.
314
+ - name: checkout.calculationErrors.couponCalculationError.applicationError.description | type: string | description: Description of the error.
315
+ - name: checkout.calculationErrors.couponCalculationError.systemError | type: SystemError | description: none
316
+ - name: checkout.calculationErrors.couponCalculationError.systemError.errorCode | type: string | description: Error code.
317
+ - name: checkout.calculationErrors.couponCalculationError.validationError | type: ValidationError | description: none
318
+ - name: checkout.calculationErrors.couponCalculationError.validationError.fieldViolations | type: Array<FieldViolation> | description: none
319
+ - name: checkout.calculationErrors.couponCalculationError.validationError.fieldViolations[].data | type: Record<string, any> | description: none
320
+ - name: checkout.calculationErrors.couponCalculationError.validationError.fieldViolations[].description | type: string | description: none
321
+ - name: checkout.calculationErrors.couponCalculationError.validationError.fieldViolations[].field | type: string | description: none
322
+ - name: checkout.calculationErrors.couponCalculationError.validationError.fieldViolations[].ruleName | type: string | description: applicable when violated_rule=OTHER
323
+ - name: checkout.calculationErrors.couponCalculationError.validationError.fieldViolations[].violatedRule | type: RuleType | description: none
707
324
  enum: DECIMAL_GT, DECIMAL_GTE, DECIMAL_LT, DECIMAL_LTE, DECIMAL_MAX_SCALE, EXACT_LENGTH, EXACT_SIZE, FIELD_NOT_ALLOWED, FORMAT, INVALID_ENUM_VALUE, MAX, MAX_LENGTH, MAX_SIZE, MIN, MIN_LENGTH, MIN_SIZE, ONE_OF_ALIGNMENT, OTHER, REQUIRED_FIELD, REQUIRED_ONE_OF_FIELD, VALIDATION
708
- - name: checkout.calculationErrors.discountsCalculationError | type: Details | description: Discount Rule calculation error.
709
- - name: checkout.calculationErrors.giftCardCalculationError | type: Details | description: Gift card calculation error.
710
- - name: checkout.calculationErrors.membershipError | type: Details | description: Membership payment methods calculation errors For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid
711
- - name: checkout.calculationErrors.orderValidationErrors | type: Array<ApplicationError> | description: Order validation errors.
712
- - name: checkout.calculationErrors.taxCalculationError | type: Details | description: Tax calculation error.
713
- - ONE-OF:
714
- - name: checkout.calculationErrors.carrierErrors | type: CarrierErrors | description: Carrier errors.
715
- - name: checkout.calculationErrors.carrierErrors.errors | type: Array<CarrierError> | description: Carrier errors.
716
- - name: checkout.calculationErrors.carrierErrors.errors[].carrierId | type: string | description: Carrier GUID.
717
- - name: checkout.calculationErrors.carrierErrors.errors[].error | type: Details | description: Error details.
718
- - name: checkout.calculationErrors.generalShippingCalculationError | type: Details | description: General shipping calculation error.
719
- - name: checkout.cartId | type: string | description: Cart GUID that this checkout was created from. Empty if this checkout wasn't created from a cart.
720
- - name: checkout.channelType | type: ChannelType | description: Sales channel that submitted the order.
721
- enum:
325
+ - name: checkout.calculationErrors.discountsCalculationError | type: Details | description: Discount Rule calculation error.
326
+ - name: checkout.calculationErrors.giftCardCalculationError | type: Details | description: Gift card calculation error.
327
+ - name: checkout.calculationErrors.membershipError | type: Details | description: Membership payment methods calculation errors For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid
328
+ - name: checkout.calculationErrors.orderValidationErrors | type: Array<ApplicationError> | description: Order validation errors.
329
+ - name: checkout.calculationErrors.taxCalculationError | type: Details | description: Tax calculation error.
330
+ - ONE-OF:
331
+ - name: checkout.calculationErrors.carrierErrors | type: CarrierErrors | description: Carrier errors.
332
+ - name: checkout.calculationErrors.carrierErrors.errors | type: Array<CarrierError> | description: Carrier errors.
333
+ - name: checkout.calculationErrors.carrierErrors.errors[].carrierId | type: string | description: Carrier GUID.
334
+ - name: checkout.calculationErrors.carrierErrors.errors[].error | type: Details | description: Error details.
335
+ - name: checkout.calculationErrors.generalShippingCalculationError | type: Details | description: General shipping calculation error.
336
+ - name: checkout.cartId | type: string | description: Cart GUID that this checkout was created from. Empty if this checkout wasn't created from a cart.
337
+ - name: checkout.channelType | type: ChannelType | description: Sales channel that submitted the order.
338
+ enum:
722
339
  AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop).
723
340
  BACKOFFICE_MERCHANT: Wix merchant backoffice.
724
341
  CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass).
@@ -736,263 +353,263 @@ Return type: PROMISE<AddToCheckoutResponse>
736
353
  WISH: Wish sales channel.
737
354
  WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview).
738
355
  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)
739
- - name: checkout.completed | type: boolean | description: Whether an order was successfully created from this checkout. For an order to be successful, it must be successfully paid for (unless the total is 0).
740
- - name: checkout.conversionCurrency | type: string | description: The currency [selected by the customer](https://support.wix.com/en/article/multicurrency-an-overview) during the purchase flow, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. This reflects the customer’s preferred display currency and may differ from the site’s default currency. When no specific currency is selected by the customer, this matches the `currency` property.
741
- - name: checkout.createdBy | type: CreatedBy | description: GUID of the checkout's initiator.
742
- - ONE-OF:
743
- - name: checkout.createdBy.appId | type: string | description: App GUID. When the order was created by an external application or Wix service.
744
- - name: checkout.createdBy.memberId | type: string | description: Member GUID. When the order was created by a **logged in** site visitor.
745
- - name: checkout.createdBy.userId | type: string | description: User GUID. When the order was created by a Wix user on behalf of a buyer. For example, via POS (point of service).
746
- - name: checkout.createdBy.visitorId | type: string | description: Visitor GUID. When the order was created by a site visitor that was **not** logged in.
747
- - name: checkout.currency | type: string | description: The site’s default currency, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. This represents the base currency configured for the site and remains constant regardless of the customer’s currency selection.
748
- - name: checkout.customContentReference | type: CustomContentReference | description: Reference GUIDs for the app and component providing custom checkout page content. 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).
749
- - name: checkout.customContentReference.appId | type: string | description: GUID of the app providing the content. You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
750
- - name: checkout.customContentReference.componentId | type: string | description: GUID of the component within the app it belongs to. You can get your component's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
751
- - name: checkout.customFields | type: Array<CustomField> | description: Custom fields.
752
- - name: checkout.customFields[].title | type: string | description: Custom field title.
753
- - name: checkout.customFields[].translatedTitle | type: string | description: Translated custom field title.
754
- - name: checkout.customFields[].value | type: any | description: Custom field value.
755
- - name: checkout.customSettings | type: CustomSettings | description: Additional settings for customization of the checkout process. > **Notes:** > * Custom settings can only be set when creating a checkout. > * 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).
756
- - name: checkout.customSettings.disabledManualPayment | type: boolean | description: Whether to disable manual payment option for this checkout. Default: `false`
757
- - name: checkout.customSettings.disabledPolicyAgreementCheckbox | type: boolean | description: Whether to disable policy agreement checkout in the checkout page Default: `false`
758
- - name: checkout.customSettings.lockCouponCode | type: boolean | description: Whether to restrict the option to add or remove a coupon code on the checkout page. Default: `false`
759
- - name: checkout.customSettings.lockGiftCard | type: boolean | description: Whether to restrict the option to add or remove a gift card on the checkout page. Default: `false`
760
- - name: checkout.extendedFields | type: ExtendedFields | description: Custom field data for the checkout object. [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.
761
- - name: checkout.extendedFields.namespaces | type: Record<string, undefined> | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
762
- - name: checkout.externalReference | type: ExternalReference | description: References to an external app and resource associated with this checkout. Used for integration and tracking across different platforms.
763
- - name: checkout.externalReference.appId | type: string | description: GUID of the app associated with the purchase flow. For example, the Wix Pay Links app GUID.
764
- - name: checkout.externalReference.resourceId | type: string | description: Reference to an external resource GUID. Used to link the purchase flow to a specific entity in an external system. For example, a Wix Pay Link GUID.
765
- - name: checkout.giftCard | type: GiftCard | description: Applied gift card details. >**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).
766
- - name: checkout.giftCard.amount | type: MultiCurrencyPrice | description: Actual amount to be redeemed from the gift card.
767
- - name: checkout.giftCard.appId | type: string | description: App GUID of the gift card provider.
768
- - name: checkout.giftCard.externalId | type: string | description: External GUID in the gift card provider's system. Used for integration and tracking across different platforms.
769
- - name: checkout.giftCard.obfuscatedCode | type: string | description: Gift card obfuscated code.
770
- - name: checkout.giftCard.requestedAmount | type: MultiCurrencyPrice | description: Requested amount to redeem from the gift card.
771
- - name: checkout.lineItems | type: Array<LineItem> | description: Line items. Max: 300 items
772
- - name: checkout.lineItems[]._id | type: string | description: Line item GUID.
773
- - name: checkout.lineItems[].availability | type: ItemAvailabilityInfo | description: Item availability details.
774
- - name: checkout.lineItems[].availability.quantityAvailable | type: number | description: Quantity available.
775
- - name: checkout.lineItems[].availability.status | type: ItemAvailabilityStatus | description: Item availability status.
356
+ - name: checkout.completed | type: boolean | description: Whether an order was successfully created from this checkout. For an order to be successful, it must be successfully paid for (unless the total is 0).
357
+ - name: checkout.conversionCurrency | type: string | description: The currency [selected by the customer](https://support.wix.com/en/article/multicurrency-an-overview) during the purchase flow, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. This reflects the customer’s preferred display currency and may differ from the site’s default currency. When no specific currency is selected by the customer, this matches the `currency` property.
358
+ - name: checkout.createdBy | type: CreatedBy | description: GUID of the checkout's initiator.
359
+ - ONE-OF:
360
+ - name: checkout.createdBy.appId | type: string | description: App GUID. When the order was created by an external application or Wix service.
361
+ - name: checkout.createdBy.memberId | type: string | description: Member GUID. When the order was created by a **logged in** site visitor.
362
+ - name: checkout.createdBy.userId | type: string | description: User GUID. When the order was created by a Wix user on behalf of a buyer. For example, via POS (point of service).
363
+ - name: checkout.createdBy.visitorId | type: string | description: Visitor GUID. When the order was created by a site visitor that was **not** logged in.
364
+ - name: checkout.currency | type: string | description: The site’s default currency, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. This represents the base currency configured for the site and remains constant regardless of the customer’s currency selection.
365
+ - name: checkout.customContentReference | type: CustomContentReference | description: Reference GUIDs for the app and component providing custom checkout page content. 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).
366
+ - name: checkout.customContentReference.appId | type: string | description: GUID of the app providing the content. You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
367
+ - name: checkout.customContentReference.componentId | type: string | description: GUID of the component within the app it belongs to. You can get your component's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
368
+ - name: checkout.customFields | type: Array<CustomField> | description: Custom fields.
369
+ - name: checkout.customFields[].title | type: string | description: Custom field title.
370
+ - name: checkout.customFields[].translatedTitle | type: string | description: Translated custom field title.
371
+ - name: checkout.customFields[].value | type: any | description: Custom field value.
372
+ - name: checkout.customSettings | type: CustomSettings | description: Additional settings for customization of the checkout process. > **Notes:** > * Custom settings can only be set when creating a checkout. > * 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).
373
+ - name: checkout.customSettings.disabledManualPayment | type: boolean | description: Whether to disable manual payment option for this checkout. Default: `false`
374
+ - name: checkout.customSettings.disabledPolicyAgreementCheckbox | type: boolean | description: Whether to disable policy agreement checkout in the checkout page Default: `false`
375
+ - name: checkout.customSettings.lockCouponCode | type: boolean | description: Whether to restrict the option to add or remove a coupon code on the checkout page. Default: `false`
376
+ - name: checkout.customSettings.lockGiftCard | type: boolean | description: Whether to restrict the option to add or remove a gift card on the checkout page. Default: `false`
377
+ - name: checkout.extendedFields | type: ExtendedFields | description: Custom field data for the checkout object. [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.
378
+ - name: checkout.extendedFields.namespaces | type: Record<string, undefined> | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
379
+ - name: checkout.externalReference | type: ExternalReference | description: References to an external app and resource associated with this checkout. Used for integration and tracking across different platforms.
380
+ - name: checkout.externalReference.appId | type: string | description: GUID of the app associated with the purchase flow. For example, the Wix Pay Links app GUID.
381
+ - name: checkout.externalReference.resourceId | type: string | description: Reference to an external resource GUID. Used to link the purchase flow to a specific entity in an external system. For example, a Wix Pay Link GUID.
382
+ - name: checkout.giftCard | type: GiftCard | description: Applied gift card details. >**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).
383
+ - name: checkout.giftCard.amount | type: MultiCurrencyPrice | description: Actual amount to be redeemed from the gift card.
384
+ - name: checkout.giftCard.appId | type: string | description: App GUID of the gift card provider.
385
+ - name: checkout.giftCard.externalId | type: string | description: External GUID in the gift card provider's system. Used for integration and tracking across different platforms.
386
+ - name: checkout.giftCard.obfuscatedCode | type: string | description: Gift card obfuscated code.
387
+ - name: checkout.giftCard.requestedAmount | type: MultiCurrencyPrice | description: Requested amount to redeem from the gift card.
388
+ - name: checkout.lineItems | type: Array<LineItem> | description: Line items. Max: 300 items
389
+ - name: checkout.lineItems[]._id | type: string | description: Line item GUID.
390
+ - name: checkout.lineItems[].availability | type: ItemAvailabilityInfo | description: Item availability details.
391
+ - name: checkout.lineItems[].availability.quantityAvailable | type: number | description: Quantity available.
392
+ - name: checkout.lineItems[].availability.status | type: ItemAvailabilityStatus | description: Item availability status.
776
393
  enum: AVAILABLE, NOT_AVAILABLE: Item is not in stock.
777
394
  NOT_FOUND: Item does not exist.
778
395
  PARTIALLY_AVAILABLE: Available quantity is less than requested.
779
- - name: checkout.lineItems[].catalogOverrideFields | type: CatalogOverrideFields | description: Overriding values for catalog item properties. To override catalog fields, 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).
780
- - name: checkout.lineItems[].catalogOverrideFields.depositAmount | type: string | description: Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
781
- - name: checkout.lineItems[].catalogOverrideFields.descriptionLines | type: Array<DescriptionLine> | description: Item description lines. Used when displaying the line item to customers.
782
- - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].name | type: DescriptionLineName | description: Description line name.
783
- - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].name.original | type: string | description: 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).
784
- - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].name.translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`.
785
- - ONE-OF:
786
- - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].colorInfo | type: Color | description: Description line color value.
787
- - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].colorInfo.code | type: string | description: HEX or RGB color code for display.
788
- - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].colorInfo.original | type: string | description: 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).
789
- - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].colorInfo.translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`.
790
- - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].plainText | type: PlainTextValue | description: Description line plain text value.
791
- - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].plainText.original | type: string | description: 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).
792
- - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].plainText.translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`.
793
- - ONE-OF:
794
- - name: checkout.lineItems[].catalogOverrideFields.fullPrice | type: string | description: Item price **before** discounts.
795
- - name: checkout.lineItems[].catalogOverrideFields.image | type: string | description: Item image.
796
- - name: checkout.lineItems[].catalogOverrideFields.paymentOption | type: PaymentOption | description: Payment method selected for the item.
797
- - name: checkout.lineItems[].catalogOverrideFields.paymentOption.value | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
798
- enum:
396
+ - name: checkout.lineItems[].catalogOverrideFields | type: CatalogOverrideFields | description: Overriding values for catalog item properties. To override catalog fields, 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).
397
+ - name: checkout.lineItems[].catalogOverrideFields.depositAmount | type: string | description: Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`.
398
+ - name: checkout.lineItems[].catalogOverrideFields.descriptionLines | type: Array<DescriptionLine> | description: Item description lines. Used when displaying the line item to customers.
399
+ - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].name | type: DescriptionLineName | description: Description line name.
400
+ - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].name.original | type: string | description: 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).
401
+ - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].name.translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`.
402
+ - ONE-OF:
403
+ - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].colorInfo | type: Color | description: Description line color value.
404
+ - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].colorInfo.code | type: string | description: HEX or RGB color code for display.
405
+ - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].colorInfo.original | type: string | description: 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).
406
+ - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].colorInfo.translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`.
407
+ - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].plainText | type: PlainTextValue | description: Description line plain text value.
408
+ - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].plainText.original | type: string | description: 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).
409
+ - name: checkout.lineItems[].catalogOverrideFields.descriptionLines[].plainText.translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`.
410
+ - ONE-OF:
411
+ - name: checkout.lineItems[].catalogOverrideFields.fullPrice | type: string | description: Item price **before** discounts.
412
+ - name: checkout.lineItems[].catalogOverrideFields.image | type: string | description: Item image.
413
+ - name: checkout.lineItems[].catalogOverrideFields.paymentOption | type: PaymentOption | description: Payment method selected for the item.
414
+ - name: checkout.lineItems[].catalogOverrideFields.paymentOption.value | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
415
+ enum:
799
416
  DEPOSIT_ONLINE: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`.
800
417
  FULL_PAYMENT_OFFLINE: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods.
801
418
  FULL_PAYMENT_ONLINE: The entire payment for this item happens as part of the checkout.
802
419
  MEMBERSHIP: Payment for this item is done by charging a membership. Any remaining amount not covered by the membership, such as item modifiers, is paid online.
803
420
  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`.
804
421
  MEMBERSHIP_ONLINE_WITH_OFFLINE_REMAINDER: Item price is charged to online membership. Any remaining amount not covered by the membership, such as item modifiers, is paid offline.
805
- - name: checkout.lineItems[].catalogOverrideFields.physicalProperties | type: PhysicalProperties | description: Physical properties of the item.
806
- - name: checkout.lineItems[].catalogOverrideFields.physicalProperties.shippable | type: boolean | description: Whether this line item is shippable.
807
- - name: checkout.lineItems[].catalogOverrideFields.physicalProperties.sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
808
- - name: checkout.lineItems[].catalogOverrideFields.physicalProperties.weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
809
- - name: checkout.lineItems[].catalogOverrideFields.price | type: string | description: Item price **after** discounts.
810
- - name: checkout.lineItems[].catalogOverrideFields.productName | type: ProductName | description: Item name.
811
- - name: checkout.lineItems[].catalogOverrideFields.productName.original | type: string | description: __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). Min: 1 character. Max: 200 characters.
812
- - name: checkout.lineItems[].catalogOverrideFields.productName.translated | type: string | description: Item name translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
813
- - name: checkout.lineItems[].catalogOverrideFields.savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false`
422
+ - name: checkout.lineItems[].catalogOverrideFields.physicalProperties | type: PhysicalProperties | description: Physical properties of the item.
423
+ - name: checkout.lineItems[].catalogOverrideFields.physicalProperties.shippable | type: boolean | description: Whether this line item is shippable.
424
+ - name: checkout.lineItems[].catalogOverrideFields.physicalProperties.sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
425
+ - name: checkout.lineItems[].catalogOverrideFields.physicalProperties.weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
426
+ - name: checkout.lineItems[].catalogOverrideFields.price | type: string | description: Item price **after** discounts.
427
+ - name: checkout.lineItems[].catalogOverrideFields.productName | type: ProductName | description: Item name.
428
+ - name: checkout.lineItems[].catalogOverrideFields.productName.original | type: string | description: __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). Min: 1 character. Max: 200 characters.
429
+ - name: checkout.lineItems[].catalogOverrideFields.productName.translated | type: string | description: Item name translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
430
+ - name: checkout.lineItems[].catalogOverrideFields.savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false`
814
431
  - name: checkout.lineItems[].catalogReference | type: CatalogReference | description: Catalog and item reference. Includes GUIDs 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. | required: true
815
- - name: checkout.lineItems[].catalogReference.appId | type: string | description: GUID of the app providing the catalog. You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). For items from Wix catalogs, the following values always apply: + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"` + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"` + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
816
- - name: checkout.lineItems[].catalogReference.catalogItemId | type: string | description: GUID of the item within the catalog it belongs to.
817
- - name: checkout.lineItems[].catalogReference.options | type: Record<string, any> | description: 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. For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
818
- - name: checkout.lineItems[].consentRequiredPaymentPolicy | type: string | description: Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
819
- - name: checkout.lineItems[].customLineItem | type: boolean | description: Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
820
- - name: checkout.lineItems[].deliveryProfileId | type: string | description: Delivery profile GUID.
821
- - name: checkout.lineItems[].depositAmount | type: MultiCurrencyPrice | description: Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
822
- - name: checkout.lineItems[].descriptionLines | type: Array<DescriptionLine> | description: Line item description lines. Used for display purposes for the cart, checkout and order.
823
- - name: checkout.lineItems[].discount | type: MultiCurrencyPrice | description: Discount for this line item's entire quantity.
824
- - name: checkout.lineItems[].extendedFields | type: ExtendedFields | description: Custom extended fields for the line item object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured using the 'Checkout & Orders - Line Items Schema Plugin' in the app dashboard before they can be accessed with API calls.
825
- - name: checkout.lineItems[].fixedQuantity | type: boolean | description: Whether the line item quantity is fixed and cannot be changed.
826
- - name: checkout.lineItems[].fullPrice | type: MultiCurrencyPrice | description: Item price **before** catalog-defined discount. Defaults to `price` when not provided.
827
- - name: checkout.lineItems[].itemType | type: ItemType | description: Item type. Either a preset type or custom.
828
- - ONE-OF:
829
- - name: checkout.lineItems[].itemType.custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type.
830
- - name: checkout.lineItems[].itemType.preset | type: ItemTypePreset | description: Preset item type.
432
+ - name: checkout.lineItems[].catalogReference.appId | type: string | description: GUID of the app providing the catalog. You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). For items from Wix catalogs, the following values always apply: + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"` + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"` + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
433
+ - name: checkout.lineItems[].catalogReference.catalogItemId | type: string | description: GUID of the item within the catalog it belongs to.
434
+ - name: checkout.lineItems[].catalogReference.options | type: Record<string, any> | description: 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. For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
435
+ - name: checkout.lineItems[].consentRequiredPaymentPolicy | type: string | description: Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
436
+ - name: checkout.lineItems[].customLineItem | type: boolean | description: Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
437
+ - name: checkout.lineItems[].deliveryProfileId | type: string | description: Delivery profile GUID.
438
+ - name: checkout.lineItems[].depositAmount | type: MultiCurrencyPrice | description: Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
439
+ - name: checkout.lineItems[].descriptionLines | type: Array<DescriptionLine> | description: Line item description lines. Used for display purposes for the cart, checkout and order.
440
+ - name: checkout.lineItems[].discount | type: MultiCurrencyPrice | description: Discount for this line item's entire quantity.
441
+ - name: checkout.lineItems[].extendedFields | type: ExtendedFields | description: Custom extended fields for the line item object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured using the 'Checkout & Orders - Line Items Schema Plugin' in the app dashboard before they can be accessed with API calls.
442
+ - name: checkout.lineItems[].fixedQuantity | type: boolean | description: Whether the line item quantity is fixed and cannot be changed.
443
+ - name: checkout.lineItems[].fullPrice | type: MultiCurrencyPrice | description: Item price **before** catalog-defined discount. Defaults to `price` when not provided.
444
+ - name: checkout.lineItems[].itemType | type: ItemType | description: Item type. Either a preset type or custom.
445
+ - ONE-OF:
446
+ - name: checkout.lineItems[].itemType.custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type.
447
+ - name: checkout.lineItems[].itemType.preset | type: ItemTypePreset | description: Preset item type.
831
448
  enum: DIGITAL, GIFT_CARD, PHYSICAL, SERVICE, UNRECOGNISED
832
- - name: checkout.lineItems[].lineItemPrice | type: MultiCurrencyPrice | description: Total line item price **after** catalog-defined discount and line item discounts.
833
- - name: checkout.lineItems[].media | type: string | description: Line item image details.
834
- - name: checkout.lineItems[].membersOnly | type: boolean | description: Whether the item can only be purchased by site members. Default: `false`
835
- - name: checkout.lineItems[].modifierGroups | type: Array<ModifierGroup> | description: Modifier groups that were added to the item.
836
- - name: checkout.lineItems[].modifierGroups[]._id | type: string | description: Modifier group GUID.
837
- - name: checkout.lineItems[].modifierGroups[].modifiers | type: Array<ItemModifier> | description: List of modifiers in this group.
838
- - name: checkout.lineItems[].modifierGroups[].modifiers[]._id | type: string | description: Modifier GUID.
839
- - name: checkout.lineItems[].modifierGroups[].modifiers[].details | type: TranslatableString | description: Additional details.
840
- - name: checkout.lineItems[].modifierGroups[].modifiers[].details.original | type: string | description: __Required.__ String 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). Min: 1 character. Max: 200 characters.
841
- - name: checkout.lineItems[].modifierGroups[].modifiers[].details.translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
842
- - name: checkout.lineItems[].modifierGroups[].modifiers[].label | type: TranslatableString | description: Primary display label for the modifier.
843
- - name: checkout.lineItems[].modifierGroups[].modifiers[].price | type: MultiCurrencyPrice | description: The price of the modifier.
844
- - name: checkout.lineItems[].modifierGroups[].modifiers[].quantity | type: number | description: The quantity of this modifier.
845
- - name: checkout.lineItems[].modifierGroups[].name | type: TranslatableString | description: Modifier group name.
846
- - name: checkout.lineItems[].modifiersTotalPrice | type: MultiCurrencyPrice | description: Total price of all item modifiers. Included in the item price.
847
- - name: checkout.lineItems[].paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
848
- - name: checkout.lineItems[].physicalProperties | type: PhysicalProperties | description: Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
849
- - name: checkout.lineItems[].policies | type: Array<Policy> | description: Policies to be displayed to the customer on the checkout page.
850
- - name: checkout.lineItems[].policies[].content | type: string | description: Policy content - should be translated
851
- - name: checkout.lineItems[].policies[].title | type: string | description: Policy title - should be translated
852
- - name: checkout.lineItems[].price | type: MultiCurrencyPrice | description: Item price **after** catalog-defined discount and line item discounts.
853
- - name: checkout.lineItems[].priceBeforeDiscounts | type: MultiCurrencyPrice | description: Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided.
854
- - name: checkout.lineItems[].priceDescription | type: PriceDescription | description: Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
855
- - name: checkout.lineItems[].priceDescription.original | type: string | description: __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).
856
- - name: checkout.lineItems[].priceDescription.translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`.
857
- - name: checkout.lineItems[].priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created.
858
- - name: checkout.lineItems[].productName | type: ProductName | description: Item name. + Stores - `product.name` + Bookings - `service.info.name` + Events - `ticket.name`
449
+ - name: checkout.lineItems[].lineItemPrice | type: MultiCurrencyPrice | description: Total line item price **after** catalog-defined discount and line item discounts.
450
+ - name: checkout.lineItems[].media | type: string | description: Line item image details.
451
+ - name: checkout.lineItems[].membersOnly | type: boolean | description: Whether the item can only be purchased by site members. Default: `false`
452
+ - name: checkout.lineItems[].modifierGroups | type: Array<ModifierGroup> | description: Modifier groups that were added to the item.
453
+ - name: checkout.lineItems[].modifierGroups[]._id | type: string | description: Modifier group GUID.
454
+ - name: checkout.lineItems[].modifierGroups[].modifiers | type: Array<ItemModifier> | description: List of modifiers in this group.
455
+ - name: checkout.lineItems[].modifierGroups[].modifiers[]._id | type: string | description: Modifier GUID.
456
+ - name: checkout.lineItems[].modifierGroups[].modifiers[].details | type: TranslatableString | description: Additional details.
457
+ - name: checkout.lineItems[].modifierGroups[].modifiers[].details.original | type: string | description: __Required.__ String 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). Min: 1 character. Max: 200 characters.
458
+ - name: checkout.lineItems[].modifierGroups[].modifiers[].details.translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
459
+ - name: checkout.lineItems[].modifierGroups[].modifiers[].label | type: TranslatableString | description: Primary display label for the modifier.
460
+ - name: checkout.lineItems[].modifierGroups[].modifiers[].price | type: MultiCurrencyPrice | description: The price of the modifier.
461
+ - name: checkout.lineItems[].modifierGroups[].modifiers[].quantity | type: number | description: The quantity of this modifier.
462
+ - name: checkout.lineItems[].modifierGroups[].name | type: TranslatableString | description: Modifier group name.
463
+ - name: checkout.lineItems[].modifiersTotalPrice | type: MultiCurrencyPrice | description: Total price of all item modifiers. Included in the item price.
464
+ - name: checkout.lineItems[].paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
465
+ - name: checkout.lineItems[].physicalProperties | type: PhysicalProperties | description: Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
466
+ - name: checkout.lineItems[].policies | type: Array<Policy> | description: Policies to be displayed to the customer on the checkout page.
467
+ - name: checkout.lineItems[].policies[].content | type: string | description: Policy content - should be translated
468
+ - name: checkout.lineItems[].policies[].title | type: string | description: Policy title - should be translated
469
+ - name: checkout.lineItems[].price | type: MultiCurrencyPrice | description: Item price **after** catalog-defined discount and line item discounts.
470
+ - name: checkout.lineItems[].priceBeforeDiscounts | type: MultiCurrencyPrice | description: Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided.
471
+ - name: checkout.lineItems[].priceDescription | type: PriceDescription | description: Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
472
+ - name: checkout.lineItems[].priceDescription.original | type: string | description: __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).
473
+ - name: checkout.lineItems[].priceDescription.translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`.
474
+ - name: checkout.lineItems[].priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created.
475
+ - name: checkout.lineItems[].productName | type: ProductName | description: Item name. + Stores - `product.name` + Bookings - `service.info.name` + Events - `ticket.name`
859
476
  - name: checkout.lineItems[].quantity | type: number | description: Item quantity. Min: `"1"` Max: `"100000"` | required: true
860
- - name: checkout.lineItems[].rootCatalogItemId | type: string | description: In cases where `catalogReference.catalogItemId` is NOT the actual catalog item GUID, this field will return the true item's GUID. + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking GUID. Therefore this value is set to the service GUID. + In most cases, this field has the same value as `catalogReference.catalogItemId`. + Used in membership validation.
861
- - name: checkout.lineItems[].savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false`
862
- - name: checkout.lineItems[].serviceProperties | type: ServiceProperties | description: Service properties. When relevant, this contains information such as date and number of participants.
863
- - name: checkout.lineItems[].serviceProperties.numberOfParticipants | type: number | description: 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.
864
- - name: checkout.lineItems[].serviceProperties.scheduledDate | type: Date | description: 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. For example, the start time of a class.
865
- - name: checkout.lineItems[].subscriptionOptionInfo | type: SubscriptionOptionInfo | description: Subscription option information.
866
- - name: checkout.lineItems[].subscriptionOptionInfo.description | type: Description | description: Subscription option description.
867
- - name: checkout.lineItems[].subscriptionOptionInfo.description.original | type: string | description: Subscription option description.
868
- - name: checkout.lineItems[].subscriptionOptionInfo.description.translated | type: string | description: Translated subscription option description.
869
- - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings | type: SubscriptionSettings | description: Subscription option settings.
870
- - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.autoRenewal | type: boolean | description: Whether subscription is renewed automatically at the end of each period.
871
- - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.billingCycles | type: number | description: Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
872
- - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation | type: boolean | description: Whether to allow the customer to cancel the subscription..
873
- - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod | type: FreeTrialPeriod | description: Period until first cycle starts. If applied payNow will be 0 If None => no free trial
874
- - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod.frequency | type: SubscriptionFrequency | description: Frequency of period. Values: DAY, WEEK, MONTH, YEAR
477
+ - name: checkout.lineItems[].rootCatalogItemId | type: string | description: In cases where `catalogReference.catalogItemId` is NOT the actual catalog item GUID, this field will return the true item's GUID. + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking GUID. Therefore this value is set to the service GUID. + In most cases, this field has the same value as `catalogReference.catalogItemId`. + Used in membership validation.
478
+ - name: checkout.lineItems[].savePaymentMethod | type: boolean | description: Whether to save the payment method on the order. Default: `false`
479
+ - name: checkout.lineItems[].serviceProperties | type: ServiceProperties | description: Service properties. When relevant, this contains information such as date and number of participants.
480
+ - name: checkout.lineItems[].serviceProperties.numberOfParticipants | type: number | description: 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.
481
+ - name: checkout.lineItems[].serviceProperties.scheduledDate | type: Date | description: 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. For example, the start time of a class.
482
+ - name: checkout.lineItems[].subscriptionOptionInfo | type: SubscriptionOptionInfo | description: Subscription option information.
483
+ - name: checkout.lineItems[].subscriptionOptionInfo.description | type: Description | description: Subscription option description.
484
+ - name: checkout.lineItems[].subscriptionOptionInfo.description.original | type: string | description: Subscription option description.
485
+ - name: checkout.lineItems[].subscriptionOptionInfo.description.translated | type: string | description: Translated subscription option description.
486
+ - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings | type: SubscriptionSettings | description: Subscription option settings.
487
+ - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.autoRenewal | type: boolean | description: Whether subscription is renewed automatically at the end of each period.
488
+ - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.billingCycles | type: number | description: Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
489
+ - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation | type: boolean | description: Whether to allow the customer to cancel the subscription..
490
+ - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod | type: FreeTrialPeriod | description: Period until first cycle starts. If applied payNow will be 0 If None => no free trial
491
+ - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod.frequency | type: SubscriptionFrequency | description: Frequency of period. Values: DAY, WEEK, MONTH, YEAR
875
492
  enum: DAY, MONTH, UNDEFINED, WEEK, YEAR
876
- - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod.interval | type: number | description: interval of period
877
- - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.frequency | type: SubscriptionFrequency | description: Frequency of recurring payment.
878
- - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.interval | type: number | description: Interval of recurring payment. Default: `1`. If SubscriptionFrequency is Day the minimum interval is 7
879
- - name: checkout.lineItems[].subscriptionOptionInfo.title | type: Title | description: Subscription option title.
880
- - name: checkout.lineItems[].subscriptionOptionInfo.title.original | type: string | description: 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).
881
- - name: checkout.lineItems[].subscriptionOptionInfo.title.translated | type: string | description: Subscription option name translated into the buyer's language. Default: Same as `original`.
882
- - name: checkout.lineItems[].taxDetails | type: ItemTaxFullDetails | description: Tax details for this line item.
883
- - name: checkout.lineItems[].taxableAddress | type: TaxableAddress | description: Address to use for tax calculation purposes.
884
- - ONE-OF:
885
- - name: checkout.lineItems[].taxableAddress.addressType | type: TaxableAddressType | description: taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly.
493
+ - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod.interval | type: number | description: interval of period
494
+ - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.frequency | type: SubscriptionFrequency | description: Frequency of recurring payment.
495
+ - name: checkout.lineItems[].subscriptionOptionInfo.subscriptionSettings.interval | type: number | description: Interval of recurring payment. Default: `1`. If SubscriptionFrequency is Day the minimum interval is 7
496
+ - name: checkout.lineItems[].subscriptionOptionInfo.title | type: Title | description: Subscription option title.
497
+ - name: checkout.lineItems[].subscriptionOptionInfo.title.original | type: string | description: 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).
498
+ - name: checkout.lineItems[].subscriptionOptionInfo.title.translated | type: string | description: Subscription option name translated into the buyer's language. Default: Same as `original`.
499
+ - name: checkout.lineItems[].taxDetails | type: ItemTaxFullDetails | description: Tax details for this line item.
500
+ - name: checkout.lineItems[].taxableAddress | type: TaxableAddress | description: Address to use for tax calculation purposes.
501
+ - ONE-OF:
502
+ - name: checkout.lineItems[].taxableAddress.addressType | type: TaxableAddressType | description: taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly.
886
503
  enum: BILLING, BUSINESS, SHIPPING, UNKNOWN_TAXABLE_ADDRESS
887
- - name: checkout.lineItems[].totalPriceAfterTax | type: MultiCurrencyPrice | description: Total price after all discounts and tax.
888
- - name: checkout.lineItems[].totalPriceBeforeTax | type: MultiCurrencyPrice | description: Total price after discounts, and before tax.
889
- - name: checkout.lineItems[].url | type: string | description: URL to the item's page on the site.
890
- - name: checkout.membershipOptions | type: MembershipOptions | description: Memberships to apply when creating the order.
891
- - name: checkout.membershipOptions.eligibleMemberships | type: Array<Membership> | description: Reserved for internal use.
892
- - name: checkout.membershipOptions.eligibleMemberships[]._id | type: string | description: Membership GUID.
893
- - name: checkout.membershipOptions.eligibleMemberships[].additionalData | type: Record<string, any> | description: Additional data about this membership.
894
- - name: checkout.membershipOptions.eligibleMemberships[].appId | type: string | description: GUID of the application providing this payment option.
895
- - name: checkout.membershipOptions.eligibleMemberships[].credits | type: MembershipPaymentCredits | description: Optional - For a membership that has limited credits, information about credit usage.
896
- - name: checkout.membershipOptions.eligibleMemberships[].credits.remaining | type: number | description: Membership's remaining amount of credits.
897
- - name: checkout.membershipOptions.eligibleMemberships[].credits.total | type: number | description: Membership's total amount of credits.
898
- - name: checkout.membershipOptions.eligibleMemberships[].expirationDate | type: Date | description: Optional - TMembership expiry date.
899
- - name: checkout.membershipOptions.eligibleMemberships[].lineItemIds | type: Array<string> | description: Line item GUIDs which are "paid" for by this membership.
900
- - name: checkout.membershipOptions.eligibleMemberships[].name | type: MembershipName | description: The name of this membership.
901
- - name: checkout.membershipOptions.eligibleMemberships[].name.original | type: string | description: Membership name.
902
- - name: checkout.membershipOptions.eligibleMemberships[].name.translated | type: string | description: Translated membership name. Defaults to `original` when not provided.
903
- - name: checkout.membershipOptions.invalidMemberships | type: Array<InvalidMembership> | description: Reserved for internal use.
904
- - name: checkout.membershipOptions.invalidMemberships[].membership | type: Membership | description: Membership details.
905
- - name: checkout.membershipOptions.invalidMemberships[].reason | type: string | description: Reason why this membership is invalid and cannot be used.
906
- - name: checkout.membershipOptions.selectedMemberships | type: SelectedMemberships | description: Selected membership to apply to this checkout.
907
- - name: checkout.membershipOptions.selectedMemberships.memberships | type: Array<SelectedMembership> | description: Selected memberships.
908
- - name: checkout.membershipOptions.selectedMemberships.memberships[]._id | type: string | description: Membership GUID.
909
- - name: checkout.membershipOptions.selectedMemberships.memberships[].appId | type: string | description: GUID of the app providing this payment option.
910
- - name: checkout.membershipOptions.selectedMemberships.memberships[].lineItemIds | type: Array<string> | description: IDs of the line items this membership applies to.
911
- - name: checkout.payAfterFreeTrial | type: PriceSummary | description: Payment for subscriptions after free trial period.
912
- - name: checkout.payAfterFreeTrial.additionalFees | type: MultiCurrencyPrice | description: Total additional fees price before tax.
913
- - name: checkout.payAfterFreeTrial.discount | type: MultiCurrencyPrice | description: Total calculated discount value.
914
- - name: checkout.payAfterFreeTrial.shipping | type: MultiCurrencyPrice | description: Total shipping price, before discounts and before tax.
915
- - name: checkout.payAfterFreeTrial.subtotal | type: MultiCurrencyPrice | description: Subtotal of all line items, before discounts and before tax.
916
- - name: checkout.payAfterFreeTrial.tax | type: MultiCurrencyPrice | description: Total tax.
917
- - name: checkout.payAfterFreeTrial.total | type: MultiCurrencyPrice | description: Total price after discounts, gift cards, and tax.
918
- - name: checkout.payLater | type: PriceSummary | description: Remaining amount for the order to be fully paid.
919
- - name: checkout.payNow | type: PriceSummary | description: Minimal amount to pay in order to place the order.
920
- - name: checkout.paymentCurrency | type: string | description: The currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. This is determined by the [customer's selected currency](https://support.wix.com/en/article/multicurrency-an-overview) and the site’s supported payment currencies. If the customer’s selected currency is supported for payment, this matches the `conversionCurrency` property. If not supported, this falls back to the `currency` property.
921
- - name: checkout.priceSummary | type: PriceSummary | description: Calculated price summary for the checkout.
922
- - name: checkout.purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order.
923
- - name: checkout.shippingInfo | type: ShippingInfo | description: Shipping information.
924
- - name: checkout.shippingInfo.carrierServiceOptions | type: Array<CarrierServiceOption> | description: All carrier options for this shipping rule.
925
- - name: checkout.shippingInfo.carrierServiceOptions[].carrierId | type: string | description: Carrier GUID.
926
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions | type: Array<ShippingOption> | description: Shipping options offered by this carrier for this request.
927
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].code | type: string | description: Unique code of provided shipping option like "usps_std_overnight". For legacy calculators this would be the UUGUID of the option.
928
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].cost | type: ShippingPrice | description: Sipping price information.
929
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].cost.otherCharges | type: Array<OtherCharge> | description: Other costs such as insurance, handling & packaging for fragile items, etc.
930
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].cost.otherCharges[].details | type: string | description: Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
931
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].cost.otherCharges[].price | type: MultiCurrencyPrice | description: Price of added cost.
932
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].cost.otherCharges[].type | type: ChargeType | description: Type of additional cost.
504
+ - name: checkout.lineItems[].totalPriceAfterTax | type: MultiCurrencyPrice | description: Total price after all discounts and tax.
505
+ - name: checkout.lineItems[].totalPriceBeforeTax | type: MultiCurrencyPrice | description: Total price after discounts, and before tax.
506
+ - name: checkout.lineItems[].url | type: string | description: URL to the item's page on the site.
507
+ - name: checkout.membershipOptions | type: MembershipOptions | description: Memberships to apply when creating the order.
508
+ - name: checkout.membershipOptions.eligibleMemberships | type: Array<Membership> | description: Reserved for internal use.
509
+ - name: checkout.membershipOptions.eligibleMemberships[]._id | type: string | description: Membership GUID.
510
+ - name: checkout.membershipOptions.eligibleMemberships[].additionalData | type: Record<string, any> | description: Additional data about this membership.
511
+ - name: checkout.membershipOptions.eligibleMemberships[].appId | type: string | description: GUID of the application providing this payment option.
512
+ - name: checkout.membershipOptions.eligibleMemberships[].credits | type: MembershipPaymentCredits | description: Optional - For a membership that has limited credits, information about credit usage.
513
+ - name: checkout.membershipOptions.eligibleMemberships[].credits.remaining | type: number | description: Membership's remaining amount of credits.
514
+ - name: checkout.membershipOptions.eligibleMemberships[].credits.total | type: number | description: Membership's total amount of credits.
515
+ - name: checkout.membershipOptions.eligibleMemberships[].expirationDate | type: Date | description: Optional - TMembership expiry date.
516
+ - name: checkout.membershipOptions.eligibleMemberships[].lineItemIds | type: Array<string> | description: Line item GUIDs which are "paid" for by this membership.
517
+ - name: checkout.membershipOptions.eligibleMemberships[].name | type: MembershipName | description: The name of this membership.
518
+ - name: checkout.membershipOptions.eligibleMemberships[].name.original | type: string | description: Membership name.
519
+ - name: checkout.membershipOptions.eligibleMemberships[].name.translated | type: string | description: Translated membership name. Defaults to `original` when not provided.
520
+ - name: checkout.membershipOptions.invalidMemberships | type: Array<InvalidMembership> | description: Reserved for internal use.
521
+ - name: checkout.membershipOptions.invalidMemberships[].membership | type: Membership | description: Membership details.
522
+ - name: checkout.membershipOptions.invalidMemberships[].reason | type: string | description: Reason why this membership is invalid and cannot be used.
523
+ - name: checkout.membershipOptions.selectedMemberships | type: SelectedMemberships | description: Selected membership to apply to this checkout.
524
+ - name: checkout.membershipOptions.selectedMemberships.memberships | type: Array<SelectedMembership> | description: Selected memberships.
525
+ - name: checkout.membershipOptions.selectedMemberships.memberships[]._id | type: string | description: Membership GUID.
526
+ - name: checkout.membershipOptions.selectedMemberships.memberships[].appId | type: string | description: GUID of the app providing this payment option.
527
+ - name: checkout.membershipOptions.selectedMemberships.memberships[].lineItemIds | type: Array<string> | description: IDs of the line items this membership applies to.
528
+ - name: checkout.payAfterFreeTrial | type: PriceSummary | description: Payment for subscriptions after free trial period.
529
+ - name: checkout.payAfterFreeTrial.additionalFees | type: MultiCurrencyPrice | description: Total additional fees price before tax.
530
+ - name: checkout.payAfterFreeTrial.discount | type: MultiCurrencyPrice | description: Total calculated discount value.
531
+ - name: checkout.payAfterFreeTrial.shipping | type: MultiCurrencyPrice | description: Total shipping price, before discounts and before tax.
532
+ - name: checkout.payAfterFreeTrial.subtotal | type: MultiCurrencyPrice | description: Subtotal of all line items, before discounts and before tax.
533
+ - name: checkout.payAfterFreeTrial.tax | type: MultiCurrencyPrice | description: Total tax.
534
+ - name: checkout.payAfterFreeTrial.total | type: MultiCurrencyPrice | description: Total price after discounts, gift cards, and tax.
535
+ - name: checkout.payLater | type: PriceSummary | description: Remaining amount for the order to be fully paid.
536
+ - name: checkout.payNow | type: PriceSummary | description: Minimal amount to pay in order to place the order.
537
+ - name: checkout.paymentCurrency | type: string | description: The currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. This is determined by the [customer's selected currency](https://support.wix.com/en/article/multicurrency-an-overview) and the site’s supported payment currencies. If the customer’s selected currency is supported for payment, this matches the `conversionCurrency` property. If not supported, this falls back to the `currency` property.
538
+ - name: checkout.priceSummary | type: PriceSummary | description: Calculated price summary for the checkout.
539
+ - name: checkout.purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order.
540
+ - name: checkout.shippingInfo | type: ShippingInfo | description: Shipping information.
541
+ - name: checkout.shippingInfo.carrierServiceOptions | type: Array<CarrierServiceOption> | description: All carrier options for this shipping rule.
542
+ - name: checkout.shippingInfo.carrierServiceOptions[].carrierId | type: string | description: Carrier GUID.
543
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions | type: Array<ShippingOption> | description: Shipping options offered by this carrier for this request.
544
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].code | type: string | description: Unique code of provided shipping option like "usps_std_overnight". For legacy calculators this would be the UUGUID of the option.
545
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].cost | type: ShippingPrice | description: Sipping price information.
546
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].cost.otherCharges | type: Array<OtherCharge> | description: Other costs such as insurance, handling & packaging for fragile items, etc.
547
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].cost.otherCharges[].details | type: string | description: Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
548
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].cost.otherCharges[].price | type: MultiCurrencyPrice | description: Price of added cost.
549
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].cost.otherCharges[].type | type: ChargeType | description: Type of additional cost.
933
550
  enum: HANDLING_FEE, INSURANCE
934
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].cost.price | type: MultiCurrencyPrice | description: Shipping price.
935
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations | type: Array<DeliveryAllocation> | description: Delivery solution allocations to different delivery carriers and delivery regions
936
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].applicableLineItems | type: ApplicableLineItems | description: Populated if the delivery solution is a partially supplied by this carrier.
937
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].applicableLineItems.lineItemIds | type: Array<string> | description: Line items that the delivery solution is for.
938
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryCarrier | type: Carrier | description: The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers
939
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryCarrier.appId | type: string | description: The carrier app id
940
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryCarrier.code | type: string | description: Unique code that acts as an GUID for a shipping rate. For example, `"usps_std_overnight"`.
941
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryRegion | type: Region | description: The delivery region that are relevant for this delivery solution.
942
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryRegion._id | type: string | description: The delivery region id.
943
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryRegion.name | type: string | description: The delivery region name.
944
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].logistics | type: DeliveryLogistics | description: Delivery logistics.
945
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.deliveryTime | type: string | description: Expected delivery time, in free text. For example, "3-5 business days".
946
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.instructions | type: string | description: Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
947
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.pickupDetails | type: PickupDetails | description: Pickup details.
948
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.pickupDetails.address | type: ApiAddress | description: Pickup address.
949
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.pickupDetails.pickupMethod | type: PickupMethod | description: Pickup method
551
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].cost.price | type: MultiCurrencyPrice | description: Shipping price.
552
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations | type: Array<DeliveryAllocation> | description: Delivery solution allocations to different delivery carriers and delivery regions
553
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].applicableLineItems | type: ApplicableLineItems | description: Populated if the delivery solution is a partially supplied by this carrier.
554
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].applicableLineItems.lineItemIds | type: Array<string> | description: Line items that the delivery solution is for.
555
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryCarrier | type: Carrier | description: The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers
556
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryCarrier.appId | type: string | description: The carrier app id
557
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryCarrier.code | type: string | description: Unique code that acts as an GUID for a shipping rate. For example, `"usps_std_overnight"`.
558
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryRegion | type: Region | description: The delivery region that are relevant for this delivery solution.
559
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryRegion._id | type: string | description: The delivery region id.
560
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryRegion.name | type: string | description: The delivery region name.
561
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].logistics | type: DeliveryLogistics | description: Delivery logistics.
562
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.deliveryTime | type: string | description: Expected delivery time, in free text. For example, "3-5 business days".
563
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.instructions | type: string | description: Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
564
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.pickupDetails | type: PickupDetails | description: Pickup details.
565
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.pickupDetails.address | type: ApiAddress | description: Pickup address.
566
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.pickupDetails.pickupMethod | type: PickupMethod | description: Pickup method
950
567
  enum: PICKUP_POINT, STORE_PICKUP, UNKNOWN_METHOD
951
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].partial | type: boolean | description: If the delivery solution is a partial and doesn't apply to all items.
952
- - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].title | type: string | description: Title of the option, such as USPS Standard Overnight Delivery (in the requested locale). For example, "Standard" or "First-Class Package International".
953
- - name: checkout.shippingInfo.region | type: ShippingRegion | description: Shipping region. Based on the address provided.
954
- - name: checkout.shippingInfo.region._id | type: string | description: Shipping region GUID.
955
- - name: checkout.shippingInfo.region.name | type: string | description: Shipping region name.
956
- - name: checkout.shippingInfo.selectedCarrierServiceOption | type: SelectedCarrierServiceOption | description: Selected option out of the options allowed for the `region`.
957
- - name: checkout.shippingInfo.selectedCarrierServiceOption.carrierId | type: string | description: This carrier's unique GUID
958
- - name: checkout.shippingInfo.selectedCarrierServiceOption.code | type: string | description: Unique identifier of selected option. For example, "usps_std_overnight".
959
- - name: checkout.shippingInfo.selectedCarrierServiceOption.cost | type: SelectedCarrierServiceOptionPrices | description: Shipping costs.
960
- - name: checkout.shippingInfo.selectedCarrierServiceOption.cost.price | type: MultiCurrencyPrice | description: Shipping price before discount and before tax.
961
- - name: checkout.shippingInfo.selectedCarrierServiceOption.cost.taxDetails | type: ItemTaxFullDetails | description: Tax details.
962
- - name: checkout.shippingInfo.selectedCarrierServiceOption.cost.totalDiscount | type: MultiCurrencyPrice | description: Shipping discount before tax.
963
- - name: checkout.shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax | type: MultiCurrencyPrice | description: Total shipping price, after discount and after tax.
964
- - name: checkout.shippingInfo.selectedCarrierServiceOption.cost.totalPriceBeforeTax | type: MultiCurrencyPrice | description: Total price of shipping after discounts (when relevant), and before tax.
965
- - name: checkout.shippingInfo.selectedCarrierServiceOption.deliveryAllocations | type: Array<DeliveryAllocation> | description: Delivery solution allocations to different delivery carriers and delivery regions
966
- - name: checkout.shippingInfo.selectedCarrierServiceOption.logistics | type: DeliveryLogistics | description: Delivery logistics.
967
- - name: checkout.shippingInfo.selectedCarrierServiceOption.partial | type: boolean | description: If the delivery solution is a partial and doesn't apply to all items.
968
- - name: checkout.shippingInfo.selectedCarrierServiceOption.requestedShippingOption | type: boolean | description: Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)
969
- - name: checkout.shippingInfo.selectedCarrierServiceOption.title | type: string | description: Title of the option, such as USPS Standard Overnight Delivery (in the requested locale). For example, "Standard" or "First-Class Package International".
970
- - name: checkout.shippingInfo.shippingDestination | type: AddressWithContact | description: Shipping address and contact details.
971
- - name: checkout.siteLanguage | type: string | description: Site language in which original values are shown.
972
- - name: checkout.taxExemptGroupId | type: string | description: Tax exempt group GUID to use for tax exemptions.
973
- - name: checkout.taxIncludedInPrice | type: boolean | description: Whether tax is included in line item prices.
974
- - name: checkout.taxSummary | type: TaxSummary | description: Tax summary.
975
- - name: checkout.taxSummary.taxableAmount | type: MultiCurrencyPrice | description: Amount for which tax is calculated, added from line items.
976
- - name: checkout.taxSummary.totalTax | type: MultiCurrencyPrice | description: Calculated tax, added from line items.
977
- - name: checkout.violations | type: Array<Violation> | description: List of validation violations raised by the [Validations service plugin](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction).
978
- - name: checkout.violations[].description | type: string | description: 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>`.
979
- - name: checkout.violations[].severity | type: Severity | description: 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.
980
- enum:
568
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].partial | type: boolean | description: If the delivery solution is a partial and doesn't apply to all items.
569
+ - name: checkout.shippingInfo.carrierServiceOptions[].shippingOptions[].title | type: string | description: Title of the option, such as USPS Standard Overnight Delivery (in the requested locale). For example, "Standard" or "First-Class Package International".
570
+ - name: checkout.shippingInfo.region | type: ShippingRegion | description: Shipping region. Based on the address provided.
571
+ - name: checkout.shippingInfo.region._id | type: string | description: Shipping region GUID.
572
+ - name: checkout.shippingInfo.region.name | type: string | description: Shipping region name.
573
+ - name: checkout.shippingInfo.selectedCarrierServiceOption | type: SelectedCarrierServiceOption | description: Selected option out of the options allowed for the `region`.
574
+ - name: checkout.shippingInfo.selectedCarrierServiceOption.carrierId | type: string | description: This carrier's unique GUID
575
+ - name: checkout.shippingInfo.selectedCarrierServiceOption.code | type: string | description: Unique identifier of selected option. For example, "usps_std_overnight".
576
+ - name: checkout.shippingInfo.selectedCarrierServiceOption.cost | type: SelectedCarrierServiceOptionPrices | description: Shipping costs.
577
+ - name: checkout.shippingInfo.selectedCarrierServiceOption.cost.price | type: MultiCurrencyPrice | description: Shipping price before discount and before tax.
578
+ - name: checkout.shippingInfo.selectedCarrierServiceOption.cost.taxDetails | type: ItemTaxFullDetails | description: Tax details.
579
+ - name: checkout.shippingInfo.selectedCarrierServiceOption.cost.totalDiscount | type: MultiCurrencyPrice | description: Shipping discount before tax.
580
+ - name: checkout.shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax | type: MultiCurrencyPrice | description: Total shipping price, after discount and after tax.
581
+ - name: checkout.shippingInfo.selectedCarrierServiceOption.cost.totalPriceBeforeTax | type: MultiCurrencyPrice | description: Total price of shipping after discounts (when relevant), and before tax.
582
+ - name: checkout.shippingInfo.selectedCarrierServiceOption.deliveryAllocations | type: Array<DeliveryAllocation> | description: Delivery solution allocations to different delivery carriers and delivery regions
583
+ - name: checkout.shippingInfo.selectedCarrierServiceOption.logistics | type: DeliveryLogistics | description: Delivery logistics.
584
+ - name: checkout.shippingInfo.selectedCarrierServiceOption.partial | type: boolean | description: If the delivery solution is a partial and doesn't apply to all items.
585
+ - name: checkout.shippingInfo.selectedCarrierServiceOption.requestedShippingOption | type: boolean | description: Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)
586
+ - name: checkout.shippingInfo.selectedCarrierServiceOption.title | type: string | description: Title of the option, such as USPS Standard Overnight Delivery (in the requested locale). For example, "Standard" or "First-Class Package International".
587
+ - name: checkout.shippingInfo.shippingDestination | type: AddressWithContact | description: Shipping address and contact details.
588
+ - name: checkout.siteLanguage | type: string | description: Site language in which original values are shown.
589
+ - name: checkout.taxExemptGroupId | type: string | description: Tax exempt group GUID to use for tax exemptions.
590
+ - name: checkout.taxIncludedInPrice | type: boolean | description: Whether tax is included in line item prices.
591
+ - name: checkout.taxSummary | type: TaxSummary | description: Tax summary.
592
+ - name: checkout.taxSummary.taxableAmount | type: MultiCurrencyPrice | description: Amount for which tax is calculated, added from line items.
593
+ - name: checkout.taxSummary.totalTax | type: MultiCurrencyPrice | description: Calculated tax, added from line items.
594
+ - name: checkout.violations | type: Array<Violation> | description: List of validation violations raised by the [Validations service plugin](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction).
595
+ - name: checkout.violations[].description | type: string | description: 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>`.
596
+ - name: checkout.violations[].severity | type: Severity | description: 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.
597
+ enum:
981
598
  ERROR: The user is blocked from moving forward in the flow. For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.
982
599
  WARNING: The user is allowed to move forward in the flow.
983
- - name: checkout.violations[].target | type: Target | description: Target location on a checkout or cart page where the violation will be displayed.
984
- - ONE-OF:
985
- - name: checkout.violations[].target.lineItem | type: TargetLineItem | description: Specific line item violation.
986
- - name: checkout.violations[].target.lineItem._id | type: string | description: GUID of the line item containing the violation.
987
- - name: checkout.violations[].target.lineItem.name | type: NameInLineItem | description: Location on a checkout or a cart page where the specific line item violation will be displayed.
988
- enum:
600
+ - name: checkout.violations[].target | type: Target | description: Target location on a checkout or cart page where the violation will be displayed.
601
+ - ONE-OF:
602
+ - name: checkout.violations[].target.lineItem | type: TargetLineItem | description: Specific line item violation.
603
+ - name: checkout.violations[].target.lineItem._id | type: string | description: GUID of the line item containing the violation.
604
+ - name: checkout.violations[].target.lineItem.name | type: NameInLineItem | description: Location on a checkout or a cart page where the specific line item violation will be displayed.
605
+ enum:
989
606
  LINE_ITEM_DEFAULT: Default location, in case no specific location is specified.
990
- - name: checkout.violations[].target.other | type: Other | description: General (other) violation.
991
- - name: checkout.violations[].target.other.name | type: NameInOther | description: Location on a checkout or a cart page where a general (other) violation will be displayed.
992
- enum:
607
+ - name: checkout.violations[].target.other | type: Other | description: General (other) violation.
608
+ - name: checkout.violations[].target.other.name | type: NameInOther | description: Location on a checkout or a cart page where a general (other) violation will be displayed.
609
+ enum:
993
610
  OTHER_DEFAULT: Default location, in case no specific location is specified.
994
- - name: checkout.weightUnit | type: WeightUnit | description: Weight measurement unit. Defaults to a site's weight unit.
995
- enum:
611
+ - name: checkout.weightUnit | type: WeightUnit | description: Weight measurement unit. Defaults to a site's weight unit.
612
+ enum:
996
613
  KG: Kilograms.
997
614
  LB: Pounds.
998
615
  UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
@@ -1002,4 +619,4 @@ Possible Errors:
1002
619
 
1003
620
  ```
1004
621
  </type_definition>
1005
- </ecom_checkout_addToCheckout>
622
+ </ecom_checkout_addToCheckout>