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:

Use Cases

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.
Was this helpful?
Yes
No

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.
Was this helpful?
Yes
No

Checkout Settings Object

Properties
checkoutPoliciesobject
Checkout policies.

checkoutFieldsobject
Settings that apply to checkout fields and the checkout process.
Was this helpful?
Yes
No

GetGet Checkout Settings

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves the site's checkout settings.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Read eCommerce - all read permissions
Read Orders
Read Stores - all read permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/ecom/v1/checkout-settings

Was this helpful?
Yes
No

PatchUpdate Checkout Settings

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates the site's checkout settings.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage eCommerce - all permissions
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/ecom/v1/checkout-settings

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

Checkout Settings Updated

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when checkout settings are updated.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Read eCommerce - all read permissions
Read Orders
Read Stores - all read permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.checkout_settings.

slugstring
Event name. Expected updated.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

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

originatedFromstring
If present, indicates the action that triggered the event.

updatedEventobject
Event information.

Was this helpful?
Yes
No