> 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`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt
# Package: checkout
# Namespace: checkoutSettings
# Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/purchase-flow/checkout/checkout-settings/checkout-settings-updated.md
## Introduction
Triggered when checkout settings are updated.
---
## REST API
### Schema
```
Webhook: Checkout Settings Updated
Description: Triggered when checkout settings are updated.
Event body:
- name: id | type: string | description: Unique event ID. Allows clients to ignore duplicate events.
- name: entityFqdn | type: string | description: Fully qualified domain name of the entity associated with the event.
- name: slug | type: string | description: Event name.
- name: entityId | type: string | description: ID of the entity associated with the event.
- name: eventTime | type: string (date-time) | description: Event timestamp.
- name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application such as GDPR.
- name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
- name: updatedEvent | type: object | description: Updated event details.
- name: currentEntity | type: CheckoutSettings | description: The entity after the update.
- 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.
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.
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.
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.
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.
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.
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: CheckboxField | description: Subscription checkbox.
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: policyAgreementCheckbox | type: CheckboxField | description: Policy agreement checkbox.
Defaults: + `visible`: `false` + `checkedByDefault`: `false`
- name: giftCardRedeemEnabled | type: boolean | description: Whether the ability to redeem a gift card is enabled.
Default: `false`
- name: mitEnabled | type: boolean | description: Whether to allow for MIT transactions.
Default: `false`
- name: delayCaptureEnabled | type: boolean | description: Whether to allow for Auth & Capture transactions.
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)
- name: textColor | type: string | description: Text color hex code.
- 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.
- 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.
- name: width | type: integer | description: Original image width.
- name: altText | type: string | description: Image alt text.
- name: filename | type: string | description: Image filename.
- name: createdDate | type: string | description: Date and time the checkout settings were created.
- name: updatedDate | type: string | description: Date and time the checkout settings were updated.
- 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: modifiedFields | type: Map | description: Fields that were updated and their values before the update.
```
### Examples
```curl
{
"id": "7b05fbd6-c3e2-42c2-ace6-06272bd3fdfa",
"entityFqdn": "wix.ecom.v1.checkout_settings",
"slug": "updated",
"entityId": "74a91ddc-8540-11ee-b9d1-0242ac120002",
"updatedEvent": {
"currentEntity": {
"checkoutPolicies": {
"termsAndConditions": {
"visible": true,
"content": "All product listings, prices, and specifications are subject to change without notice. ACCS reserves the right to modify or discontinue products at any time."
},
"privacyPolicy": {
"visible": true,
"content": "Your privacy is important to us. Please review our Privacy Policy to understand how we collect, use, and disclose information."
},
"returnPolicy": {
"visible": true,
"content": "Please refer to our Return Policy page for information on returns and refunds. ACCS reserves the right to refuse returns that do not meet our policy criteria."
},
"digitalItemPolicy": {
"visible": false,
"content": ""
},
"contactUs": {
"visible": true,
"content": "email: accs@mail.com"
},
"customPolicy": {
"visible": true,
"content": "Placing an order on our website constitutes an offer to purchase the products. We reserve the right to refuse or cancel any order for any reason. Payment must be received before order processing.",
"title": "Orders and Payments"
}
},
"checkoutFields": {
"subscriptionCheckbox": {
"visible": true,
"checkedByDefault": true
},
"policyAgreementCheckbox": {
"visible": true,
"checkedByDefault": false
},
"giftCardRedeemEnabled": false,
"mitEnabled": true
}
}
},
"eventTime": "2023-11-16T13:28:59.036159Z",
"triggeredByAnonymizeRequest": false,
"entityEventSequence": "133"
}
```
---
## JavaScript SDK
### Schema
```
Webhook: onCheckoutSettingsUpdated
Description: Triggered when checkout settings are updated.
Payload: CheckoutSettingsUpdatedEnvelope
- name: entity | type: CheckoutSettings | description: none
- 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.
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.
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.
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.
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.
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.
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: CheckboxField | description: Subscription checkbox.
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: policyAgreementCheckbox | type: CheckboxField | description: Policy agreement checkbox.
Defaults: + `visible`: `false` + `checkedByDefault`: `false`
- name: giftCardRedeemEnabled | type: boolean | description: Whether the ability to redeem a gift card is enabled.
Default: `false`
- name: mitEnabled | type: boolean | description: Whether to allow for MIT transactions.
Default: `false`
- name: delayCaptureEnabled | type: boolean | description: Whether to allow for Auth & Capture transactions.
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)
- name: textColor | type: string | description: Text color hex code.
- 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.
- name: image | type: string | description: Background image.
- name: _createdDate | type: Date | description: Date and time the checkout settings were created.
- name: _updatedDate | type: Date | description: Date and time the checkout settings were updated.
- 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: modifiedFields | type: Map | description: Fields that were updated and their values before the update.
- ONE-OF:
- name: nullValue | type: | description:
- name: numberValue | type: number | description:
- name: stringValue | type: string | description:
- name: boolValue | type: boolean | description:
- name: structValue | type: object | description:
- name: listValue | type: ListValue | description:
- name: values | type: array | description:
- name: metadata | type: EventMetadata | description: none
- name: instanceId | type: string | description: App instance GUID.
- name: eventType | type: string | description: Event type.
- name: identity | type: IdentificationData | description: The identification type and identity data.
- ONE-OF:
- name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
- name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
- name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
- name: appId | type: string | description: GUID of an app.
- name: identityType | type: WebhookIdentityType | description:
- enum: UNKNOWN, ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
- name: accountInfo | type: AccountInfo | description: Details related to the account
- name: accountId | type: string | description: GUID of the Wix account associated with the event.
- name: parentAccountId | type: string | description: GUID of the parent Wix account. Only included when accountId belongs to a child account.
- name: siteId | type: string | description: GUID of the Wix site associated with the event. Only included when the event is tied to a specific site.
- name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
- name: entityFqdn | type: string | description: Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
- name: slug | type: string | description: Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
- name: entityId | type: string | description: GUID of the entity associated with the event.
- name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`.
- name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
- name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
- name: entityEventSequence | type: string | description: A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
```
### Examples
```javascript
import { checkoutSettings } from '@wix/ecom';
checkoutSettings.onCheckoutSettingsUpdated((event) => {
// handle your event here
});
```
```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { checkoutSettings } from '@wix/ecom';
const wixClient = createClient({
auth: AppStrategy({
appId: 'MY-APP-ID',
publicKey: 'YOUR_APP_PUBLIC_KEY',
}),
modules: {
checkoutSettings,
},
});
wixClient.checkoutSettings.onCheckoutSettingsUpdated((event) => {
// handle your event here
});
```
---