Checkout settings

Checkout settings endpoints of the Zanfia Workspace API, with schemas and code samples.

2 min readLast updated Sep 10, 2026

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). Checkout consents (customConsents, the checkboxes buyers tick on checkout pages) have their own routes below, keyed by the consent name; the PATCH route rejects the field so scope ids are always validated against real products/checkouts. All routes require a Authorization: Bearer header — see Authentication.

Get checkout settings

GET/checkout-settings

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Query Parameters

language?"pl"

Default"pl"

Value in

"pl"

Response Body

`application/json`

curl -X GET "https://example.com/checkout-settings"

{  "termsUrl": "string",  "privacyPolicyUrl": "string",  "claim": "string",  "googleAnalyticsId": "string",  "facebookPixelId": "string",  "customConsents": [    {      "id": "string",      "currentVersionId": "string",      "versions": [        {          "id": "string",          "version": 0,          "name": "string",          "label": "string",          "url": "string",          "required": true,          "applyToProducts": [            "string"          ],          "applyToCheckouts": [            "string"          ],          "isMarketingOptIn": true,          "publishedAt": "string",          "migratedFromLegacy": true        }      ],      "archivedAt": "string",      "label": "string",      "url": "string",      "required": true,      "name": "string",      "applyToProducts": [        "string"      ],      "applyToCheckouts": [        "string"      ],      "isMarketingOptIn": true    }  ],  "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",  "microsoftClarityProjectId": "string",  "hotjarSiteId": "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",  "message": "string"}

Update checkout settings

PATCH/checkout-settings

Authorization

bearerAuth

AuthorizationBearer <token>

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'.

language?AvailableLang

termsUrl?string

privacyPolicyUrl?string

claim?string

googleAnalyticsId?string|null

facebookPixelId?string|null

customConsents?array<>|null

creator?string

embeddedForm?|null

checkoutTheme?CheckoutTheme

Value in

"indigo"
"black"
"pink"
"rose"
"sky"
"emerald"
"blue"
"teal"
"violet"
"purple"
"fuchsia"
"cyan"
"gray"
"yellow"
"yellow-light"

termsContent?string

privacyPolicyContent?string

termsSlug?string

Custom URL slug under the site-level /documents/ namespace (e.g. regulamin → /documents/regulamin). The default routes (/documents/terms, /documents/pp) keep working as aliases. Root-level slugs are NOT supported — the storefront root namespace belongs to creator custom pages.

privacyPolicySlug?string

promoteNetPrices?boolean

googleAnalyticsGtmId?string|null

tiktokPixelId?string|null

microsoftClarityProjectId?|

Resolved Microsoft Clarity project ID — output of tracking resolution, not a config source.

hotjarSiteId?|

Resolved Hotjar site ID — output of tracking resolution, not a config source.

cartTheme?|null

priceVariantsPlacement?|null

Response Body

`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": [    {      "id": "string",      "currentVersionId": "string",      "versions": [        {          "id": "string",          "version": 0,          "name": "string",          "label": "string",          "url": "string",          "required": true,          "applyToProducts": [            "string"          ],          "applyToCheckouts": [            "string"          ],          "isMarketingOptIn": true,          "publishedAt": "string",          "migratedFromLegacy": true        }      ],      "archivedAt": "string",      "label": "string",      "url": "string",      "required": true,      "name": "string",      "applyToProducts": [        "string"      ],      "applyToCheckouts": [        "string"      ],      "isMarketingOptIn": true    }  ],  "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",  "microsoftClarityProjectId": "string",  "hotjarSiteId": "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",  "message": "string"}

List checkout consents

GET/checkout-settings/consents

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/checkout-settings/consents"

{  "consents": [    {      "name": "string",      "label": "string",      "url": "string",      "required": true,      "appliesTo": "all"    }  ]}

{  "error": "string",  "message": "string"}

PUT/checkout-settings/consents/{name}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

name*string

Folder name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

PUT /checkout-settings/consents/:name — add or edit ONE consent (the name path segment is the upsert key; an existing name edits in place, a new name appends). Every product/checkout id in applyTo is verified against real documents before writing.

label*string

url?|

null/omit for no link.

required*boolean

applyTo*|array<>

'all' = every product and checkout; otherwise an explicit scope list (non-empty).

isMarketingOptIn?boolean

Ticking this consent subscribes the buyer to the workspace email-marketing audience. Omitted = keep the existing consent's setting.

Response Body

`application/json`

curl -X PUT "https://example.com/checkout-settings/consents/string" \  -H "Content-Type: application/json" \  -d '{    "label": "string",    "required": true,    "applyTo": "all"  }'

{  "created": true,  "consent": {    "name": "string",    "label": "string",    "url": "string",    "required": true,    "appliesTo": "all"  }}

{  "error": "string",  "message": "string"}

Was this article helpful?

Spotted something off? Tell us at support@zanfia.com.

Checkout settings

Get checkout settings

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

Update checkout settings

Authorization

Request Body

Response Body

`application/json`

`application/json`

List checkout consents

Authorization

Response Body

`application/json`

`application/json`

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

Related articles

API overview

Authentication and API keys

Get checkout settings

200application/json

4XXapplication/json

Update checkout settings

200application/json

4XXapplication/json

List checkout consents

200application/json

4XXapplication/json

Add or edit a checkout consent

200application/json

4XXapplication/json

Related articles

API overview

Authentication and API keys

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`