Checkout settings
Checkout settings endpoints of the Zanfia Workspace API, with schemas and code samples.
Workspace-wide cart/checkout page settings: legal texts (terms/privacy, linked or inline), the information-clause claim, tracking ids (Google Analytics, GTM, Facebook Pixel, TikTok Pixel), net-price promotion, and price-variant placement. This is the ONE default every checkout page reads unless a single offer overrides a field itself (see Offers). customConsents has no route here yet — manage it from the dashboard. All routes require a Authorization: Bearer header — see Authentication.
Get checkout settings
/checkout-settingsAuthorization
bearerAuth API key from Dashboard → Integrations → API, MCP and CLI.
In: header
Query Parameters
"pl"Value in
- "pl"
Response Body
application/json
application/json
curl -X GET "https://example.com/checkout-settings"{ "termsUrl": "string", "privacyPolicyUrl": "string", "claim": "string", "googleAnalyticsId": "string", "facebookPixelId": "string", "customConsents": [ { "label": "string", "url": "string", "required": true, "name": "string", "applyToProducts": [ "string" ], "applyToCheckouts": [ "string" ] } ], "creator": "string", "embeddedForm": { "variant": "basic", "scheme": "auto", "buttonText": "string", "emailPlaceholder": "string", "headerText": "string", "successMessage": "string", "descriptionText": "string", "color": "string", "background": "string", "claim": "string", "privacyPolicyUrl": "string", "showClaim": true, "showHeader": true, "showDescription": true, "showPrivacyPolicyInfo": true, "showFirstNameInput": true, "firstNameRequired": true, "showPhoneNumberInput": true, "phoneNumberRequired": true, "customDomain": "string", "termsAndPrivacyPolicyConsentRequired": true, "showTermsUrl": true, "termsUrl": "string" }, "checkoutTheme": "indigo", "termsContent": "string", "privacyPolicyContent": "string", "termsSlug": "string", "privacyPolicySlug": "string", "promoteNetPrices": true, "googleAnalyticsGtmId": "string", "tiktokPixelId": "string", "cartTheme": { "enabled": true, "selectedTheme": "light", "customColors": { "light": { "accent": "string", "gray": "string", "background": "string" }, "dark": { "accent": "string", "gray": "string", "background": "string" } }, "customCheckoutColors": { "light": { "checkoutLeftBackground": "string", "checkoutRightBackground": "string", "checkoutLeftTextColor": "string", "checkoutLeftPriceColor": "string", "accent": "string" }, "dark": { "checkoutLeftBackground": "string", "checkoutRightBackground": "string", "checkoutLeftTextColor": "string", "checkoutLeftPriceColor": "string", "accent": "string" } }, "theme": "tomato" }, "priceVariantsPlacement": "belowDescription", "language": "pl"}{ "error": "string"}Update checkout settings
/checkout-settingsAuthorization
bearerAuth API key from Dashboard → Integrations → API, MCP and CLI.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
PATCH /checkout-settings — partial update of the workspace cart/checkout settings. Every field is optional; an omitted field keeps its stored value (server-side deep merge — sibling fields, including customConsents, are never clobbered by a partial patch). language defaults to 'pl'.
Response Body
application/json
application/json
curl -X PATCH "https://example.com/checkout-settings" \ -H "Content-Type: application/json" \ -d '{}'{ "termsUrl": "string", "privacyPolicyUrl": "string", "claim": "string", "googleAnalyticsId": "string", "facebookPixelId": "string", "customConsents": [ { "label": "string", "url": "string", "required": true, "name": "string", "applyToProducts": [ "string" ], "applyToCheckouts": [ "string" ] } ], "creator": "string", "embeddedForm": { "variant": "basic", "scheme": "auto", "buttonText": "string", "emailPlaceholder": "string", "headerText": "string", "successMessage": "string", "descriptionText": "string", "color": "string", "background": "string", "claim": "string", "privacyPolicyUrl": "string", "showClaim": true, "showHeader": true, "showDescription": true, "showPrivacyPolicyInfo": true, "showFirstNameInput": true, "firstNameRequired": true, "showPhoneNumberInput": true, "phoneNumberRequired": true, "customDomain": "string", "termsAndPrivacyPolicyConsentRequired": true, "showTermsUrl": true, "termsUrl": "string" }, "checkoutTheme": "indigo", "termsContent": "string", "privacyPolicyContent": "string", "termsSlug": "string", "privacyPolicySlug": "string", "promoteNetPrices": true, "googleAnalyticsGtmId": "string", "tiktokPixelId": "string", "cartTheme": { "enabled": true, "selectedTheme": "light", "customColors": { "light": { "accent": "string", "gray": "string", "background": "string" }, "dark": { "accent": "string", "gray": "string", "background": "string" } }, "customCheckoutColors": { "light": { "checkoutLeftBackground": "string", "checkoutRightBackground": "string", "checkoutLeftTextColor": "string", "checkoutLeftPriceColor": "string", "accent": "string" }, "dark": { "checkoutLeftBackground": "string", "checkoutRightBackground": "string", "checkoutLeftTextColor": "string", "checkoutLeftPriceColor": "string", "accent": "string" } }, "theme": "tomato" }, "priceVariantsPlacement": "belowDescription", "language": "pl"}{ "error": "string"}Was this article helpful?