Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

Retrieves the sites' checkout settings.


The `getCheckoutSettings()` function returns a Promise that resolves to checkout settings.

import { createClient, OAuthStrategy } from '@wix/sdk';
import { checkoutSettings } from '@wix/ecom';

const wixClient = createClient({
  modules: { checkoutSettings } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

async function getCheckoutSettings() {
  const response = await wixClient.checkoutSettings.getCheckoutSettings();
}

getCheckoutSettings() with visitor/member access

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { checkoutSettings } from '@wix/ecom';

const wixClient = createClient({
  modules: { checkoutSettings },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getCheckoutSettings() {
  const response = await wixClient.checkoutSettings.getCheckoutSettings();
}

getCheckoutSettings() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { checkoutSettings } from '@wix/ecom';

const wixClient = createClient({
  modules: { checkoutSettings },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function getCheckoutSettings() {
  const response = await wixClient.checkoutSettings.getCheckoutSettings();
}

getCheckoutSettings() with Dashboard app access

getCheckoutSettings

GetCheckoutSettingsResponse

checkoutSettings

CheckoutSettings

Updates the sites' checkout settings.


The `updateCheckoutSettings()` function returns a Promise that resolves to the newly updated checkout settings.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { checkoutSettings } from '@wix/ecom';

const wixClient = createClient({
  modules: { checkoutSettings },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function updateCheckoutSettings(checkoutSettings, options) {
  const response = await wixClient.checkoutSettings.updateCheckoutSettings(checkoutSettings, options);
}

updateCheckoutSettings() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { checkoutSettings } from '@wix/ecom';

const wixClient = createClient({
  modules: { checkoutSettings },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function updateCheckoutSettings(checkoutSettings, options) {
  const response = await wixClient.checkoutSettings.updateCheckoutSettings(checkoutSettings, options);
}

updateCheckoutSettings() with Dashboard app access

updateCheckoutSettings

UpdateCheckoutSettingsResponse

To use the CheckoutSettings API, install the `@wix/ecom` package using npm or Yarn:
  ```console
npm install @wix/ecom
```

or

```console
yarn add @wix/ecom
```

Then import `{ checkoutSettings }` from `@wix/ecom`:

```js
import { checkoutSettings } from '@wix/ecom'
```
  

ecom_checkout-settings

CheckboxField

Whether the checkbox is checked by default.

checkedByDefault

boolean

Whether the checkbox is visible to the customer.

visible

CheckoutFields

Whether the ability to redeem a gift card is enabled.
Default: `false`.

giftCardRedeemEnabled

Whether to allow for MIT transactions.
Default: `false`.

mitEnabled

Policy agreement checkbox.
Default:
- `visible`: `true`,
- `checkedByDefault`: `true`

policyAgreementCheckbox

Subscription checkbox.
Default:
- `visible`: `false`,
- `checkedByDefault`: `false`

subscriptionCheckbox

CheckoutPolicies

contactUs

ContactUsPolicy

customPolicy

CustomCheckoutPolicy

digitalItemPolicy

DigitalItemPolicy

privacyPolicy

PrivacyPolicy

returnPolicy

ReturnPolicy

termsAndConditions

TermsAndConditionsPolicy

Settings that apply to checkout fields and the checkout process.

checkoutFields

checkoutPolicies

content

string

Whether the contact us policy is visible to the customer in the checkout page. 

Default: `false`

title

Whether the policy is visible to the customer on the checkout page.
Default: `false`.

Whether the digital item policy is visible to the customer in the checkout page. 

Default: `false`

Whether the privacy policy is visible to the customer in the checkout page. 

Default: `false`

Whether the return policy is visible to the customer in the checkout page. 

Default: `false`

Whether the terms & conditions policy is visible to the customer in the checkout page. 

Default: `false`

Setup

Permission Scopes

Permission Scopes