Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# About Checkout Settings

With the Checkout Settings API, you can retrieve and update the checkout settings for sites that have installed your app. These settings include adding or removing eCommerce policies, and setting checkbox behavior for a checkout.    

Policies will appear as clickable links in the footer of your checkout, while checkboxes can be found when selecting the payment method. Clicking on the policy name opens a pop-up window with the policy text. The default checkout settings are provided when you first create a Wix eCommerce site. 

## Before you begin

It’s important to note the following points before starting to code:  

- Install the [Wix Stores](fallback::https://www.wix.com/app-market/wix-stores?referral=category&appIndex=1&referralTag=ecommerce), [Wix Bookings](fallback::https://www.wix.com/app-market/wix-bookings?referral=category&appIndex=0&referralTag=booking--events), or [Wix Events & Tickets](fallback::https://www.wix.com/app-market/wix-events?referral=category&appIndex=5&referralTag=booking--events) app from Wix App Market.

## Use Cases

- [Update checkout settings across all sites](fallback::/checkout-settings/sample-use-cases-and-flows)

## Terminology

- **Checkout**: The second stage of the eCommerce purchase flow: cart; checkout; order. A checkout holds information about items to be purchased, price and tax summaries, shipping and billing info, any applied discounts, and more.
- **Policy**: Set of guidelines, rules, or principles established by an organization or authority to govern behavior, decision-making, and specific actions. 


# Checkout Settings: Sample Use Cases & Flows

This article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation. 

## Update checkout settings across all sites

If you have several Wix eCommerce sites that use your app you might need to sync checkout settings across those sites. For example, if the return policies change on 1 site, and now the policies guarantee a 100-day item return, this change also needs to be reflected on other sites.

To update the checkout policy settings across all sites:

1. Call [Get Checkout Settings](fallback::/checkout-settings/get-checkout-settings) on the site where you updated the policy.
1. Extract the `checkoutPolicies.returnPolicy.content` field value.
1. Call [Update Checkout Settings](fallback::/checkout-settings/update-checkout-settings) for your other sites and pass the new policy to each.

The gift card provider which was installed

providerAppDefId

providerInstanceId

GiftCardProviderWasProvisioned

identityType

IdentificationData

WebhookIdentityType

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

data

eventType

The identification type and identity data.

instanceId

MessageEnvelope

value

BoolValue

Empty

paths

FieldMask

Int64Value

values

ListValue

NullValue

StringValue

fields

Struct

nanos

seconds

Timestamp

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

altText

filename

height

width

Image

bodyAsJson

ActionEvent

A sequence number defining the order of updates to the underlying entity.
For example, given that some entity was updated at 16:00 and than again at 16:01,
it is guaranteed that the sequence number of the second update is strictly higher than the first.
As the consumer, you can use this value to ensure that you handle messages in the correct order.
To do so, you will need to persist this number on your end, and compare the sequence number from the
message against the one you have stored. Given that the stored number is higher, you should ignore the message.

entityEventSequence

Assumes actions are also always typed to an entity_type
Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction

entityFqdn

ID of the entity associated with the event.

entityId

eventTime

Unique event ID.
Allows clients to ignore duplicate webhooks.

If present, indicates the action that triggered the event.

originatedFrom

This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
This is although the created/updated/deleted notion is duplication of the oneof types
Example: created/updated/deleted/started/completed/email_opened

slug

Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).

triggeredByAnonymizeRequest

DomainEvent

body

entityAsJson

EntityCreatedEvent

deletedEntityAsJson

EntityDeletedEvent

Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.

currentEntityAsJson

EntityUpdatedEvent

Alignment

Whether the checkbox is checked by default.

checkedByDefault

Whether the checkbox is visible to the customer.

visible

CheckboxField

CheckoutBrand

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. 

Defaults:
+ `visible`: `true`
+ `checkedByDefault`: `true`

Subscription checkbox. 

Defaults:
+ `visible`: `false`
+ `checkedByDefault`: `false`

CheckoutFields

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.

alignment

Whether to display the 'Checkout' label within the header.
Depending on the locale, the label may be translated.

displayCheckoutLabel

Specifications for when a logo is included in the header.

Textual content to be included in the header (e.g. Business Name)
TODO: update maxLength validation once limitation is known

text

CheckoutHeader

CheckoutPolicies

Settings that apply to checkout fields and the checkout process.

Date and time the checkout settings were created.

createdDate

Date and time the checkout settings were updated.

updatedDate

CheckoutSettings

content

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

Default: `false`

ContactUsPolicy

title

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

Default: `false`

CustomCheckoutPolicy

DeleteCheckoutSettingsRequest

DeleteCheckoutSettingsResponse

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

Default: `false`

DigitalItemPolicy

GetCheckoutSettingsRequest

GetCheckoutSettingsResponse

size

Logo

LogoSize

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

Default: `false`

PrivacyPolicy

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

Default: `false`

ReturnPolicy

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

Default: `false`

Checkout Settings Object