Skip to content

Get checkout settings

GET
/settings/checkout

Returns the checkout-related subset of site settings (cart, signup, validation).

Authorizations

bearerToken|siteContext
bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)
+
siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)
or
siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Responses

checkout settings returned

application/json
JSON
{
"enable_singlepage_checkout": true,
"enable_cart_login_required": true,
"enable_cart_expiration": true,
"cart_expiration_time": 0,
"cart_expiration_grace_period": 0,
"enable_cart_recovery": true,
"cart_recovery_time": 0,
"enable_direct_signup": true,
"enable_minimal_signup": true,
"hide_person_title": true,
"hide_vat_field": true,
"hide_type_field": true,
"validate_zipcode": true,
"validate_vat": true
}

Playground

Authorization

Samples

Part of Nimbu, built by Zenjoy.