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, Wix Bookings, or Wix Events & Tickets app from Wix App Market.

Use Cases

• Update checkout settings across all sites

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 on the site where you updated the policy.
2. Extract the checkoutPolicies.returnPolicy.content field value.
3. Call Update Checkout Settings for your other sites and pass the new policy to each.