@wix/ditto-codegen-public 1.0.162 → 1.0.163

package/dist/docs-output/api-docs/ecom-checkout-updateCheckout-doc.txt

@@ -0,0 +1,1011 @@
+<ecom_checkout_updateCheckout>
+<description>
+# Method name:
+
+ecom.checkout.updateCheckout(_id: string, checkout: UpdateCheckout, options: UpdateCheckoutOptions)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/update-checkout
+
+# Method Description:
+
+Updates a checkout.
+
+Use this method to update checkout fields such as billing and shipping info, or to add a coupon code or gift card.
+
+To update a checkout's `lineItems`, `completed` status, or to remove coupons and gift cards, see these methods:
++ Add to Checkout: Add line items to the checkout.
++ Update Line Items Quantity: Update the quantity of 1 or more line items in the checkout.
++ Remove Line Items: Remove a line item from the checkout.
++ Mark Checkout As Completed: To update `completed` to `true` if the checkout was completed through a non-Wix orders or payments system.
++ Remove Coupon: To remove an applied coupon from the checkout.
++ Remove Gift Card: To remove an applied gift card from the checkout.
+
+>**Notes:**
+> + If nothing is passed in the request, the call will fail.
+> + The `checkout.buyerInfo.email` may not be removed once it is set.
+
+# Method Permissions:
+
+- ECOM.MODIFY_CHECKOUTS
+- ECOM.ADMIN_MODIFY_CHECKOUTS
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## Update a checkout 
+
+```javascript
+/**************************************
+* Backend code - my-backend-file.web.js/ts *
+*************************************/
+
+import { Permissions, webMethod } from '@wix/web-methods';
+import { checkout } from '@wix/ecom';
+
+export const myUpdateCheckoutFunction = webMethod(Permissions.Anyone, async (_id, checkoutInfo, options) => {
+ try {
+   const updatedCheckout = await checkout.updateCheckout(_id, checkoutInfo, options);
+   console.log('Success! Updated checkout: ', updatedCheckout);
+   return updatedCheckout;
+ } catch (error) {
+   console.error(error);
+   // Handle the error
+ }
+});
+
+/*************
+* Page code *
+************/
+
+import { myUpdateCheckoutFunction } from 'backend/my-backend-file.web';
+
+// Sample checkoutId:
+const _id = "21fe558e-21a0-4cff-a49b-a4ccb0f7414f";
+
+const checkoutInfo = {
+ // New value for buyerNote
+ "buyerNote": "Please gift wrap this order. Thanks!"
+}
+
+const options = {
+ // Coupon code to be applied to the checkout
+ "couponCode": "SUMMERSALE10"
+}
+
+myUpdateCheckoutFunction(_id, checkoutInfo, options)
+ .then((updatedCheckout) => {
+   const updatedBuyerNote = updatedCheckout.buyerNote;
+   // appliedCoupon boolean resolves to true if coupon object exists
+   const appliedCoupon = !!updatedCheckout.appliedDiscounts[0].coupon
+
+   console.log('Success! Updated checkout:', updatedCheckout);
+   return updatedCheckout;
+ })
+ .catch((error) => {
+   console.error(error);
+   // Handle the error
+ });
+
+/* Promise resolves to:
+* {
+*   "_id": "21fe558e-21a0-4cff-a49b-a4ccb0f7414f",
+*   "lineItems": [
+*     {
+*       "_id": "00000000-0000-0000-0000-000000000001",
+*       "quantity": 3,
+*       "catalogReference": {
+*         "catalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a",
+*         "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
+*       },
+*       "productName": {
+*         "original": "Shirt",
+*         "translated": "Shirt"
+*       },
+*       "url": "https://giftsstore.wixsite.com/greatest-gifts/product-page/shirt",
+*       "price": {
+*         "amount": "10",
+*         "convertedAmount": "10",
+*         "formattedAmount": "€10.00",
+*         "formattedConvertedAmount": "€10.00"
+*       },
+*       "lineItemPrice": {
+*         "amount": "30",
+*         "convertedAmount": "30",
+*         "formattedAmount": "€30.00",
+*         "formattedConvertedAmount": "€30.00"
+*       },
+*       "fullPrice": {
+*         "amount": "10",
+*         "convertedAmount": "10",
+*         "formattedAmount": "€10.00",
+*         "formattedConvertedAmount": "€10.00"
+*       },
+*       "priceBeforeDiscounts": {
+*         "amount": "10",
+*         "convertedAmount": "10",
+*         "formattedAmount": "€10.00",
+*         "formattedConvertedAmount": "€10.00"
+*       },
+*       "totalPriceAfterTax": {
+*         "amount": "30",
+*         "convertedAmount": "30",
+*         "formattedAmount": "€30.00",
+*         "formattedConvertedAmount": "€30.00"
+*       },
+*       "totalPriceBeforeTax": {
+*         "amount": "30",
+*         "convertedAmount": "30",
+*         "formattedAmount": "€30.00",
+*         "formattedConvertedAmount": "€30.00"
+*       },
+*       "taxDetails": {
+*         "taxableAmount": {
+*           "amount": "30",
+*           "convertedAmount": "30",
+*           "formattedAmount": "€30.00",
+*           "formattedConvertedAmount": "€30.00"
+*         },
+*         "taxRate": "0",
+*         "totalTax": {
+*           "amount": "0",
+*           "convertedAmount": "0",
+*           "formattedAmount": "€0.00",
+*           "formattedConvertedAmount": "€0.00"
+*         },
+*         "rateBreakdown": []
+*       },
+*       "discount": {
+*         "amount": "0",
+*         "convertedAmount": "0",
+*         "formattedAmount": "€0.00",
+*         "formattedConvertedAmount": "€0.00"
+*       },
+*       "descriptionLines": [],
+*       "media": "wix:image://v1/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg#originWidth=1000&originHeight=1000",
+*       "availability": {
+*         "status": "AVAILABLE"
+*       },
+*       "physicalProperties": {
+*         "sku": "364115376135191",
+*         "shippable": true
+*       },
+*       "couponScopes": [
+*         {
+*           "namespace": "stores",
+*           "group": {
+*             "name": "collection",
+*             "entityId": "00000000-000000-000000-000000000001"
+*           }
+*         },
+*         {
+*           "namespace": "stores",
+*           "group": {
+*             "name": "product",
+*             "entityId": "c8539b66-7a44-fe18-affc-afec4be8562a"
+*           }
+*         }
+*       ],
+*       "itemType": {
+*         "preset": "PHYSICAL"
+*       },
+*       "paymentOption": "FULL_PAYMENT_ONLINE",
+*       "rootCatalogItemId": "c8539b66-7a44-fe18-affc-afec4be8562a"
+*     }
+*   ],
+*   "shippingInfo": {
+*     "carrierServiceOptions": []
+*   },
+*   "buyerNote": "Please gift wrap this order. Thanks!",
+*   "buyerInfo": {
+*     "contactId": "a4bc8d90-a91b-467f-a775-77d65dd0442e",
+*     "email": "johnnydoe@example.com",
+*     "memberId": "ea3d74df-b7dc-4ca1-a7c9-c416b9017a86"
+*   },
+*   "conversionCurrency": "EUR",
+*   "priceSummary": {
+*     "subtotal": {
+*       "amount": "30",
+*       "convertedAmount": "30",
+*       "formattedAmount": "€30.00",
+*       "formattedConvertedAmount": "€30.00"
+*     },
+*     "shipping": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     },
+*     "tax": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     },
+*     "discount": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     },
+*     "total": {
+*       "amount": "30",
+*       "convertedAmount": "30",
+*       "formattedAmount": "€30.00",
+*       "formattedConvertedAmount": "€30.00"
+*     },
+*     "additionalFees": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     }
+*   },
+*   "calculationErrors": {
+*     "orderValidationErrors": []
+*   },
+*   "appliedDiscounts": [
+*     {
+*       "discountType": "GLOBAL",
+*       "lineItemIds": [],
+*       "coupon": {
+*         "_id": "fbb94b06-7447-4161-9c48-59bfcdc39e77",
+*         "code": "SUMMERSALE10",
+*         "amount": {
+*           "amount": "10.0",
+*           "convertedAmount": "10.0",
+*           "formattedAmount": "€10.00",
+*           "formattedConvertedAmount": "€10.00"
+*         },
+*         "name": "SUMMERSALE10",
+*         "couponType": "MoneyOff"
+*       }
+*     }
+*   ],
+*   "customFields": [],
+*   "weightUnit": "KG",
+*   "currency": "EUR",
+*   "channelType": "WEB",
+*   "siteLanguage": "en",
+*   "buyerLanguage": "en",
+*   "completed": false,
+*   "taxIncludedInPrice": false,
+*   "createdBy": {
+*     "memberId": "ea3d74df-b7dc-4ca1-a7c9-c416b9017a86"
+*   },
+*   "_createdDate": "2023-02-22T15:49:04.627Z",
+*   "_updatedDate": "2023-02-22T16:30:58.947Z",
+*   "payNow": {
+*     "subtotal": {
+*       "amount": "30",
+*       "convertedAmount": "30",
+*       "formattedAmount": "€30.00",
+*       "formattedConvertedAmount": "€30.00"
+*     },
+*     "shipping": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     },
+*     "tax": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     },
+*     "discount": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     },
+*     "total": {
+*       "amount": "30",
+*       "convertedAmount": "30",
+*       "formattedAmount": "€30.00",
+*       "formattedConvertedAmount": "€30.00"
+*     },
+*     "additionalFees": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     }
+*   },
+*   "payLater": {
+*     "subtotal": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     },
+*     "shipping": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     },
+*     "tax": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     },
+*     "discount": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     },
+*     "total": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     },
+*     "additionalFees": {
+*       "amount": "0",
+*       "convertedAmount": "0",
+*       "formattedAmount": "€0.00",
+*       "formattedConvertedAmount": "€0.00"
+*     }
+*   },
+*   "membershipOptions": {
+*     "eligibleMemberships": [],
+*     "invalidMemberships": [],
+*     "selectedMemberships": {
+*       "memberships": []
+*     }
+*   },
+*   "additionalFees": [],
+*   "payNowTotalAfterGiftCard": {
+*     "amount": "30",
+*     "convertedAmount": "30",
+*     "formattedAmount": "€30.00",
+*     "formattedConvertedAmount": "€30.00"
+*   }
+* } 
+*/
+```
+
+
+
+## default
+
+```javascript
+try {
+ const result = await checkout.updateCheckout("3a877d07-dbb6-3e55-9258-ce307d5829e4", {
+   buyerInfo: {
+     email: "buyer@example.com"
+   }
+ });
+ return result;
+} catch (error) {
+ console.error(error);
+ throw error;
+}
+```
+</description>
+<type_definition>
+```
+Method: ecom.checkout.updateCheckout(_id, checkout, options)
+Description: Updates a checkout.  Use this method to update checkout fields such as billing and shipping info, or to add a coupon code or gift card.  To update a checkout's `lineItems`, `completed` status, or to remove coupons and gift cards, see these methods: + Add to Checkout: Add line items to the checkout. + Update Line Items Quantity: Update the quantity of 1 or more line items in the checkout. + Remove Line Items: Remove a line item from the checkout. + Mark Checkout As Completed: To update `completed` to `true` if the checkout was completed through a non-Wix orders or payments system. + Remove Coupon: To remove an applied coupon from the checkout. + Remove Gift Card: To remove an applied gift card from the checkout.  >**Notes:** > + If nothing is passed in the request, the call will fail. > + The `checkout.buyerInfo.email` may not be removed once it is set.
+Method parameters:
+  param name:  _id | type: string | description:  Checkout GUID. | required: true
+  param name:  checkout | type: UpdateCheckout | description:  none | required: true
+      - name: additionalFees  | type: Array<AdditionalFee> | description:  Additional Fees. 
+            - name: code  | type: string | description:  Additional fee's unique code (or GUID) for future processing. 
+            - name: 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. 
+            - name: name  | type: string | description:  Translated additional fee's name. 
+            - name: price  | type: MultiCurrencyPrice | description:  Additional fee's price. 
+                - name: amount  | type: string | description:  Amount. 
+            - name: priceAfterTax  | type: MultiCurrencyPrice | description:  Additional fee's price after tax. 
+            - name: priceBeforeTax  | type: MultiCurrencyPrice | description:  Additional fee's price before tax. 
+            - name: providerAppId  | type: string | description:  Provider's app id. 
+            - name: source  | type: AdditionalFeeSource | description:  the source the additional fee was added from 
+                enum: 
+                     ITEM: The additional fee was added on the item either via the catalog or on custom line item
+                     MANUAL: The additional fee was added manually on the request
+                     SERVICE_PLUGIN: The additional fee was added by an additional fee service plugin
+                     SHIPPING: The additional fee was added by the shipping provider
+                   UNKNOWN_ADDITIONAL_FEE_SOURCE
+            - name: taxDetails  | type: ItemTaxFullDetails | description:  Tax details. 
+                - name: taxRate  | type: string | description:  Tax rate %, as a decimal point between 0 and 1. 
+                - name: taxableAmount  | type: MultiCurrencyPrice | description:  Amount for which tax is calculated. 
+                - name: totalTax  | type: MultiCurrencyPrice | description:  Calculated tax, based on `taxable_amount` and `tax_rate`. 
+            - name: 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). 
+      - name: billingInfo  | type: AddressWithContact | description:  Billing information. 
+          - name: address  | type: ApiAddress | description:  Address. 
+              - name: addressLine1  | type: string | description:  Main address line (usually street name and number). 
+              - name: addressLine2  | type: string | description:  Free text providing more detailed address info. Usually contains apt, suite, floor. 
+              - name: city  | type: string | description:  City name. 
+              - name: country  | type: string | description:  Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. 
+              - name: location  | type: AddressLocation | description:  Geocode object containing latitude and longitude coordinates. 
+                  - name: latitude  | type: number | description:  Address latitude. 
+                  - name: longitude  | type: number | description:  Address longitude. 
+              - name: postalCode  | type: string | description:  Postal or zip code. 
+              - name: streetAddress  | type: StreetAddress | description:  Street address. 
+                  - name: name  | type: string | description:  Street name. 
+                  - name: number  | type: string | description:  Street number. 
+              - name: 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. 
+          - name: contactDetails  | type: FullAddressContactDetails | description:  Contact details. 
+              - name: company  | type: string | description:  Company name. 
+              - name: firstName  | type: string | description:  First name. 
+              - name: lastName  | type: string | description:  Last name. 
+              - name: phone  | type: string | description:  Phone number. 
+              - name: vatId  | type: CommonVatId | description:  Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. 
+                  - name: _id  | type: string | description:  Customer's tax GUID. 
+                  - name: type  | type: CommonVatType | description:  Tax type.  Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations 
+                      enum: 
+                           CNPJ: CNPJ - for corporations
+                           CPF: CPF - for individual tax payers.
+                         UNSPECIFIED
+      - name: businessLocationId  | type: string | description:  The business location GUID associated with the checkout.  To learn more, see the Locations API. 
+      - name: buyerInfo  | type: BuyerInfo | description:  Buyer information. 
+          - name: email  | type: string | description:  Buyer email address. 
+          - ONE-OF: 
+            - name: memberId  | type: string | description:  Member GUID (if site visitor is a site member). 
+            - name: visitorId  | type: string | description:  Visitor GUID (if site visitor is **not** a member). 
+      - name: buyerNote  | type: string | description:  [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer. 
+      - name: cartId  | type: string | description:  Cart GUID that this checkout was created from. Empty if this checkout wasn't created from a cart. 
+      - name: 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). 
+          - name: 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/). 
+          - name: 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/). 
+      - name: customFields  | type: Array<CustomField> | description:  Custom fields. 
+            - name: title  | type: string | description:  Custom field title. 
+            - name: translatedTitle  | type: string | description:  Translated custom field title. 
+            - name: value  | type: any | description:  Custom field value. | required: true
+      - name: 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). 
+          - name: disabledManualPayment  | type: boolean | description:  Whether to disable manual payment option for this checkout.  Default: `false` 
+          - name: disabledPolicyAgreementCheckbox  | type: boolean | description:  Whether to disable policy agreement checkout in the checkout page  Default: `false` 
+          - name: lockCouponCode  | type: boolean | description:  Whether to restrict the option to add or remove a coupon code on the checkout page.  Default: `false` 
+          - name: lockGiftCard  | type: boolean | description:  Whether to restrict the option to add or remove a gift card on the checkout page.  Default: `false` 
+      - name: 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. 
+          - 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). 
+      - name: externalReference  | type: ExternalReference | description:  References to an external app and resource associated with this checkout. Used for integration and tracking across different platforms. 
+          - name: appId  | type: string | description:  GUID of the app associated with the purchase flow. For example, the Wix Pay Links app GUID. 
+          - name: 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. 
+      - name: membershipOptions  | type: MembershipOptions | description:  Memberships to apply when creating the order. 
+          - name: selectedMemberships  | type: SelectedMemberships | description:  Selected membership to apply to this checkout. 
+              - name: memberships  | type: Array<SelectedMembership> | description:  Selected memberships. 
+                    - name: _id  | type: string | description:  Membership GUID. | required: true
+                    - name: appId  | type: string | description:  GUID of the app providing this payment option. | required: true
+                    - name: lineItemIds  | type: Array<string> | description:  IDs of the line items this membership applies to. | required: true
+      - name: shippingInfo  | type: ShippingInfo | description:  Shipping information. 
+          - name: selectedCarrierServiceOption  | type: SelectedCarrierServiceOption | description:  Selected option out of the options allowed for the `region`. 
+              - name: carrierId  | type: string | description:  This carrier's unique GUID 
+              - name: code  | type: string | description:  Unique identifier of selected option. For example, "usps_std_overnight". 
+              - name: deliveryAllocations  | type: Array<DeliveryAllocation> | description:  Delivery solution allocations to different delivery carriers and delivery regions 
+                    - name: applicableLineItems  | type: ApplicableLineItems | description:  Populated if the delivery solution is a partially supplied by this carrier. 
+                        - name: lineItemIds  | type: Array<string> | description:  Line items that the delivery solution is for. 
+                    - name: deliveryCarrier  | type: Carrier | description:  The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers 
+                        - name: appId  | type: string | description:  The carrier app id 
+                        - name: code  | type: string | description:  Unique code that acts as an GUID for a shipping rate. For example, `"usps_std_overnight"`. 
+                    - name: deliveryRegion  | type: Region | description:  The delivery region that are relevant for this delivery solution. 
+                        - name: _id  | type: string | description:  The delivery region id. 
+                        - name: name  | type: string | description:  The delivery region name. 
+              - name: partial  | type: boolean | description:  If the delivery solution is a partial and doesn't apply to all items. 
+          - name: shippingDestination  | type: AddressWithContact | description:  Shipping address and contact details. 
+      - name: taxExemptGroupId  | type: string | description:  Tax exempt group GUID to use for tax exemptions. 
+  param name:  options | type: UpdateCheckoutOptions | description:  Checkout update options. 
+      - name: couponCode  | type: string | description:  Coupon code.  The checkout can only hold 1 `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`. 
+      - 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). 
+            - 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. 
+                - 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"` 
+                - name: catalogItemId  | type: string | description:  GUID of the item within the catalog it belongs to. 
+                - 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). 
+            - name: deliveryProfileId  | type: string | description:  Delivery profile GUID. 
+            - 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. 
+            - name: descriptionLines  | type: Array<DescriptionLine> | description:  Custom line item description lines. Used for display purposes for the cart, checkout and order. 
+                  - name: name  | type: DescriptionLineName | description:  Description line name. 
+                      - 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). 
+                      - name: translated  | type: string | description:  Description line name translated into the buyer's language.  Default: Same as `original`. 
+                  - ONE-OF: 
+                    - name: colorInfo  | type: Color | description:  Description line color value. 
+                        - name: code  | type: string | description:  HEX or RGB color code for display. 
+                        - 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). 
+                        - name: translated  | type: string | description:  Description line color name translated into the buyer's language.  Default: Same as `original`. 
+                    - name: plainText  | type: PlainTextValue | description:  Description line plain text value. 
+                        - 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). 
+                        - name: translated  | type: string | description:  Description line plain text value translated into the buyer's language.  Default: Same as `original`. 
+                  - ONE-OF: 
+            - name: fixedQuantity  | type: boolean | description:  Whether the line item quantity is fixed and cannot be changed.  Default: `false` 
+            - name: fullPrice  | type: string | description:  Item price **before** catalog-defined discount. Defaults to `price` when not provided. 
+            - name: itemType  | type: ItemType | description:  Item type. Either a preset type or custom. | required: true
+                - ONE-OF: 
+                  - name: custom  | type: string | description:  Custom item type. When none of the preset types are suitable, specifies the custom type. 
+                  - name: preset  | type: ItemTypePreset | description:  Preset item type. 
+                      enum: DIGITAL, GIFT_CARD, PHYSICAL, SERVICE, UNRECOGNISED
+            - 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"`. 
+            - name: membersOnly  | type: boolean | description:  Whether the item can only be purchased by site members.  Default: `false` 
+            - name: modifierGroups  | type: Array<V1ModifierGroup> | description:  Modifier groups that were added to the item. 
+                  - name: _id  | type: string | description:  Modifier group GUID. 
+                  - name: modifiers  | type: Array<V1ItemModifier> | description:  List of modifiers in this group. 
+                        - name: _id  | type: string | description:  Modifier GUID. 
+                        - name: details  | type: TranslatableString | description:  Additional details. 
+                            - 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. 
+                            - name: translated  | type: string | description:  String translated into the buyer's language.  Min: 1 character. Max: 400 characters. Default: Same as `original`. 
+                        - name: label  | type: TranslatableString | description:  Primary display label for the modifier. 
+                        - name: price  | type: string | description:  The price of the modifier. 
+                        - name: quantity  | type: number | description:  The quantity of this modifier. 
+                  - name: name  | type: TranslatableString | description:  Modifier group name. 
+            - 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. 
+                enum: 
+                     DEPOSIT_ONLINE: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`.
+                     FULL_PAYMENT_OFFLINE: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods.
+                     FULL_PAYMENT_ONLINE: The entire payment for this item happens as part of the checkout.
+                     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.
+                     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`.
+                     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.
+            - name: physicalProperties  | type: PhysicalProperties | description:  Physical properties of the item. 
+                - name: shippable  | type: boolean | description:  Whether this line item is shippable. 
+                - name: sku  | type: string | description:  Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). 
+                - name: weight  | type: number | description:  Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. 
+            - name: policies  | type: Array<Policy> | description:  Policies to be displayed to the customer on the checkout page. 
+                  - name: content  | type: string | description:  Policy content - should be translated 
+                  - name: title  | type: string | description:  Policy title - should be translated 
+            - 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. 
+            - 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". 
+                - 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). 
+                - name: translated  | type: string | description:  Price description translated into the buyer's language.  Default: Same as `original`. 
+            - name: priceUndetermined  | type: boolean | description:  Whether the price is not yet defined, and will be updated after the order is created.  Default: `false` 
+            - name: productName  | type: ProductName | description:  Name of the item or product. | required: true
+                - 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. 
+                - name: translated  | type: string | description:  Item name translated into the buyer's language.  Min: 1 character. Max: 400 characters. Default: Same as `original`. 
+            - name: quantity  | type: number | description:  Custom line item quantity.  Min: `1` Max: `100000` 
+            - 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. 
+            - 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. 
+            - 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. 
+                - 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. 
+                - 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. 
+            - name: taxGroupId  | type: string | description:  Tax group GUID for this custom line item. 
+            - name: taxableAddress  | type: TaxableAddress | description:  Address to use for tax calculation purposes. 
+                - ONE-OF: 
+                  - name: addressType  | type: TaxableAddressType | description:  taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. 
+                      enum: BILLING, BUSINESS, SHIPPING, UNKNOWN_TAXABLE_ADDRESS
+            - 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. 
+      - name: giftCardCode  | type: string | description:  Gift card code. 
+      - name: giftCardRedeemAmount  | type: string | description:  Amount to redeem from the gift card referenced in `gift_card_code`. 
+      - name: lineItems  | type: Array<LineItem> | description:  Catalog line items. 
+            - 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). 
+                - name: depositAmount  | type: string | description:  Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`. 
+                - name: descriptionLines  | type: Array<DescriptionLine> | description:  Item description lines. Used when displaying the line item to customers. 
+                - name: fullPrice  | type: string | description:  Item price **before** discounts. 
+                - name: image  | type: string | description:  Item image. 
+                - name: paymentOption  | type: PaymentOption | description:  Payment method selected for the item. 
+                    - name: value  | type: PaymentOptionType | description:  Type of selected payment option for current item.  Default: `FULL_PAYMENT_ONLINE` 
+                - name: physicalProperties  | type: PhysicalProperties | description:  Physical properties of the item. 
+                - name: price  | type: string | description:  Item price **after** discounts. 
+                - name: productName  | type: ProductName | description:  Item name. 
+                - name: savePaymentMethod  | type: boolean | description:  Whether to save the payment method on the order.  Default: `false` 
+            - 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
+            - 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. 
+            - name: quantity  | type: number | description:  Item quantity.  Min: `"1"` Max: `"100000"` | required: true
+            - name: taxableAddress  | type: TaxableAddress | description:  Address to use for tax calculation purposes. 
+      - name: overrideCheckoutUrl  | type: string | description:  `overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.  This field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the Abandoned Checkout API to send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`. 
+Return type: PROMISE<Checkout>
+      - name: _createdDate  | type: Date | description:  Date and time the checkout was created. 
+      - name: _id  | type: string | description:  Checkout GUID. 
+      - name: _updatedDate  | type: Date | description:  Date and time the checkout was updated. 
+      - name: additionalFees  | type: Array<AdditionalFee> | description:  Additional Fees. 
+            - name: additionalFees[].code  | type: string | description:  Additional fee's unique code (or GUID) for future processing. 
+            - name: 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. 
+            - name: additionalFees[].name  | type: string | description:  Translated additional fee's name. 
+            - name: additionalFees[].price  | type: MultiCurrencyPrice | description:  Additional fee's price. 
+                - name: additionalFees[].price.amount  | type: string | description:  Amount. 
+                - name: additionalFees[].price.convertedAmount  | type: string | description:  Converted amount. 
+                - name: additionalFees[].price.formattedAmount  | type: string | description:  Amount formatted with currency symbol. 
+                - name: additionalFees[].price.formattedConvertedAmount  | type: string | description:  Converted amount formatted with currency symbol. 
+            - name: additionalFees[].priceAfterTax  | type: MultiCurrencyPrice | description:  Additional fee's price after tax. 
+            - name: additionalFees[].priceBeforeTax  | type: MultiCurrencyPrice | description:  Additional fee's price before tax. 
+            - name: additionalFees[].providerAppId  | type: string | description:  Provider's app id. 
+            - name: additionalFees[].source  | type: AdditionalFeeSource | description:  the source the additional fee was added from 
+                enum: 
+                     ITEM: The additional fee was added on the item either via the catalog or on custom line item
+                     MANUAL: The additional fee was added manually on the request
+                     SERVICE_PLUGIN: The additional fee was added by an additional fee service plugin
+                     SHIPPING: The additional fee was added by the shipping provider
+                   UNKNOWN_ADDITIONAL_FEE_SOURCE
+            - name: additionalFees[].taxDetails  | type: ItemTaxFullDetails | description:  Tax details. 
+                - name: additionalFees[].taxDetails.taxBreakdown  | type: Array<TaxBreakdown> | description:  tax information for a line item. 
+                      - name: additionalFees[].taxDetails.taxBreakdown[].jurisdiction  | type: string | description:  The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec". 
+                      - name: additionalFees[].taxDetails.taxBreakdown[].jurisdictionType  | type: JurisdictionType | description:  The type of the jurisdiction in which this tax detail applies. 
+                          enum: CITY, COUNTRY, COUNTY, SPECIAL, STATE, UNDEFINED
+                      - name: additionalFees[].taxDetails.taxBreakdown[].nonTaxableAmount  | type: MultiCurrencyPrice | description:  The amount of this line item price that was considered nontaxable. (Decimal value) 
+                      - name: 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) 
+                      - name: additionalFees[].taxDetails.taxBreakdown[].taxAmount  | type: MultiCurrencyPrice | description:  The amount of tax estimated for this line item. (Decimal value) 
+                      - name: 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. 
+                      - name: 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. 
+                      - name: additionalFees[].taxDetails.taxBreakdown[].taxableAmount  | type: MultiCurrencyPrice | description:  The taxable amount of this line item. 
+                - name: additionalFees[].taxDetails.taxRate  | type: string | description:  Tax rate %, as a decimal point between 0 and 1. 
+                - name: additionalFees[].taxDetails.taxableAmount  | type: MultiCurrencyPrice | description:  Amount for which tax is calculated. 
+                - name: additionalFees[].taxDetails.totalTax  | type: MultiCurrencyPrice | description:  Calculated tax, based on `taxable_amount` and `tax_rate`. 
+            - name: 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). 
+      - name: appliedDiscounts  | type: Array<AppliedDiscount> | description:  Applied discounts. 
+            - name: appliedDiscounts[].discountType  | type: DiscountType | description:  Discount type. 
+                enum: GLOBAL, SHIPPING, SPECIFIC_ITEMS
+            - ONE-OF: 
+              - name: appliedDiscounts[].coupon  | type: Coupon | description:  Coupon details. 
+                  - name: appliedDiscounts[].coupon._id  | type: string | description:  Coupon GUID. 
+                  - name: appliedDiscounts[].coupon.amount  | type: MultiCurrencyPrice | description:  Coupon value. 
+                  - name: appliedDiscounts[].coupon.code  | type: string | description:  Coupon code. 
+                  - name: appliedDiscounts[].coupon.name  | type: string | description:  Coupon name. 
+              - name: appliedDiscounts[].discountRule  | type: DiscountRule | description:  Discount rule 
+                  - name: appliedDiscounts[].discountRule._id  | type: string | description:  Discount rule GUID 
+                  - name: appliedDiscounts[].discountRule.amount  | type: MultiCurrencyPrice | description:  Discount value. 
+                  - name: appliedDiscounts[].discountRule.name  | type: DiscountRuleName | description:  Discount rule name 
+                      - name: appliedDiscounts[].discountRule.name.original  | type: string | description:  Original discount rule name (in site's default language). 
+                      - name: appliedDiscounts[].discountRule.name.translated  | type: string | description:  Translated discount rule name according to buyer language. Defaults to `original` when not provided. 
+              - name: appliedDiscounts[].merchantDiscount  | type: MerchantDiscount | description:  Merchant discount. 
+                  - name: appliedDiscounts[].merchantDiscount.amount  | type: MultiCurrencyPrice | description:  Discount value. 
+                  - name: appliedDiscounts[].merchantDiscount.percentage  | type: number | description:  Discount Percentage. Will be calculated from items price before other discounts. 
+      - name: billingInfo  | type: AddressWithContact | description:  Billing information. 
+          - name: billingInfo.address  | type: ApiAddress | description:  Address. 
+              - name: billingInfo.address.addressLine1  | type: string | description:  Main address line (usually street name and number). 
+              - name: billingInfo.address.addressLine2  | type: string | description:  Free text providing more detailed address info. Usually contains apt, suite, floor. 
+              - name: billingInfo.address.city  | type: string | description:  City name. 
+              - name: billingInfo.address.country  | type: string | description:  Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. 
+              - name: billingInfo.address.countryFullname  | type: string | description:  Country's full name. 
+              - name: billingInfo.address.location  | type: AddressLocation | description:  Geocode object containing latitude and longitude coordinates. 
+                  - name: billingInfo.address.location.latitude  | type: number | description:  Address latitude. 
+                  - name: billingInfo.address.location.longitude  | type: number | description:  Address longitude. 
+              - name: billingInfo.address.postalCode  | type: string | description:  Postal or zip code. 
+              - name: billingInfo.address.streetAddress  | type: StreetAddress | description:  Street address. 
+                  - name: billingInfo.address.streetAddress.name  | type: string | description:  Street name. 
+                  - name: billingInfo.address.streetAddress.number  | type: string | description:  Street number. 
+              - name: 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. 
+              - name: billingInfo.address.subdivisionFullname  | type: string | description:  Subdivision full-name. 
+          - name: billingInfo.contactDetails  | type: FullAddressContactDetails | description:  Contact details. 
+              - name: billingInfo.contactDetails.company  | type: string | description:  Company name. 
+              - name: billingInfo.contactDetails.firstName  | type: string | description:  First name. 
+              - name: billingInfo.contactDetails.lastName  | type: string | description:  Last name. 
+              - name: billingInfo.contactDetails.phone  | type: string | description:  Phone number. 
+              - name: 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. 
+                  - name: billingInfo.contactDetails.vatId._id  | type: string | description:  Customer's tax GUID. 
+                  - name: billingInfo.contactDetails.vatId.type  | type: CommonVatType | description:  Tax type.  Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations 
+                      enum: 
+                           CNPJ: CNPJ - for corporations
+                           CPF: CPF - for individual tax payers.
+                         UNSPECIFIED
+      - name: businessLocationId  | type: string | description:  The business location GUID associated with the checkout.  To learn more, see the Locations API. 
+      - name: buyerInfo  | type: BuyerInfo | description:  Buyer information. 
+          - name: buyerInfo.contactId  | type: string | description:  Contact GUID. Auto-created if one does not yet exist. For more information, see the Contacts API. 
+          - name: buyerInfo.email  | type: string | description:  Buyer email address. 
+          - ONE-OF: 
+            - name: buyerInfo.memberId  | type: string | description:  Member GUID (if site visitor is a site member). 
+            - name: buyerInfo.visitorId  | type: string | description:  Visitor GUID (if site visitor is **not** a member). 
+      - name: 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. 
+      - name: buyerNote  | type: string | description:  [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer. 
+      - name: calculationErrors  | type: CalculationErrors | description:  Errors when calculating totals. 
+          - name: calculationErrors.couponCalculationError  | type: Details | description:  Coupon calculation error. 
+              - ONE-OF: 
+                - name: calculationErrors.couponCalculationError.applicationError  | type: ApplicationError | description:  none 
+                    - name: calculationErrors.couponCalculationError.applicationError.code  | type: string | description:  Error code. 
+                    - name: calculationErrors.couponCalculationError.applicationError.data  | type: Record<string, any> | description:  Data related to the error. 
+                    - name: calculationErrors.couponCalculationError.applicationError.description  | type: string | description:  Description of the error. 
+                - name: calculationErrors.couponCalculationError.systemError  | type: SystemError | description:  none 
+                    - name: calculationErrors.couponCalculationError.systemError.errorCode  | type: string | description:  Error code. 
+                - name: calculationErrors.couponCalculationError.validationError  | type: ValidationError | description:  none 
+                    - name: calculationErrors.couponCalculationError.validationError.fieldViolations  | type: Array<FieldViolation> | description:  none 
+                          - name: calculationErrors.couponCalculationError.validationError.fieldViolations[].data  | type: Record<string, any> | description:  none 
+                          - name: calculationErrors.couponCalculationError.validationError.fieldViolations[].description  | type: string | description:  none 
+                          - name: calculationErrors.couponCalculationError.validationError.fieldViolations[].field  | type: string | description:  none 
+                          - name: calculationErrors.couponCalculationError.validationError.fieldViolations[].ruleName  | type: string | description:  applicable when violated_rule=OTHER 
+                          - name: calculationErrors.couponCalculationError.validationError.fieldViolations[].violatedRule  | type: RuleType | description:  none 
+                              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
+          - name: calculationErrors.discountsCalculationError  | type: Details | description:  Discount Rule calculation error. 
+          - name: calculationErrors.giftCardCalculationError  | type: Details | description:  Gift card calculation error. 
+          - name: 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 
+          - name: calculationErrors.orderValidationErrors  | type: Array<ApplicationError> | description:  Order validation errors. 
+          - name: calculationErrors.taxCalculationError  | type: Details | description:  Tax calculation error. 
+          - ONE-OF: 
+            - name: calculationErrors.carrierErrors  | type: CarrierErrors | description:  Carrier errors. 
+                - name: calculationErrors.carrierErrors.errors  | type: Array<CarrierError> | description:  Carrier errors. 
+                      - name: calculationErrors.carrierErrors.errors[].carrierId  | type: string | description:  Carrier GUID. 
+                      - name: calculationErrors.carrierErrors.errors[].error  | type: Details | description:  Error details. 
+            - name: calculationErrors.generalShippingCalculationError  | type: Details | description:  General shipping calculation error. 
+      - name: cartId  | type: string | description:  Cart GUID that this checkout was created from. Empty if this checkout wasn't created from a cart. 
+      - name: channelType  | type: ChannelType | description:  Sales channel that submitted the order. 
+          enum: 
+               AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop).
+               BACKOFFICE_MERCHANT: Wix merchant backoffice.
+               CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass).
+               EBAY: [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop).
+               ETSY: [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel).
+               FACEBOOK: [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops).
+               FAIRE_COM: [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app).
+               GLOBAL_E: Global-E sales channel.
+               OTHER_PLATFORM: Other sales platform.
+               PAYPAL_AGENTIC_CHECKOUT: PayPal Agentic Checkout sales channel.
+               POS: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395).
+               TIKTOK: [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel).
+               UNSPECIFIED: Unspecified sales channel. This value is not supported.
+               WEB: A web client.
+               WISH: Wish sales channel.
+               WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview).
+               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)
+      - name: 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). 
+      - name: 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. 
+      - name: createdBy  | type: CreatedBy | description:  GUID of the checkout's initiator. 
+          - ONE-OF: 
+            - name: createdBy.appId  | type: string | description:  App GUID. When the order was created by an external application or Wix service. 
+            - name: createdBy.memberId  | type: string | description:  Member GUID. When the order was created by a **logged in** site visitor. 
+            - name: 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). 
+            - name: createdBy.visitorId  | type: string | description:  Visitor GUID. When the order was created by a site visitor that was **not** logged in. 
+      - name: 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. 
+      - name: 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). 
+          - name: 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/). 
+          - name: 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/). 
+      - name: customFields  | type: Array<CustomField> | description:  Custom fields. 
+            - name: customFields[].title  | type: string | description:  Custom field title. 
+            - name: customFields[].translatedTitle  | type: string | description:  Translated custom field title. 
+            - name: customFields[].value  | type: any | description:  Custom field value. | required: true
+      - name: 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). 
+          - name: customSettings.disabledManualPayment  | type: boolean | description:  Whether to disable manual payment option for this checkout.  Default: `false` 
+          - name: customSettings.disabledPolicyAgreementCheckbox  | type: boolean | description:  Whether to disable policy agreement checkout in the checkout page  Default: `false` 
+          - name: customSettings.lockCouponCode  | type: boolean | description:  Whether to restrict the option to add or remove a coupon code on the checkout page.  Default: `false` 
+          - name: customSettings.lockGiftCard  | type: boolean | description:  Whether to restrict the option to add or remove a gift card on the checkout page.  Default: `false` 
+      - name: 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. 
+          - name: 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). 
+      - name: externalReference  | type: ExternalReference | description:  References to an external app and resource associated with this checkout. Used for integration and tracking across different platforms. 
+          - name: externalReference.appId  | type: string | description:  GUID of the app associated with the purchase flow. For example, the Wix Pay Links app GUID. 
+          - name: 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. 
+      - name: 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). 
+          - name: giftCard.amount  | type: MultiCurrencyPrice | description:  Actual amount to be redeemed from the gift card. 
+          - name: giftCard.appId  | type: string | description:  App GUID of the gift card provider. 
+          - name: giftCard.externalId  | type: string | description:  External GUID in the gift card provider's system. Used for integration and tracking across different platforms. 
+          - name: giftCard.obfuscatedCode  | type: string | description:  Gift card obfuscated code. 
+          - name: giftCard.requestedAmount  | type: MultiCurrencyPrice | description:  Requested amount to redeem from the gift card. 
+      - name: lineItems  | type: Array<LineItem> | description:  Line items.  Max: 300 items 
+            - name: lineItems[]._id  | type: string | description:  Line item GUID. 
+            - name: lineItems[].availability  | type: ItemAvailabilityInfo | description:  Item availability details. 
+                - name: lineItems[].availability.quantityAvailable  | type: number | description:  Quantity available. 
+                - name: lineItems[].availability.status  | type: ItemAvailabilityStatus | description:  Item availability status. 
+                    enum: AVAILABLE,   NOT_AVAILABLE: Item is not in stock.
+                         NOT_FOUND: Item does not exist.
+                         PARTIALLY_AVAILABLE: Available quantity is less than requested.
+            - name: 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). 
+                - name: lineItems[].catalogOverrideFields.depositAmount  | type: string | description:  Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`. 
+                - name: lineItems[].catalogOverrideFields.descriptionLines  | type: Array<DescriptionLine> | description:  Item description lines. Used when displaying the line item to customers. 
+                      - name: lineItems[].catalogOverrideFields.descriptionLines[].name  | type: DescriptionLineName | description:  Description line name. 
+                          - name: 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). 
+                          - name: lineItems[].catalogOverrideFields.descriptionLines[].name.translated  | type: string | description:  Description line name translated into the buyer's language.  Default: Same as `original`. 
+                      - ONE-OF: 
+                        - name: lineItems[].catalogOverrideFields.descriptionLines[].colorInfo  | type: Color | description:  Description line color value. 
+                            - name: lineItems[].catalogOverrideFields.descriptionLines[].colorInfo.code  | type: string | description:  HEX or RGB color code for display. 
+                            - name: 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). 
+                            - name: lineItems[].catalogOverrideFields.descriptionLines[].colorInfo.translated  | type: string | description:  Description line color name translated into the buyer's language.  Default: Same as `original`. 
+                        - name: lineItems[].catalogOverrideFields.descriptionLines[].plainText  | type: PlainTextValue | description:  Description line plain text value. 
+                            - name: 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). 
+                            - name: lineItems[].catalogOverrideFields.descriptionLines[].plainText.translated  | type: string | description:  Description line plain text value translated into the buyer's language.  Default: Same as `original`. 
+                      - ONE-OF: 
+                - name: lineItems[].catalogOverrideFields.fullPrice  | type: string | description:  Item price **before** discounts. 
+                - name: lineItems[].catalogOverrideFields.image  | type: string | description:  Item image. 
+                - name: lineItems[].catalogOverrideFields.paymentOption  | type: PaymentOption | description:  Payment method selected for the item. 
+                    - name: lineItems[].catalogOverrideFields.paymentOption.value  | type: PaymentOptionType | description:  Type of selected payment option for current item.  Default: `FULL_PAYMENT_ONLINE` 
+                        enum: 
+                             DEPOSIT_ONLINE: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`.
+                             FULL_PAYMENT_OFFLINE: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods.
+                             FULL_PAYMENT_ONLINE: The entire payment for this item happens as part of the checkout.
+                             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.
+                             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`.
+                             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.
+                - name: lineItems[].catalogOverrideFields.physicalProperties  | type: PhysicalProperties | description:  Physical properties of the item. 
+                    - name: lineItems[].catalogOverrideFields.physicalProperties.shippable  | type: boolean | description:  Whether this line item is shippable. 
+                    - name: lineItems[].catalogOverrideFields.physicalProperties.sku  | type: string | description:  Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). 
+                    - name: lineItems[].catalogOverrideFields.physicalProperties.weight  | type: number | description:  Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. 
+                - name: lineItems[].catalogOverrideFields.price  | type: string | description:  Item price **after** discounts. 
+                - name: lineItems[].catalogOverrideFields.productName  | type: ProductName | description:  Item name. 
+                    - name: 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. 
+                    - name: 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`. 
+                - name: lineItems[].catalogOverrideFields.savePaymentMethod  | type: boolean | description:  Whether to save the payment method on the order.  Default: `false` 
+            - name: 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
+                - name: 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"` 
+                - name: lineItems[].catalogReference.catalogItemId  | type: string | description:  GUID of the item within the catalog it belongs to. 
+                - name: 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). 
+            - name: 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. 
+            - name: lineItems[].customLineItem  | type: boolean | description:  Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin. 
+            - name: lineItems[].deliveryProfileId  | type: string | description:  Delivery profile GUID. 
+            - name: 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. 
+            - name: lineItems[].descriptionLines  | type: Array<DescriptionLine> | description:  Line item description lines. Used for display purposes for the cart, checkout and order. 
+            - name: lineItems[].discount  | type: MultiCurrencyPrice | description:  Discount for this line item's entire quantity. 
+            - name: 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. 
+            - name: lineItems[].fixedQuantity  | type: boolean | description:  Whether the line item quantity is fixed and cannot be changed. 
+            - name: lineItems[].fullPrice  | type: MultiCurrencyPrice | description:  Item price **before** catalog-defined discount. Defaults to `price` when not provided. 
+            - name: lineItems[].itemType  | type: ItemType | description:  Item type. Either a preset type or custom. 
+                - ONE-OF: 
+                  - name: lineItems[].itemType.custom  | type: string | description:  Custom item type. When none of the preset types are suitable, specifies the custom type. 
+                  - name: lineItems[].itemType.preset  | type: ItemTypePreset | description:  Preset item type. 
+                      enum: DIGITAL, GIFT_CARD, PHYSICAL, SERVICE, UNRECOGNISED
+            - name: lineItems[].lineItemPrice  | type: MultiCurrencyPrice | description:  Total line item price **after** catalog-defined discount and line item discounts. 
+            - name: lineItems[].media  | type: string | description:  Line item image details. 
+            - name: lineItems[].membersOnly  | type: boolean | description:  Whether the item can only be purchased by site members.  Default: `false` 
+            - name: lineItems[].modifierGroups  | type: Array<ModifierGroup> | description:  Modifier groups that were added to the item. 
+                  - name: lineItems[].modifierGroups[]._id  | type: string | description:  Modifier group GUID. 
+                  - name: lineItems[].modifierGroups[].modifiers  | type: Array<ItemModifier> | description:  List of modifiers in this group. 
+                        - name: lineItems[].modifierGroups[].modifiers[]._id  | type: string | description:  Modifier GUID. 
+                        - name: lineItems[].modifierGroups[].modifiers[].details  | type: TranslatableString | description:  Additional details. 
+                            - name: 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. 
+                            - name: 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`. 
+                        - name: lineItems[].modifierGroups[].modifiers[].label  | type: TranslatableString | description:  Primary display label for the modifier. 
+                        - name: lineItems[].modifierGroups[].modifiers[].price  | type: MultiCurrencyPrice | description:  The price of the modifier. 
+                        - name: lineItems[].modifierGroups[].modifiers[].quantity  | type: number | description:  The quantity of this modifier. 
+                  - name: lineItems[].modifierGroups[].name  | type: TranslatableString | description:  Modifier group name. 
+            - name: lineItems[].modifiersTotalPrice  | type: MultiCurrencyPrice | description:  Total price of all item modifiers. Included in the item price. 
+            - name: lineItems[].paymentOption  | type: PaymentOptionType | description:  Type of selected payment option for current item.  Default: `FULL_PAYMENT_ONLINE` 
+            - name: lineItems[].physicalProperties  | type: PhysicalProperties | description:  Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. 
+            - name: lineItems[].policies  | type: Array<Policy> | description:  Policies to be displayed to the customer on the checkout page. 
+                  - name: lineItems[].policies[].content  | type: string | description:  Policy content - should be translated 
+                  - name: lineItems[].policies[].title  | type: string | description:  Policy title - should be translated 
+            - name: lineItems[].price  | type: MultiCurrencyPrice | description:  Item price **after** catalog-defined discount and line item discounts. 
+            - name: lineItems[].priceBeforeDiscounts  | type: MultiCurrencyPrice | description:  Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided. 
+            - name: 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". 
+                - name: 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). 
+                - name: lineItems[].priceDescription.translated  | type: string | description:  Price description translated into the buyer's language.  Default: Same as `original`. 
+            - name: lineItems[].priceUndetermined  | type: boolean | description:  Whether the price is not yet defined, and will be updated after the order is created. 
+            - name: lineItems[].productName  | type: ProductName | description:  Item name. + Stores - `product.name` + Bookings - `service.info.name` + Events - `ticket.name` 
+            - name: lineItems[].quantity  | type: number | description:  Item quantity.  Min: `"1"` Max: `"100000"` | required: true
+            - name: 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. 
+            - name: lineItems[].savePaymentMethod  | type: boolean | description:  Whether to save the payment method on the order.  Default: `false` 
+            - name: lineItems[].serviceProperties  | type: ServiceProperties | description:  Service properties. When relevant, this contains information such as date and number of participants. 
+                - name: 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. 
+                - name: 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. 
+            - name: lineItems[].subscriptionOptionInfo  | type: SubscriptionOptionInfo | description:  Subscription option information. 
+                - name: lineItems[].subscriptionOptionInfo.description  | type: Description | description:  Subscription option description. 
+                    - name: lineItems[].subscriptionOptionInfo.description.original  | type: string | description:  Subscription option description. 
+                    - name: lineItems[].subscriptionOptionInfo.description.translated  | type: string | description:  Translated subscription option description. 
+                - name: lineItems[].subscriptionOptionInfo.subscriptionSettings  | type: SubscriptionSettings | description:  Subscription option settings. 
+                    - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.autoRenewal  | type: boolean | description:  Whether subscription is renewed automatically at the end of each period. 
+                    - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.billingCycles  | type: number | description:  Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`. 
+                    - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation  | type: boolean | description:  Whether to allow the customer to cancel the subscription.. 
+                    - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod  | type: FreeTrialPeriod | description:  Period until first cycle starts. If applied payNow will be 0 If None => no free trial 
+                        - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod.frequency  | type: SubscriptionFrequency | description:  Frequency of period. Values: DAY, WEEK, MONTH, YEAR 
+                            enum: DAY, MONTH, UNDEFINED, WEEK, YEAR
+                        - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.freeTrialPeriod.interval  | type: number | description:  interval of period 
+                    - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.frequency  | type: SubscriptionFrequency | description:  Frequency of recurring payment. 
+                    - name: lineItems[].subscriptionOptionInfo.subscriptionSettings.interval  | type: number | description:  Interval of recurring payment.  Default: `1`. If SubscriptionFrequency is Day the minimum interval is 7 
+                - name: lineItems[].subscriptionOptionInfo.title  | type: Title | description:  Subscription option title. 
+                    - name: 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). 
+                    - name: lineItems[].subscriptionOptionInfo.title.translated  | type: string | description:  Subscription option name translated into the buyer's language.  Default: Same as `original`. 
+            - name: lineItems[].taxDetails  | type: ItemTaxFullDetails | description:  Tax details for this line item. 
+            - name: lineItems[].taxableAddress  | type: TaxableAddress | description:  Address to use for tax calculation purposes. 
+                - ONE-OF: 
+                  - name: 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. 
+                      enum: BILLING, BUSINESS, SHIPPING, UNKNOWN_TAXABLE_ADDRESS
+            - name: lineItems[].totalPriceAfterTax  | type: MultiCurrencyPrice | description:  Total price after all discounts and tax. 
+            - name: lineItems[].totalPriceBeforeTax  | type: MultiCurrencyPrice | description:  Total price after discounts, and before tax. 
+            - name: lineItems[].url  | type: string | description:  URL to the item's page on the site. 
+      - name: membershipOptions  | type: MembershipOptions | description:  Memberships to apply when creating the order. 
+          - name: membershipOptions.eligibleMemberships  | type: Array<Membership> | description:  Reserved for internal use. 
+                - name: membershipOptions.eligibleMemberships[]._id  | type: string | description:  Membership GUID. 
+                - name: membershipOptions.eligibleMemberships[].additionalData  | type: Record<string, any> | description:  Additional data about this membership. 
+                - name: membershipOptions.eligibleMemberships[].appId  | type: string | description:  GUID of the application providing this payment option. 
+                - name: membershipOptions.eligibleMemberships[].credits  | type: MembershipPaymentCredits | description:  Optional - For a membership that has limited credits, information about credit usage. 
+                    - name: membershipOptions.eligibleMemberships[].credits.remaining  | type: number | description:  Membership's remaining amount of credits. 
+                    - name: membershipOptions.eligibleMemberships[].credits.total  | type: number | description:  Membership's total amount of credits. 
+                - name: membershipOptions.eligibleMemberships[].expirationDate  | type: Date | description:  Optional - TMembership expiry date. 
+                - name: membershipOptions.eligibleMemberships[].lineItemIds  | type: Array<string> | description:  Line item GUIDs which are "paid" for by this membership. 
+                - name: membershipOptions.eligibleMemberships[].name  | type: MembershipName | description:  The name of this membership. 
+                    - name: membershipOptions.eligibleMemberships[].name.original  | type: string | description:  Membership name. 
+                    - name: membershipOptions.eligibleMemberships[].name.translated  | type: string | description:  Translated membership name. Defaults to `original` when not provided. 
+          - name: membershipOptions.invalidMemberships  | type: Array<InvalidMembership> | description:  Reserved for internal use. 
+                - name: membershipOptions.invalidMemberships[].membership  | type: Membership | description:  Membership details. 
+                - name: membershipOptions.invalidMemberships[].reason  | type: string | description:  Reason why this membership is invalid and cannot be used. 
+          - name: membershipOptions.selectedMemberships  | type: SelectedMemberships | description:  Selected membership to apply to this checkout. 
+              - name: membershipOptions.selectedMemberships.memberships  | type: Array<SelectedMembership> | description:  Selected memberships. 
+                    - name: membershipOptions.selectedMemberships.memberships[]._id  | type: string | description:  Membership GUID. | required: true
+                    - name: membershipOptions.selectedMemberships.memberships[].appId  | type: string | description:  GUID of the app providing this payment option. | required: true
+                    - name: membershipOptions.selectedMemberships.memberships[].lineItemIds  | type: Array<string> | description:  IDs of the line items this membership applies to. | required: true
+      - name: payAfterFreeTrial  | type: PriceSummary | description:  Payment for subscriptions after free trial period. 
+          - name: payAfterFreeTrial.additionalFees  | type: MultiCurrencyPrice | description:  Total additional fees price before tax. 
+          - name: payAfterFreeTrial.discount  | type: MultiCurrencyPrice | description:  Total calculated discount value. 
+          - name: payAfterFreeTrial.shipping  | type: MultiCurrencyPrice | description:  Total shipping price, before discounts and before tax. 
+          - name: payAfterFreeTrial.subtotal  | type: MultiCurrencyPrice | description:  Subtotal of all line items, before discounts and before tax. 
+          - name: payAfterFreeTrial.tax  | type: MultiCurrencyPrice | description:  Total tax. 
+          - name: payAfterFreeTrial.total  | type: MultiCurrencyPrice | description:  Total price after discounts, gift cards, and tax. 
+      - name: payLater  | type: PriceSummary | description:  Remaining amount for the order to be fully paid. 
+      - name: payNow  | type: PriceSummary | description:  Minimal amount to pay in order to place the order. 
+      - name: 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. 
+      - name: priceSummary  | type: PriceSummary | description:  Calculated price summary for the checkout. 
+      - name: purchaseFlowId  | type: string | description:  Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order. 
+      - name: shippingInfo  | type: ShippingInfo | description:  Shipping information. 
+          - name: shippingInfo.carrierServiceOptions  | type: Array<CarrierServiceOption> | description:  All carrier options for this shipping rule. 
+                - name: shippingInfo.carrierServiceOptions[].carrierId  | type: string | description:  Carrier GUID. 
+                - name: shippingInfo.carrierServiceOptions[].shippingOptions  | type: Array<ShippingOption> | description:  Shipping options offered by this carrier for this request. 
+                      - name: 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. 
+                      - name: shippingInfo.carrierServiceOptions[].shippingOptions[].cost  | type: ShippingPrice | description:  Sipping price information. 
+                          - name: shippingInfo.carrierServiceOptions[].shippingOptions[].cost.otherCharges  | type: Array<OtherCharge> | description:  Other costs such as insurance, handling & packaging for fragile items, etc. 
+                                - name: shippingInfo.carrierServiceOptions[].shippingOptions[].cost.otherCharges[].details  | type: string | description:  Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`. 
+                                - name: shippingInfo.carrierServiceOptions[].shippingOptions[].cost.otherCharges[].price  | type: MultiCurrencyPrice | description:  Price of added cost. 
+                                - name: shippingInfo.carrierServiceOptions[].shippingOptions[].cost.otherCharges[].type  | type: ChargeType | description:  Type of additional cost. 
+                                    enum: HANDLING_FEE, INSURANCE
+                          - name: shippingInfo.carrierServiceOptions[].shippingOptions[].cost.price  | type: MultiCurrencyPrice | description:  Shipping price. 
+                      - name: shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations  | type: Array<DeliveryAllocation> | description:  Delivery solution allocations to different delivery carriers and delivery regions 
+                            - name: shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].applicableLineItems  | type: ApplicableLineItems | description:  Populated if the delivery solution is a partially supplied by this carrier. 
+                                - name: shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].applicableLineItems.lineItemIds  | type: Array<string> | description:  Line items that the delivery solution is for. 
+                            - name: 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 
+                                - name: shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryCarrier.appId  | type: string | description:  The carrier app id 
+                                - name: 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"`. 
+                            - name: shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryRegion  | type: Region | description:  The delivery region that are relevant for this delivery solution. 
+                                - name: shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryRegion._id  | type: string | description:  The delivery region id. 
+                                - name: shippingInfo.carrierServiceOptions[].shippingOptions[].deliveryAllocations[].deliveryRegion.name  | type: string | description:  The delivery region name. 
+                      - name: shippingInfo.carrierServiceOptions[].shippingOptions[].logistics  | type: DeliveryLogistics | description:  Delivery logistics. 
+                          - name: shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.deliveryTime  | type: string | description:  Expected delivery time, in free text. For example, "3-5 business days". 
+                          - name: 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". 
+                          - name: shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.pickupDetails  | type: PickupDetails | description:  Pickup details. 
+                              - name: shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.pickupDetails.address  | type: ApiAddress | description:  Pickup address. 
+                              - name: shippingInfo.carrierServiceOptions[].shippingOptions[].logistics.pickupDetails.pickupMethod  | type: PickupMethod | description:  Pickup method 
+                                  enum: PICKUP_POINT, STORE_PICKUP, UNKNOWN_METHOD
+                      - name: shippingInfo.carrierServiceOptions[].shippingOptions[].partial  | type: boolean | description:  If the delivery solution is a partial and doesn't apply to all items. 
+                      - name: 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". 
+          - name: shippingInfo.region  | type: ShippingRegion | description:  Shipping region. Based on the address provided. 
+              - name: shippingInfo.region._id  | type: string | description:  Shipping region GUID. 
+              - name: shippingInfo.region.name  | type: string | description:  Shipping region name. 
+          - name: shippingInfo.selectedCarrierServiceOption  | type: SelectedCarrierServiceOption | description:  Selected option out of the options allowed for the `region`. 
+              - name: shippingInfo.selectedCarrierServiceOption.carrierId  | type: string | description:  This carrier's unique GUID 
+              - name: shippingInfo.selectedCarrierServiceOption.code  | type: string | description:  Unique identifier of selected option. For example, "usps_std_overnight". 
+              - name: shippingInfo.selectedCarrierServiceOption.cost  | type: SelectedCarrierServiceOptionPrices | description:  Shipping costs. 
+                  - name: shippingInfo.selectedCarrierServiceOption.cost.price  | type: MultiCurrencyPrice | description:  Shipping price before discount and before tax. 
+                  - name: shippingInfo.selectedCarrierServiceOption.cost.taxDetails  | type: ItemTaxFullDetails | description:  Tax details. 
+                  - name: shippingInfo.selectedCarrierServiceOption.cost.totalDiscount  | type: MultiCurrencyPrice | description:  Shipping discount before tax. 
+                  - name: shippingInfo.selectedCarrierServiceOption.cost.totalPriceAfterTax  | type: MultiCurrencyPrice | description:  Total shipping price, after discount and after tax. 
+                  - name: shippingInfo.selectedCarrierServiceOption.cost.totalPriceBeforeTax  | type: MultiCurrencyPrice | description:  Total price of shipping after discounts (when relevant), and before tax. 
+              - name: shippingInfo.selectedCarrierServiceOption.deliveryAllocations  | type: Array<DeliveryAllocation> | description:  Delivery solution allocations to different delivery carriers and delivery regions 
+              - name: shippingInfo.selectedCarrierServiceOption.logistics  | type: DeliveryLogistics | description:  Delivery logistics. 
+              - name: shippingInfo.selectedCarrierServiceOption.partial  | type: boolean | description:  If the delivery solution is a partial and doesn't apply to all items. 
+              - name: 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) 
+              - name: 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". 
+          - name: shippingInfo.shippingDestination  | type: AddressWithContact | description:  Shipping address and contact details. 
+      - name: siteLanguage  | type: string | description:  Site language in which original values are shown. 
+      - name: taxExemptGroupId  | type: string | description:  Tax exempt group GUID to use for tax exemptions. 
+      - name: taxIncludedInPrice  | type: boolean | description:  Whether tax is included in line item prices. 
+      - name: taxSummary  | type: TaxSummary | description:  Tax summary. 
+          - name: taxSummary.taxableAmount  | type: MultiCurrencyPrice | description:  Amount for which tax is calculated, added from line items. 
+          - name: taxSummary.totalTax  | type: MultiCurrencyPrice | description:  Calculated tax, added from line items. 
+      - name: 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). 
+            - name: 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>`. 
+            - name: 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. 
+                enum: 
+                     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.
+                     WARNING: The user is allowed to move forward in the flow.
+            - name: violations[].target  | type: Target | description:  Target location on a checkout or cart page where the violation will be displayed. 
+                - ONE-OF: 
+                  - name: violations[].target.lineItem  | type: TargetLineItem | description:  Specific line item violation. 
+                      - name: violations[].target.lineItem._id  | type: string | description:  GUID of the line item containing the violation. 
+                      - name: violations[].target.lineItem.name  | type: NameInLineItem | description:  Location on a checkout or a cart page where the specific line item violation will be displayed. 
+                          enum: 
+                               LINE_ITEM_DEFAULT: Default location, in case no specific location is specified.
+                  - name: violations[].target.other  | type: Other | description:  General (other) violation. 
+                      - name: violations[].target.other.name  | type: NameInOther | description:  Location on a checkout or a cart page where a general (other) violation will be displayed. 
+                          enum: 
+                               OTHER_DEFAULT: Default location, in case no specific location is specified.
+      - name: weightUnit  | type: WeightUnit | description:  Weight measurement unit. Defaults to a site's weight unit. 
+          enum: 
+               KG: Kilograms.
+               LB: Pounds.
+               UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
+Possible Errors:
+  HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: GIFT_CARD_CODE_INVALID
+  HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: GIFT_CARD_NOT_FOUND
+  HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: INVALID_SELECTED_CARRIER_SERVICE_OPTION
+  HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: SELECTED_CARRIER_SERVICE_OPTION_NOT_FOUND
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: ERROR_COUPON_DOES_NOT_EXIST
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: ERROR_COUPON_HAS_EXPIRED
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: ERROR_COUPON_IS_NOT_ACTIVE_YET
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: ERROR_COUPON_USAGE_EXCEEDED
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: GIFT_CARD_EXPIRED
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: GIFT_CARD_DISABLED
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: GIFT_CARD_IS_EMPTY
+
+
+```
+</type_definition>
+</ecom_checkout_updateCheckout>