> To build or manage a Wix site with an AI agent, follow https://www.wix.com/headless/skill.md
> It builds a new Wix site or puts your own site online, from a prompt, and keeps changing it afterwards. The pages are code in any web technology, and Wix runs the backend.
> It works through the Wix plugin (the Wix MCP and the Wix skills), the Wix CLI or no Wix login, and puts the site live on Wix hosting or on another host.
> Business features include a store, bookings, events and tickets, a restaurant, a blog, forms, members and many more.
> Read the Wix skills online at https://www.wix.com/skills
> 
> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - If a reference page seems to be missing its schema (parameters, return types, or type definitions), append `?schema=true` to its `.md` URL (e.g. `https://dev.wix.com/docs/contexts/contexts/stores/category-info/use-category-info-context.md?schema=true`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# GetEcommerceSettings

# Package: settings

# Namespace: EcommerceSettingsService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/settings/ecommerce-settings/get-ecommerce-settings.md

## Permission Scopes:
Read eCommerce - all read permissions: SCOPE.DC-ECOM-MEGA.READ-ECOM

## Introduction

Retrieves a site's eCommerce settings.

The response includes only the fields specified in `fields`. If a requested field can't be retrieved, it's left out of `ecommerceSettings` and listed in `errors`. The other requested fields are still returned.

---

## REST API

### Schema

```
 Method: getEcommerceSettings
 Description: Retrieves a site's eCommerce settings.  The response includes only the fields specified in `fields`. If a requested field can't be retrieved, it's left out of `ecommerceSettings` and listed in `errors`. The other requested fields are still returned.
 URL: https://www.wixapis.com/_api/ecommerce-settings/v1/ecommerce-settings
 Method: GET
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  fields
 Method parameters: 
   query param name: fields | type: array<fields> | description: Settings to include in the response. | required: true | validation: minItems 1, maxItems 25
                 - enum:
                 -     ADDITIONAL_FEES_SERVICE_PLUGIN: Additional Fees service plugin configuration. Returned in `additionalFeesServicePlugin`.
                 -     VALIDATIONS_SERVICE_PLUGIN: Validations service plugin configuration. Returned in `validationsServicePlugin`.
                 -     TAX: Tax configuration. Returned in `tax`.
                 -     DISCOUNT_RULES: Discount rules configuration. Returned in `discountRules`.
                 -     CHECKOUT: Checkout settings. Returned in `checkout`.
                 -     DELIVERY: Delivery destinations. Returned in `delivery`.
                 -     PREMIUM_SITE: Premium status: whether the site has a premium plan that supports accepting payments. Returned in `premiumSite`.
                 -     BUSINESS_INFO: Business information. Returned in `businessInfo`.
                 -     PURCHASE_RECOMMENDATIONS_SERVICE_PLUGIN: Purchase recommendations service plugin configuration. Returned in `purchaseRecommendationsServicePlugin`.
                 -     BUSINESS_LOCALE: Business locale. Returned in `businessLocale`.
 Return type: GetEcommerceSettingsResponse
  - name: ecommerceSettings | type: EcommerceSettings | description: Retrieved eCommerce settings.  
     - name: additionalFeesServicePlugin | type: ServicePluginConfiguration | description: Additional Fees service plugin configuration.  
        - name: activeProviders | type: array<ActiveProvider> | description: Apps that implement the service plugin and are active on the site.  | validation: maxItems 100
           - name: appId | type: string | description: App GUID of the provider.  | validation: format GUID
           - name: triggerFlows | type: array<TriggerFlow> | description: Flows that trigger the provider.  | validation: maxItems 100
                 - enum:
                 -     CART: Provider is triggered during cart interactions.
                 -     CHECKOUT: Provider is triggered during the checkout process.
     - name: validationsServicePlugin | type: ServicePluginConfiguration | description: Validations service plugin configuration.  
     - name: purchaseRecommendationsServicePlugin | type: ServicePluginConfiguration | description: Purchase recommendations service plugin configuration.  
     - name: tax | type: TaxConfiguration | description: Tax configuration.  
        - name: configured | type: boolean | description: Whether the site has at least one tax region. Learn more about the [Tax Regions API](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/extensions/tax/tax-regions/introduction.md).  
        - name: taxIncludedInItemPrices | type: boolean | description: Whether tax is included in item prices. Learn more about [tax inclusion in item prices](https://support.wix.com/en/article/including-tax-in-the-product-price).  
     - name: discountRules | type: DiscountRulesConfiguration | description: Discount rules configuration.  
        - name: active | type: boolean | description: Whether at least one discount rule that applies automatically is active now. A rule counts when it's active and the current time is within its active time frame, if it has one. Learn more about the [Discount Rules API](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/extensions/discounts/discount-rules/introduction.md).  
     - name: checkout | type: CheckoutSettings | description: Checkout settings. Learn more about the [Checkout Settings API](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/settings/checkout-settings/introduction.md).  
        - name: checkoutPolicies | type: CheckoutPolicies | description: Checkout policies.  
           - name: termsAndConditions | type: TermsAndConditionsPolicy | description: Terms and conditions.  
              - name: visible | type: boolean | description: Whether the terms and conditions policy is visible to the customer in the checkout page. <br><br>  Default: `false`  
              - name: content | type: string | description: Terms and conditions policy content.  
           - name: privacyPolicy | type: PrivacyPolicy | description: Privacy policy.  
              - name: visible | type: boolean | description: Whether the privacy policy is visible to the customer in the checkout page. <br><br>  Default: `false`  
              - name: content | type: string | description: Privacy policy content.  
           - name: returnPolicy | type: ReturnPolicy | description: Return policy.  
              - name: visible | type: boolean | description: Whether the return policy is visible to the customer in the checkout page. <br><br>  Default: `false`  
              - name: content | type: string | description: Return policy content.  
           - name: digitalItemPolicy | type: DigitalItemPolicy | description: Digital item policy.  
              - name: visible | type: boolean | description: Whether the digital item policy is visible to the customer in the checkout page. <br><br>  Default: `false`  
              - name: content | type: string | description: Digital item policy content.  
           - name: contactUs | type: ContactUsPolicy | description: "Contact us" information.  
              - name: visible | type: boolean | description: Whether the contact us policy is visible to the customer in the checkout page. <br><br>  Default: `false`  
              - name: content | type: string | description: Contact us policy content.  
           - name: customPolicy | type: CustomCheckoutPolicy | description: Custom policy.  
              - name: visible | type: boolean | description: Whether the custom policy is visible to the customer in the checkout page. <br><br>  Default: `false`  
              - name: content | type: string | description: Custom policy content.  
              - name: title | type: string | description: Custom policy title.  
        - name: checkoutFields | type: CheckoutFields | description: Settings that apply to checkout fields and the checkout process.  
           - name: subscriptionCheckbox | type: SubscriptionCheckboxField | description: Subscription checkbox. <br><br>  Controls the marketing consent checkbox shown to the buyer at checkout. By default, a single checkbox lets the buyer opt in to both email and SMS marketing at once. When `subscriptionCheckbox.splitByChannel` is `true`, checkout instead shows two separate checkboxes - one for email, one for SMS - so the buyer can opt into each channel independently.  
              - name: visible | type: boolean | description: Whether the checkbox is visible to the customer.  Default: `false`  
              - name: checkedByDefault | type: boolean | description: Whether the checkbox is checked by default.  Default: `false`  
              - name: splitByChannel | type: boolean | description: Whether checkout shows two separate opt-in checkboxes for email and SMS instead of a single combined checkbox. Only takes effect when `visible` is `true`. Both checkboxes are always shown together - a buyer can't be shown just one channel. `checkedByDefault` applies to both checkboxes equally: when `true`, both start pre-checked.  Default: `false`  
           - name: policyAgreementCheckbox | type: CheckboxField | description: Policy agreement checkbox. <br><br>  Defaults: + `visible`: `false` + `checkedByDefault`: `false`  
              - name: visible | type: boolean | description: Whether the checkbox is visible to the customer.  
              - name: checkedByDefault | type: boolean | description: Whether the checkbox is checked by default.  
           - name: giftCardRedeemEnabled | type: boolean | description: Whether the ability to redeem a gift card is enabled. <br><br>  Default: `false`  
           - name: mitEnabled | type: boolean | description: Whether to allow for MIT transactions. <br><br>  Default: `false`  
           - name: delayCaptureEnabled | type: boolean | description: Whether to allow for Auth & Capture transactions. <br><br>  Default: `false`  
           - name: captureBeforeExpiryEnabled | type: boolean | description: Whether to automatically capture the transaction before the authorization expires.  Default: `true` >**Note:** this setting is only relevant when `delay_capture_enabled: true`.  
        - name: checkoutBrand | type: CheckoutBrand | description: Checkout brand settings.  
           - name: header | type: CheckoutHeader | description: Checkout header.  
              - name: text | type: string | description: Textual content to be included in the header (e.g. Business Name)  | validation: maxLength 55
              - name: textColor | type: string | description: Text color hex code.  | validation: format COLOR_HEX
              - name: logo | type: Logo | description: Specifications for when a logo is included in the header.  
                 - name: size | type: LogoSize | description: Size of the logo.  
                         - enum: SMALL, MEDIUM, LARGE
              - name: alignment | type: Alignment | description: Alignment within the header.  >**Note:** `SIDE` alignment is decided depending on the locale's language. For example, scripts like Hebrew and Arabic will automatically align right-to-left.  
                     - enum: SIDE, CENTER
              - name: displayCheckoutLabel | type: boolean | description: Whether to display the 'Checkout' label within the header. Depending on the locale, the label may be translated.  
              - name: continueShopping | type: ContinueShopping | description: Continue shopping specifications.  
                 - name: hidden | type: boolean | description: Whether the continue shopping element is hidden.  
                 - name: displayType | type: DisplayType | description: Display type for the continue shopping element.  
                         - enum: TEXT, ICON
              - name: backgroundFill | type: BackgroundFill | description: Background fill specifications.  
                 - ONE-OF: 
                    - name: color | type: string | description: Background color hex code.  | validation: format COLOR_HEX
                    - name: image | type: Image | description: Background image.  
                       - name: id | type: string | description: WixMedia image GUID.  
                       - name: url | type: string | description: Image URL.  
                       - name: height | type: integer | description: Original image height.  | read-only: true 
                       - name: width | type: integer | description: Original image width.  | read-only: true 
                       - name: altText | type: string | description: Image alt text.  
                       - name: filename | type: string | description: Image filename.  | read-only: true 
              - name: dividerColor | type: string | description: Color hex code of the full-width divider rule below the header.  | validation: format COLOR_HEX
           - name: mainSection | type: CheckoutMain | description: Main checkout area branding.  
              - name: formBackgroundFill | type: BackgroundFill | description: Background fill of the checkout form.  
              - name: summaryBackgroundFill | type: BackgroundFill | description: Background fill of the checkout summary.  
              - name: dividerColor | type: string | description: Color hex code of the dividers.  | validation: format COLOR_HEX
              - name: tintedBoxColor | type: string | description: Color hex code of the tinted boxes (e.g. show-summary box). Stored and applied solid (no opacity).  | validation: format COLOR_HEX
              - name: expressButtonsCornerRadius | type: ExpressButtonsCornerRadius | description: Corner radius style applied to the express checkout buttons.  
                     - enum: RECTANGLE, PILL
              - name: cornerRadius | type: integer | description: Corner radius applied everywhere except the express checkout buttons — line-item images and form-field inputs.  | validation: minimum 0, maximum 100, format int32
           - name: footer | type: CheckoutFooter | description: Checkout footer branding.  
              - name: backgroundFill | type: BackgroundFill | description: Background fill of the footer.  
              - name: dividerColor | type: string | description: Color hex code of the full-width divider rule above the footer.  | validation: format COLOR_HEX
           - name: global | type: CheckoutGlobal | description: Global checkout branding.  
              - name: selectionColor | type: string | description: Color hex code of selection controls (radios/checkboxes).  | validation: format COLOR_HEX
              - name: placeOrderButtonColor | type: string | description: Color hex code of the place order button.  | validation: format COLOR_HEX
              - name: buttonColor | type: string | description: Color hex code of the buttons.  | validation: format COLOR_HEX
        - name: createdDate | type: string | description: Date and time the checkout settings were created.  | read-only: true | validation: format date-time
        - name: updatedDate | type: string | description: Date and time the checkout settings were updated.  | read-only: true | validation: format date-time
        - name: checkoutBillingFields | type: CheckoutBillingFields | description: Billing information required to complete the checkout.  
             - enum:
             -     All_FIELDS: All billing information fields are required.
             -     MINIMUM_REQUIRED_FIELDS: Minimum required fields as defined by the country, payment method and payment provider.
     - name: delivery | type: DeliveryConfiguration | description: Destinations the site delivers to, and their delivery properties.  
        - name: countries | type: array<CountryDeliveryProperties> | description: Countries the site delivers to, with their delivery destination properties.  When `restOfWorld` isn't returned, a country without `deliveryDestinationProperties` is delivered to only in the subdivisions listed in its `subdivisions`.  | validation: maxItems 195
           - name: country | type: string | description: 2-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.  | validation: format COUNTRY
           - name: deliveryDestinationProperties | type: DeliveryDestinationProperties | description: Delivery destination properties for the country.  
              - name: postalCodeRequired | type: boolean | description: Whether a postal code is required for delivery to this destination.  
              - name: pickupOnly | type: boolean | description: Whether only pickup is available at this destination.  
           - name: subdivisions | type: array<SubdivisionDeliveryProperties> | description: List of subdivisions and their delivery destination properties.  | validation: maxItems 100
              - 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.  | validation: minLength 1, maxLength 5
              - name: deliveryDestinationProperties | type: DeliveryDestinationProperties | description: Delivery destination properties for the subdivision.  
        - name: restOfWorld | type: DeliveryDestinationProperties | description: Delivery destination properties for every destination that `countries` doesn't cover: countries that aren't listed, and unlisted subdivisions of a country without `deliveryDestinationProperties`.  Returned only when the site delivers to the rest of the world.  
     - name: premiumSite | type: boolean | description: Whether the site has a premium plan that supports accepting payments.  
     - name: businessInfo | type: BusinessProperties | description: Business information, such as the business name, address, and contact details.  
        - name: currency | type: string | description: Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. Payment currency for the business (default is 'USD').  | validation: format CURRENCY
        - name: language | type: string | description: Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used by the business for site content, emails, notifications, etc (default is 'en').  | validation: format LANGUAGE
        - name: locale | type: Locale | description: Locale for date, number, and measurement formatting (default is `en-US`).  
           - name: language | type: string | description: Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.  | validation: format LANGUAGE
           - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.  | validation: format COUNTRY
        - name: address | type: Address | description: Physical address of the business.  
           - name: country | type: string | description: Country code.  | validation: format COUNTRY
           - name: subdivision | type: string | description: Subdivision code in ISO 3166-2 format, e.g., "US-NY".  
           - name: city | type: string | description: City name.  
           - name: postalCode | type: string | description: Zip/postal code.  
           - name: streetAddress | type: StreetAddress | description: Street name and number.  
              - name: number | type: string | description: Street number.  
              - name: name | type: string | description: Street name.  
           - name: addressLine | type: string | description: Main address line, usually street and number as free text.  
        - name: name | type: string | description: Business name.  
        - name: email | type: string | description: Business email address.  
        - name: phone | type: string | description: Business phone number.  
        - name: fax | type: string | description: Business fax number.  
        - name: logo | type: string | description: Path to the business logo in Wix Media.  
        - name: timeZone | type: string | description: Business time zone.  
        - name: siteDisplayName | type: string | description: Site display name.  
     - name: businessLocale | type: BusinessLocale | description: Business locale: currency, language, locale, weight unit, and unit system.  
        - name: currency | type: string | description: Currency the business accepts payments in. Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.  Default: `USD`  | validation: format CURRENCY
        - name: language | type: string | description: Language the business uses for site content, emails, and notifications. Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.  Default: `en`  | validation: format LANGUAGE
        - name: locale | type: Locale | description: Locale for date, number, and measurement formatting.  Default: `en-US`  
        - name: weightUnit | type: WeightUnit | description: Weight unit, based on locale.  
             - enum:
             -     UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
             -     KG: Kilograms.
             -     LB: Pounds.
        - name: unitSystem | type: UnitSystem | description: Unit system, based on locale.  
             - enum:
             -     IMPERIAL: Imperial unit system. For example, inches, feet, pounds, ounces, etc.
             -     METRIC: Metric unit system. For example, centimeters, kilometers, grams, etc.
  - name: errors | type: array<Error> | description: Requested fields that couldn't be retrieved. These fields are left out of `ecommerceSettings`.  
     - name: requestedField | type: RequestedFields | description: Requested field that couldn't be retrieved.  
         - enum:
         -     ADDITIONAL_FEES_SERVICE_PLUGIN: Additional Fees service plugin configuration. Returned in `additionalFeesServicePlugin`.
         -     VALIDATIONS_SERVICE_PLUGIN: Validations service plugin configuration. Returned in `validationsServicePlugin`.
         -     TAX: Tax configuration. Returned in `tax`.
         -     DISCOUNT_RULES: Discount rules configuration. Returned in `discountRules`.
         -     CHECKOUT: Checkout settings. Returned in `checkout`.
         -     DELIVERY: Delivery destinations. Returned in `delivery`.
         -     PREMIUM_SITE: Premium status: whether the site has a premium plan that supports accepting payments. Returned in `premiumSite`.
         -     BUSINESS_INFO: Business information. Returned in `businessInfo`.
         -     PURCHASE_RECOMMENDATIONS_SERVICE_PLUGIN: Purchase recommendations service plugin configuration. Returned in `purchaseRecommendationsServicePlugin`.
         -     BUSINESS_LOCALE: Business locale. Returned in `businessLocale`.

 Possible Errors:
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: SITE_NOT_FOUND | Description: Couldn't find the site.


```

### Examples

### Check whether a store is ready to sell
Retrieves the premium status and tax configuration to check whether the store is ready to sell.

```curl
curl -X GET \
'https://www.wixapis.com/ecom/v1/ecommerce-settings?fields=PREMIUM_SITE&fields=TAX' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json'
```

### Retrieve the business locale
Retrieves the currency, language, and locale to format prices for the site.

```curl
curl -X GET \
'https://www.wixapis.com/ecom/v1/ecommerce-settings?fields=BUSINESS_LOCALE' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json'
```

### Retrieve the destinations a site delivers to
Retrieves the delivery configuration. In this response, the site delivers to the US and, through `restOfWorld`, to every other country.

```curl
curl -X GET \
'https://www.wixapis.com/ecom/v1/ecommerce-settings?fields=DELIVERY' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.ecom.ecommerceSettings.getEcommerceSettings(fields)
 Description: Retrieves a site's eCommerce settings.  The response includes only the fields specified in `fields`. If a requested field can't be retrieved, it's left out of `ecommerceSettings` and listed in `errors`. The other requested fields are still returned.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  fields
 Method parameters: 
   param name: fields | type: array<RequestedFields> | description: Settings to include in the response. | required: true | validation: minItems 1, maxItems 25
                 - enum:
                 -     ADDITIONAL_FEES_SERVICE_PLUGIN: Additional Fees service plugin configuration. Returned in `additionalFeesServicePlugin`.
                 -     VALIDATIONS_SERVICE_PLUGIN: Validations service plugin configuration. Returned in `validationsServicePlugin`.
                 -     TAX: Tax configuration. Returned in `tax`.
                 -     DISCOUNT_RULES: Discount rules configuration. Returned in `discountRules`.
                 -     CHECKOUT: Checkout settings. Returned in `checkout`.
                 -     DELIVERY: Delivery destinations. Returned in `delivery`.
                 -     PREMIUM_SITE: Premium status: whether the site has a premium plan that supports accepting payments. Returned in `premiumSite`.
                 -     BUSINESS_INFO: Business information. Returned in `businessInfo`.
                 -     PURCHASE_RECOMMENDATIONS_SERVICE_PLUGIN: Purchase recommendations service plugin configuration. Returned in `purchaseRecommendationsServicePlugin`.
                 -     BUSINESS_LOCALE: Business locale. Returned in `businessLocale`.
 Return type: PROMISE<GetEcommerceSettingsResponse>
  - name: ecommerceSettings | type: EcommerceSettings | description: Retrieved eCommerce settings.  
     - name: additionalFeesServicePlugin | type: ServicePluginConfiguration | description: Additional Fees service plugin configuration.  
        - name: activeProviders | type: array<ActiveProvider> | description: Apps that implement the service plugin and are active on the site.  | validation: maxItems 100
           - name: appId | type: string | description: App GUID of the provider.  | validation: format GUID
           - name: triggerFlows | type: array<TriggerFlow> | description: Flows that trigger the provider.  | validation: maxItems 100
                 - enum:
                 -     CART: Provider is triggered during cart interactions.
                 -     CHECKOUT: Provider is triggered during the checkout process.
     - name: validationsServicePlugin | type: ServicePluginConfiguration | description: Validations service plugin configuration.  
     - name: purchaseRecommendationsServicePlugin | type: ServicePluginConfiguration | description: Purchase recommendations service plugin configuration.  
     - name: tax | type: TaxConfiguration | description: Tax configuration.  
        - name: configured | type: boolean | description: Whether the site has at least one tax region. Learn more about the [Tax Regions API](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/extensions/tax/tax-regions/introduction.md).  
        - name: taxIncludedInItemPrices | type: boolean | description: Whether tax is included in item prices. Learn more about [tax inclusion in item prices](https://support.wix.com/en/article/including-tax-in-the-product-price).  
     - name: discountRules | type: DiscountRulesConfiguration | description: Discount rules configuration.  
        - name: active | type: boolean | description: Whether at least one discount rule that applies automatically is active now. A rule counts when it's active and the current time is within its active time frame, if it has one. Learn more about the [Discount Rules API](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/extensions/discounts/discount-rules/introduction.md).  
     - name: checkout | type: CheckoutSettings | description: Checkout settings. Learn more about the [Checkout Settings API](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/settings/checkout-settings/introduction.md).  
        - name: checkoutPolicies | type: CheckoutPolicies | description: Checkout policies.  
           - name: termsAndConditions | type: TermsAndConditionsPolicy | description: Terms and conditions.  
              - name: visible | type: boolean | description: Whether the terms and conditions policy is visible to the customer in the checkout page. <br><br>  Default: `false`  
              - name: content | type: string | description: Terms and conditions policy content.  
           - name: privacyPolicy | type: PrivacyPolicy | description: Privacy policy.  
              - name: visible | type: boolean | description: Whether the privacy policy is visible to the customer in the checkout page. <br><br>  Default: `false`  
              - name: content | type: string | description: Privacy policy content.  
           - name: returnPolicy | type: ReturnPolicy | description: Return policy.  
              - name: visible | type: boolean | description: Whether the return policy is visible to the customer in the checkout page. <br><br>  Default: `false`  
              - name: content | type: string | description: Return policy content.  
           - name: digitalItemPolicy | type: DigitalItemPolicy | description: Digital item policy.  
              - name: visible | type: boolean | description: Whether the digital item policy is visible to the customer in the checkout page. <br><br>  Default: `false`  
              - name: content | type: string | description: Digital item policy content.  
           - name: contactUs | type: ContactUsPolicy | description: "Contact us" information.  
              - name: visible | type: boolean | description: Whether the contact us policy is visible to the customer in the checkout page. <br><br>  Default: `false`  
              - name: content | type: string | description: Contact us policy content.  
           - name: customPolicy | type: CustomCheckoutPolicy | description: Custom policy.  
              - name: visible | type: boolean | description: Whether the custom policy is visible to the customer in the checkout page. <br><br>  Default: `false`  
              - name: content | type: string | description: Custom policy content.  
              - name: title | type: string | description: Custom policy title.  
        - name: checkoutFields | type: CheckoutFields | description: Settings that apply to checkout fields and the checkout process.  
           - name: subscriptionCheckbox | type: SubscriptionCheckboxField | description: Subscription checkbox. <br><br>  Controls the marketing consent checkbox shown to the buyer at checkout. By default, a single checkbox lets the buyer opt in to both email and SMS marketing at once. When `subscriptionCheckbox.splitByChannel` is `true`, checkout instead shows two separate checkboxes - one for email, one for SMS - so the buyer can opt into each channel independently.  
              - name: visible | type: boolean | description: Whether the checkbox is visible to the customer.  Default: `false`  
              - name: checkedByDefault | type: boolean | description: Whether the checkbox is checked by default.  Default: `false`  
              - name: splitByChannel | type: boolean | description: Whether checkout shows two separate opt-in checkboxes for email and SMS instead of a single combined checkbox. Only takes effect when `visible` is `true`. Both checkboxes are always shown together - a buyer can't be shown just one channel. `checkedByDefault` applies to both checkboxes equally: when `true`, both start pre-checked.  Default: `false`  
           - name: policyAgreementCheckbox | type: CheckboxField | description: Policy agreement checkbox. <br><br>  Defaults: + `visible`: `false` + `checkedByDefault`: `false`  
              - name: visible | type: boolean | description: Whether the checkbox is visible to the customer.  
              - name: checkedByDefault | type: boolean | description: Whether the checkbox is checked by default.  
           - name: giftCardRedeemEnabled | type: boolean | description: Whether the ability to redeem a gift card is enabled. <br><br>  Default: `false`  
           - name: mitEnabled | type: boolean | description: Whether to allow for MIT transactions. <br><br>  Default: `false`  
           - name: delayCaptureEnabled | type: boolean | description: Whether to allow for Auth & Capture transactions. <br><br>  Default: `false`  
           - name: captureBeforeExpiryEnabled | type: boolean | description: Whether to automatically capture the transaction before the authorization expires.  Default: `true` >**Note:** this setting is only relevant when `delay_capture_enabled: true`.  
        - name: checkoutBrand | type: CheckoutBrand | description: Checkout brand settings.  
           - name: header | type: CheckoutHeader | description: Checkout header.  
              - name: text | type: string | description: Textual content to be included in the header (e.g. Business Name)  | validation: maxLength 55
              - name: textColor | type: string | description: Text color hex code.  | validation: format COLOR_HEX
              - name: logo | type: Logo | description: Specifications for when a logo is included in the header.  
                 - name: size | type: LogoSize | description: Size of the logo.  
                         - enum: SMALL, MEDIUM, LARGE
              - name: alignment | type: Alignment | description: Alignment within the header.  >**Note:** `SIDE` alignment is decided depending on the locale's language. For example, scripts like Hebrew and Arabic will automatically align right-to-left.  
                     - enum: SIDE, CENTER
              - name: displayCheckoutLabel | type: boolean | description: Whether to display the 'Checkout' label within the header. Depending on the locale, the label may be translated.  
              - name: continueShopping | type: ContinueShopping | description: Continue shopping specifications.  
                 - name: hidden | type: boolean | description: Whether the continue shopping element is hidden.  
                 - name: displayType | type: DisplayType | description: Display type for the continue shopping element.  
                         - enum: TEXT, ICON
              - name: backgroundFill | type: BackgroundFill | description: Background fill specifications.  
                 - ONE-OF: 
                    - name: color | type: string | description: Background color hex code.  | validation: format COLOR_HEX
                    - name: image | type: string | description: Background image.  
              - name: dividerColor | type: string | description: Color hex code of the full-width divider rule below the header.  | validation: format COLOR_HEX
           - name: mainSection | type: CheckoutMain | description: Main checkout area branding.  
              - name: formBackgroundFill | type: BackgroundFill | description: Background fill of the checkout form.  
              - name: summaryBackgroundFill | type: BackgroundFill | description: Background fill of the checkout summary.  
              - name: dividerColor | type: string | description: Color hex code of the dividers.  | validation: format COLOR_HEX
              - name: tintedBoxColor | type: string | description: Color hex code of the tinted boxes (e.g. show-summary box). Stored and applied solid (no opacity).  | validation: format COLOR_HEX
              - name: expressButtonsCornerRadius | type: ExpressButtonsCornerRadius | description: Corner radius style applied to the express checkout buttons.  
                     - enum: RECTANGLE, PILL
              - name: cornerRadius | type: integer | description: Corner radius applied everywhere except the express checkout buttons — line-item images and form-field inputs.  | validation: minimum 0, maximum 100, format int32
           - name: footer | type: CheckoutFooter | description: Checkout footer branding.  
              - name: backgroundFill | type: BackgroundFill | description: Background fill of the footer.  
              - name: dividerColor | type: string | description: Color hex code of the full-width divider rule above the footer.  | validation: format COLOR_HEX
           - name: global | type: CheckoutGlobal | description: Global checkout branding.  
              - name: selectionColor | type: string | description: Color hex code of selection controls (radios/checkboxes).  | validation: format COLOR_HEX
              - name: placeOrderButtonColor | type: string | description: Color hex code of the place order button.  | validation: format COLOR_HEX
              - name: buttonColor | type: string | description: Color hex code of the buttons.  | validation: format COLOR_HEX
        - name: _createdDate | type: Date | description: Date and time the checkout settings were created.  | read-only: true 
        - name: _updatedDate | type: Date | description: Date and time the checkout settings were updated.  | read-only: true 
        - name: checkoutBillingFields | type: CheckoutBillingFields | description: Billing information required to complete the checkout.  
             - enum:
             -     All_FIELDS: All billing information fields are required.
             -     MINIMUM_REQUIRED_FIELDS: Minimum required fields as defined by the country, payment method and payment provider.
     - name: delivery | type: DeliveryConfiguration | description: Destinations the site delivers to, and their delivery properties.  
        - name: countries | type: array<CountryDeliveryProperties> | description: Countries the site delivers to, with their delivery destination properties.  When `restOfWorld` isn't returned, a country without `deliveryDestinationProperties` is delivered to only in the subdivisions listed in its `subdivisions`.  | validation: maxItems 195
           - name: country | type: string | description: 2-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.  | validation: format COUNTRY
           - name: deliveryDestinationProperties | type: DeliveryDestinationProperties | description: Delivery destination properties for the country.  
              - name: postalCodeRequired | type: boolean | description: Whether a postal code is required for delivery to this destination.  
              - name: pickupOnly | type: boolean | description: Whether only pickup is available at this destination.  
           - name: subdivisions | type: array<SubdivisionDeliveryProperties> | description: List of subdivisions and their delivery destination properties.  | validation: maxItems 100
              - 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.  | validation: minLength 1, maxLength 5
              - name: deliveryDestinationProperties | type: DeliveryDestinationProperties | description: Delivery destination properties for the subdivision.  
        - name: restOfWorld | type: DeliveryDestinationProperties | description: Delivery destination properties for every destination that `countries` doesn't cover: countries that aren't listed, and unlisted subdivisions of a country without `deliveryDestinationProperties`.  Returned only when the site delivers to the rest of the world.  
     - name: premiumSite | type: boolean | description: Whether the site has a premium plan that supports accepting payments.  
     - name: businessInfo | type: BusinessProperties | description: Business information, such as the business name, address, and contact details.  
        - name: currency | type: string | description: Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. Payment currency for the business (default is 'USD').  | validation: format CURRENCY
        - name: language | type: string | description: Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used by the business for site content, emails, notifications, etc (default is 'en').  | validation: format LANGUAGE
        - name: locale | type: Locale | description: Locale for date, number, and measurement formatting (default is `en-US`).  
           - name: language | type: string | description: Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.  | validation: format LANGUAGE
           - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.  | validation: format COUNTRY
        - name: address | type: Address | description: Physical address of the business.  
           - name: streetAddress | type: StreetAddress | description: none  
              - name: name | type: string | description: none  
              - name: number | type: string | description: none  
           - name: city | type: string | description: none  
           - name: subdivision | type: string | description: none  
           - name: country | type: string | description: none  
           - name: postalCode | type: string | description: none  
        - name: name | type: string | description: Business name.  
        - name: email | type: string | description: Business email address.  
        - name: phone | type: string | description: Business phone number.  
        - name: fax | type: string | description: Business fax number.  
        - name: logo | type: string | description: Path to the business logo in Wix Media.  
        - name: timeZone | type: string | description: Business time zone.  
        - name: siteDisplayName | type: string | description: Site display name.  
     - name: businessLocale | type: BusinessLocale | description: Business locale: currency, language, locale, weight unit, and unit system.  
        - name: currency | type: string | description: Currency the business accepts payments in. Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.  Default: `USD`  | validation: format CURRENCY
        - name: language | type: string | description: Language the business uses for site content, emails, and notifications. Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.  Default: `en`  | validation: format LANGUAGE
        - name: locale | type: Locale | description: Locale for date, number, and measurement formatting.  Default: `en-US`  
        - name: weightUnit | type: WeightUnit | description: Weight unit, based on locale.  
             - enum:
             -     UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
             -     KG: Kilograms.
             -     LB: Pounds.
        - name: unitSystem | type: UnitSystem | description: Unit system, based on locale.  
             - enum:
             -     IMPERIAL: Imperial unit system. For example, inches, feet, pounds, ounces, etc.
             -     METRIC: Metric unit system. For example, centimeters, kilometers, grams, etc.
  - name: errors | type: array<Error> | description: Requested fields that couldn't be retrieved. These fields are left out of `ecommerceSettings`.  
     - name: requestedField | type: RequestedFields | description: Requested field that couldn't be retrieved.  
         - enum:
         -     ADDITIONAL_FEES_SERVICE_PLUGIN: Additional Fees service plugin configuration. Returned in `additionalFeesServicePlugin`.
         -     VALIDATIONS_SERVICE_PLUGIN: Validations service plugin configuration. Returned in `validationsServicePlugin`.
         -     TAX: Tax configuration. Returned in `tax`.
         -     DISCOUNT_RULES: Discount rules configuration. Returned in `discountRules`.
         -     CHECKOUT: Checkout settings. Returned in `checkout`.
         -     DELIVERY: Delivery destinations. Returned in `delivery`.
         -     PREMIUM_SITE: Premium status: whether the site has a premium plan that supports accepting payments. Returned in `premiumSite`.
         -     BUSINESS_INFO: Business information. Returned in `businessInfo`.
         -     PURCHASE_RECOMMENDATIONS_SERVICE_PLUGIN: Purchase recommendations service plugin configuration. Returned in `purchaseRecommendationsServicePlugin`.
         -     BUSINESS_LOCALE: Business locale. Returned in `businessLocale`.

 Possible Errors:
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: SITE_NOT_FOUND | Description: Couldn't find the site.


```

### Examples

### Retrieve the business locale
Retrieves the currency, language, and locale to format prices for the site.

```javascript
import { ecommerceSettings } from "@wix/ecom";

async function getEcommerceSettings() {
  const response = await ecommerceSettings.getEcommerceSettings(["BUSINESS_LOCALE"]);
}

/* Promise resolves to:
 * {
 *   "ecommerceSettings": {
 *     "businessLocale": {
 *       "currency": "USD",
 *       "language": "en",
 *       "locale": {
 *         "language": "en",
 *         "country": "GB"
 *       },
 *       "weightUnit": "KG",
 *       "unitSystem": "METRIC"
 *     }
 *   }
 * }
 */

```

### Retrieve the destinations a site delivers to
Retrieves the delivery configuration. In this response, the site delivers to the US and, through `restOfWorld`, to every other country.

```javascript
import { ecommerceSettings } from "@wix/ecom";

async function getEcommerceSettings() {
  const response = await ecommerceSettings.getEcommerceSettings(["DELIVERY"]);
}

/* Promise resolves to:
 * {
 *   "ecommerceSettings": {
 *     "delivery": {
 *       "countries": [
 *         {
 *           "country": "US",
 *           "deliveryDestinationProperties": {
 *             "postalCodeRequired": false,
 *             "pickupOnly": false
 *           }
 *         }
 *       ],
 *       "restOfWorld": {
 *         "postalCodeRequired": false,
 *         "pickupOnly": false
 *       }
 *     }
 *   }
 * }
 */

```

### Check whether a store is ready to sell
Retrieves the premium status and tax configuration to check whether the store is ready to sell.

```javascript
import { ecommerceSettings } from "@wix/ecom";

async function getEcommerceSettings() {
  const response = await ecommerceSettings.getEcommerceSettings(["PREMIUM_SITE", "TAX"]);
}

/* Promise resolves to:
 * {
 *   "ecommerceSettings": {
 *     "tax": {
 *       "configured": true,
 *       "taxIncludedInItemPrices": false
 *     },
 *     "premiumSite": true
 *   }
 * }
 */

```

### getEcommerceSettings (self-managed)
Self-managed SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { ecommerceSettings } from '@wix/ecom';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { ecommerceSettings },
  // Include the auth strategy and host as relevant
});


async function getEcommerceSettings(fields) {
  const response = await myWixClient.ecommerceSettings.getEcommerceSettings(fields);
};
```

---