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.
It’s important to note the following points before starting to code:
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.
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:
checkoutPolicies.returnPolicy.content
field value.Checkout policies.
Settings that apply to checkout fields and the checkout process.
Date and time the checkout settings were created.
Date and time the checkout settings were updated.
{
"checkoutSettings": {
"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": true,
"mitEnabled": false
}
}
}
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.
Checkout settings.
curl -X GET \
'https://www.wixapis.com/ecom/v1/checkout-settings' \
-H 'Authorization: <AUTH>'
{
"checkoutSettings": {
"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": true,
"mitEnabled": false
}
}
}
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.
You can only call this method when authenticated as a Wix app or Wix user identity.
Checkout settings to update.
The updated checkout settings.
curl -X PATCH \
'https://www.wixapis.com/ecom/v1/checkout-settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"checkoutSettings": {
"checkoutFields": {
"giftCardRedeemEnabled": true,
"mitEnabled": false
}
}
}'
{
"checkoutSettings": {
"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": true,
"mitEnabled": false
}
}
}
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.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.checkout_settings
.
Event name. Expected updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.ecom.v1.checkout_settings_updated",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"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"
}