@wix/ditto-codegen-public 1.0.162 → 1.0.164

package/dist/docs-output/api-docs/ecom-cart-createCheckout-doc.txt

@@ -0,0 +1,155 @@
+<ecom_cart_createCheckout>
+<description>
+# Method name:
+
+ecom.cart.createCheckout(_id: string, options: CreateCheckoutOptions)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/ecom/cart/create-checkout
+
+# Method Description:
+
+Creates a checkout from a cart.
+
+If a checkout for the specified cart already exists, that checkout is
+updated with any new information from the cart.
+
+> **Note:** `channelType` is a required field.
+
+# Method Permissions:
+
+- ECOM.CREATE_CHECKOUT_FROM_CART
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## Create a checkout from a cart 
+
+```javascript
+/**************************************
+* Backend code - my-backend-file.web.js/ts *
+*************************************/
+
+import { Permissions, webMethod } from '@wix/web-methods';
+import { cart } from '@wix/ecom';
+
+export const myCreateCheckoutFunction = webMethod(Permissions.Anyone, async (cartId, options) => {
+ try {
+   const checkoutId = await cart.createCheckout(cartId, options);
+   console.log('Success! Checkout created, checkoutId:', checkoutId);
+   return checkoutId;
+ } catch (error) {
+   console.error(error);
+   // Handle the error
+ }
+});
+
+/*************
+* Page code *
+************/
+
+import { myCreateCheckoutFunction } from 'backend/my-backend-file.web';
+
+// Sample cartId:
+const cartId = '96a61a4b-6b61-47d1-a039-0213a8230ccd';
+
+// Sample options object:
+const options = {
+ // channelType is a required field
+ "channelType": "WEB",
+ "email": "janedoe@example.com",
+ "shippingAddress": {
+   "addressLine1": "235 West 23rd Street",
+   "addressLine2": "3rd floor",
+   "city": "New York",
+   "country": "US",
+   "postalCode": "10011",
+   "streetAddress": {
+     "name": "West 23rd Street",
+     "number": "235"
+   },
+   "subdivision": "US-NY"
+ }
+};
+
+myCreateCheckoutFunction(cartId, options)
+ .then((checkoutId) => {
+   console.log('Success! Checkout created, checkoutId:', checkoutId);
+   return checkoutId;
+ })
+ .catch((error) => {
+   console.error(error);
+   // Handle the error
+ });
+
+/* Promise resolves to:
+*
+* {"checkoutId": "a43420aa-986b-456a-a2f7-7ea5c80e9007"}
+*
+*/
+```
+
+
+</description>
+<type_definition>
+```
+Method: ecom.cart.createCheckout(_id, options)
+Description: Creates a checkout from a cart.  If a checkout for the specified cart already exists, that checkout is updated with any new information from the cart.  > **Note:** `channelType` is a required field.
+Method parameters:
+  param name:  _id | type: string | description:  Cart GUID. | required: true
+  param name:  options | type: CreateCheckoutOptions | description:  Checkout creation options. 
+      - name: billingAddress  | type: Address | description:  Billing address. Used for calculating tax if all the items in the cart are not shippable. 
+          - 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: channelType  | type: ChannelType | description:  __Required.__ Sales channel type. 
+          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: email  | type: string | description:  Required when setting a billing or shipping address if the site visitor isn't logged in. 
+      - name: selectedShippingOption  | type: SelectedShippingOption | description:  Selected shipping option. 
+          - name: carrierId  | type: string | description:  Carrier GUID. 
+          - name: code  | type: string | description:  Selected shipping option code. For example, "usps_std_overnight". 
+      - name: shippingAddress  | type: Address | description:  Shipping address. Used for calculating tax and shipping (when applicable). 
+Return type: PROMISE<CreateCheckoutResponse>
+      - name: checkoutId  | type: string | description:  The newly created checkout's GUID. 
+Possible Errors:
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: CUSTOM_LINE_ITEM_MUST_HAVE_EXACTLY_ONE_PROPERTIES_TYPE
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: CUSTOM_LINE_ITEM_ONLY_ACCEPTS_PAYMENTS_ONLINE_AND_OFFLINE
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: SITE_MUST_ACCEPT_PAYMENTS_TO_CREATE_CHECKOUT
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: LINE_ITEM_WITH_ZERO_QUANTITY
+
+
+```
+</type_definition>
+</ecom_cart_createCheckout>

package/dist/docs-output/api-docs/ecom-cart-deleteCart-doc.txt

@@ -0,0 +1,92 @@
+<ecom_cart_deleteCart>
+<description>
+# Method name:
+
+ecom.cart.deleteCart(_id: string)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/ecom/cart/delete-cart
+
+# Method Description:
+
+Deletes a cart.
+
+# Method Permissions:
+
+- ECOM.MODIFY_CARTS
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## Delete a cart 
+
+```javascript
+/**************************************
+* Backend code - my-backend-file.web.js/ts *
+*************************************/
+
+import { Permissions, webMethod } from '@wix/web-methods';
+import { cart } from '@wix/ecom';
+
+export const myDeleteCartFunction = webMethod(Permissions.Anyone, async (cartId) => {
+ try {
+   await cart.deleteCart(cartId);
+   console.log('Success! Deleted cart');
+   return;
+ } catch (error) {
+   console.error(error);
+   // Handle the error
+ }
+});
+
+/*************
+* Page code *
+************/
+
+import { myDeleteCartFunction } from 'backend/my-backend-file.web';
+
+// Sample cartId:
+const cartId = '96a61a4b-6b61-47d1-a039-0213a8230ccd';
+
+myDeleteCartFunction(cartId)
+ .then(() => {
+   console.log('Success! Deleted cart');
+   return;
+ })
+ .catch((error) => {
+   console.error(error);
+   // Handle the error
+ });
+```
+
+
+
+## default
+
+```javascript
+try {
+     const result = await cart.deleteCart("3e2dc453-4bb0-3b4b-800f-9864315dcec6");
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
+<type_definition>
+```
+Method: ecom.cart.deleteCart(_id)
+Description: Deletes a cart.
+Method parameters:
+  param name:  _id | type: string | description:  GUID of the cart to delete. | required: true
+Return type: PROMISE<void>
+
+```
+</type_definition>
+</ecom_cart_deleteCart>

package/dist/docs-output/api-docs/ecom-cart-getCart-doc.txt

@@ -0,0 +1,376 @@
+<ecom_cart_getCart>
+<description>
+# Method name:
+
+ecom.cart.getCart(_id: string)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/ecom/cart/get-cart
+
+# Method Description:
+
+Retrieves a cart.
+
+# Method Permissions:
+
+- ECOM.READ_CARTS
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## Get a cart 
+
+```javascript
+/**************************************
+* Backend code - my-backend-file.web.js/ts *
+*************************************/
+
+import { Permissions, webMethod } from '@wix/web-methods';
+import { cart } from '@wix/ecom';
+
+export const myGetCartFunction = webMethod(Permissions.Anyone, async (cartId) => {
+ try {
+   const retrievedCart = await cart.getCart(cartId);
+   console.log('Success! Retrieved cart:', retrievedCart);
+   return retrievedCart;
+ } catch (error) {
+   console.error(error);
+   // Handle the error
+ }
+});
+
+/*************
+* Page code *
+************/
+
+import { myGetCartFunction } from 'backend/my-backend-file.web';
+
+// Sample cartId:
+const cartId = '96a61a4b-6b61-47d1-a039-0213a8230ccd';
+
+myGetCartFunction(cartId)
+ .then((cart) => {
+   const cartCheckoutId = cart.checkoutId;
+   const formattedCartTotal = cart.subtotal.formattedAmount;
+   const numOfCartLineItems = cart.lineItems.length;
+
+   console.log('Success! Retrieved cart:', cart);
+   return cart;
+ })
+ .catch((error) => {
+   console.error(error);
+   // Handle the error
+ });
+
+/* Promise resolves to:
+*
+* {
+*   "_id": "96a61a4b-6b61-47d1-a039-0213a8230ccd",
+*   "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://example.wixsite.com",
+*       "price": {
+*         "amount": "10",
+*         "convertedAmount": "10",
+*         "formattedAmount": "€10.00",
+*         "formattedConvertedAmount": "€10.00"
+*       },
+*       "fullPrice": {
+*         "amount": "10",
+*         "convertedAmount": "10",
+*         "formattedAmount": "€10.00",
+*         "formattedConvertedAmount": "€10.00"
+*       },
+*       "priceBeforeDiscounts": {
+*         "amount": "10",
+*         "convertedAmount": "10",
+*         "formattedAmount": "€10.00",
+*         "formattedConvertedAmount": "€10.00"
+*       },
+*       "descriptionLines": [],
+*       "image": "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"
+*     }
+*   ],
+*   "buyerInfo": {
+*     "contactId": "f7dc17a6-825a-466e-a78e-c4abea0217db",
+*     "memberId": "c43190d2-eea3-493e-b6e8-f146850c6873"
+*   },
+*   "currency": "EUR",
+*   "conversionCurrency": "EUR",
+*   "buyerLanguage": "en",
+*   "siteLanguage": "en",
+*   "taxIncludedInPrices": false,
+*   "weightUnit": "KG",
+*   "subtotal": {
+*     "amount": "30",
+*     "convertedAmount": "30",
+*     "formattedAmount": "€30.00",
+*     "formattedConvertedAmount": "€30.00"
+*   },
+*   "appliedDiscounts": [],
+*   "inSync": false,
+*   "_createdDate": "2022-05-16T12:04:01.244Z",
+*   "_updatedDate": "2022-05-16T12:04:01.244Z"
+* }
+*
+*/
+```
+
+
+
+## default
+
+```javascript
+try {
+     const result = await cart.getCart("306911f6-3500-31a6-957c-010b5fec5fae");
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
+<type_definition>
+```
+Method: ecom.cart.getCart(_id)
+Description: Retrieves a cart.
+Method parameters:
+  param name:  _id | type: string | description:  Cart GUID. | required: true
+Return type: PROMISE<Cart>
+      - name: _createdDate  | type: Date | description:  Date and time the cart was created. 
+      - name: _id  | type: string | description:  Cart GUID. 
+      - name: _updatedDate  | type: Date | description:  Date and time the cart was updated. 
+      - name: appliedDiscounts  | type: Array<CartDiscount> | description:  Cart discounts. 
+            - ONE-OF: 
+              - name: appliedDiscounts[].coupon  | type: Coupon | description:  Coupon details. 
+                  - name: appliedDiscounts[].coupon._id  | type: string | description:  Coupon GUID. 
+                  - name: appliedDiscounts[].coupon.code  | type: string | description:  Coupon code. 
+              - name: appliedDiscounts[].merchantDiscount  | type: MerchantDiscount | description:  Merchant discount. 
+                  - name: appliedDiscounts[].merchantDiscount.amount  | type: MultiCurrencyPrice | description:  Discount value. 
+                      - name: appliedDiscounts[].merchantDiscount.amount.amount  | type: string | description:  Amount. 
+                      - name: appliedDiscounts[].merchantDiscount.amount.convertedAmount  | type: string | description:  Converted amount. 
+                      - name: appliedDiscounts[].merchantDiscount.amount.formattedAmount  | type: string | description:  Amount formatted with currency symbol. 
+                      - name: appliedDiscounts[].merchantDiscount.amount.formattedConvertedAmount  | type: string | description:  Converted amount formatted with currency symbol. 
+      - name: businessLocationId  | type: string | description:  The business location GUID associated with the cart.  To learn more, see the Locations API. 
+      - name: buyerInfo  | type: BuyerInfo | description:  Buyer information. 
+          - name: buyerInfo.contactId  | type: string | description:  Contact GUID. 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 the buyer is a site member. 
+            - name: buyerInfo.userId  | type: string | description:  User GUID. If the buyer, or cart owner, is a Wix user. 
+            - name: buyerInfo.visitorId  | type: string | description:  Visitor GUID. If the buyer is **not** a site 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: checkoutId  | type: string | description:  GUID of the checkout that originated from this cart. 
+      - name: contactInfo  | type: AddressWithContact | description:  Contact info. 
+          - name: contactInfo.address  | type: Address | description:  Address. 
+              - name: contactInfo.address.addressLine1  | type: string | description:  Main address line (usually street name and number). 
+              - name: contactInfo.address.addressLine2  | type: string | description:  Free text providing more detailed address info. Usually contains apt, suite, floor. 
+              - name: contactInfo.address.city  | type: string | description:  City name. 
+              - name: contactInfo.address.country  | type: string | description:  Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. 
+              - name: contactInfo.address.countryFullname  | type: string | description:  Country's full name. 
+              - name: contactInfo.address.location  | type: AddressLocation | description:  Geocode object containing latitude and longitude coordinates. 
+                  - name: contactInfo.address.location.latitude  | type: number | description:  Address latitude. 
+                  - name: contactInfo.address.location.longitude  | type: number | description:  Address longitude. 
+              - name: contactInfo.address.postalCode  | type: string | description:  Postal or zip code. 
+              - name: contactInfo.address.streetAddress  | type: StreetAddress | description:  Street address. 
+                  - name: contactInfo.address.streetAddress.name  | type: string | description:  Street name. 
+                  - name: contactInfo.address.streetAddress.number  | type: string | description:  Street number. 
+              - name: contactInfo.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: contactInfo.address.subdivisionFullname  | type: string | description:  Subdivision full-name. 
+          - name: contactInfo.contactDetails  | type: FullAddressContactDetails | description:  Contact details. 
+              - name: contactInfo.contactDetails.company  | type: string | description:  Company name. 
+              - name: contactInfo.contactDetails.firstName  | type: string | description:  First name. 
+              - name: contactInfo.contactDetails.lastName  | type: string | description:  Last name. 
+              - name: contactInfo.contactDetails.phone  | type: string | description:  Phone number. 
+              - name: contactInfo.contactDetails.vatId  | type: VatId | description:  Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. 
+                  - name: contactInfo.contactDetails.vatId._id  | type: string | description:  Customer's tax GUID. 
+                  - name: contactInfo.contactDetails.vatId.type  | type: VatType | 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: 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: 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: extendedFields  | type: ExtendedFields | description:  Fields extended by data extensions 
+          - 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: lineItems  | type: Array<LineItem> | description:  Line 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. Holds 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: 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 displaying the cart, checkout and order. 
+            - 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[].image  | type: string | description:  Line item image details. 
+            - 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 price **after** catalog-defined discount and line item discounts. 
+            - 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. 
+            - 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 is the same 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[].selectedMembership  | type: SelectedMembership | description:  Selected membership to be used as payment for this item. Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`. This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`. 
+                - name: lineItems[].selectedMembership._id  | type: string | description:  Membership GUID. 
+                - name: lineItems[].selectedMembership.appId  | type: string | description:  GUID of the app providing this payment option. 
+            - 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[].taxGroupId  | type: string | description:  Tax group GUID 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[].url  | type: string | description:  URL to the item's page on the site. 
+      - 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`. 
+      - 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: purchaseFlowId  | type: string | description:  Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order. 
+      - name: revision  | type: string | description:  Revision number, which increments by 1 each time the Cart is updated. 
+      - name: selectedShippingOption  | type: SelectedShippingOption | description:  Selected shipping option. 
+          - name: selectedShippingOption.carrierId  | type: string | description:  Carrier GUID. 
+          - name: selectedShippingOption.code  | type: string | description:  Selected shipping option code. For example, "usps_std_overnight". 
+      - name: siteLanguage  | type: string | description:  Site language in which original values are displayed. 
+      - name: taxIncludedInPrices  | type: boolean | description:  Whether tax is included in line item prices. 
+      - name: weightUnit  | type: WeightUnit | description:  Weight measurement unit - defaults to site's weight unit. 
+          enum: 
+               KG: Kilograms.
+               LB: Pounds.
+               UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
+
+```
+</type_definition>
+</ecom_cart_getCart>