This page lists every field available when creating or editing a Checkout Setup. Use it when you need to know what a field does, what values it accepts, or what will happen if you leave it blank. It is not a step-by-step guide — for that, see the Checkout Setups core concepts page.
| Field | Type | Default | Description |
|---|
name | Text | — | Display name for this checkout setup. Used internally only — customers never see it. Keep it descriptive, e.g., "Sweden – Shopify Live". |
checkout_id | Text (alpha-dash) | Auto-generated | A human-readable slug used to identify this setup in provider integrations. Must contain only letters, numbers, hyphens, and underscores. Example: my-store-fi. This field is auto-generated and shown read-only in the form — you cannot edit it directly. |
| Field | Type | Default | Description |
|---|
enabled_providers | Array | — | List of checkout providers that have been configured with credentials on this setup. Allowed values: shopify, qliro, walley, kustom. A provider must be enabled before it can be published. |
published_providers | Array | — | Subset of enabled_providers that are currently live and serving checkout requests. Disabling a published provider removes it from live checkout without deleting its configuration. |
provider_fallback_policies | Object (per-provider) | — | How each provider behaves when its primary quote request fails. Values per provider: inherit (use setup-level defaults), strict (return error — no fallback), degraded_only (fall back to a quote without pickup points), cached_only (fall back to a previously cached quote), degraded_then_cached (try degraded first, then cached). |
provider_capability_modes | Object (per-provider) | quote_only | The depth of integration for each provider: quote_only (delivery options only), quote_and_booking (also books shipments), quote_and_sync (bidirectional shipment status sync). |
provider_credential_modes | Object (per-provider) | partner_managed | Who manages the carrier credentials: partner_managed (your team holds the API keys), shipit_managed (Shipit manages the connection). |
Tip: provider_fallback_policies is an advanced field. In most cases, the setup-level allow_degraded_fallback and allow_cached_quote_fallback defaults are sufficient until you need per-provider control.
| Field | Type | Default | Description |
|---|
default_locale | Text | — | The default locale code for this setup, e.g., fi (Finnish), sv (Swedish), en (English). Used as the base language for all display text. |
locale_resolution_strategy | Select | checkout_configuration_first | Controls which locale is used at runtime. checkout_configuration_first — setup locale wins over request and market. request_first — locale from the checkout request wins. market_first — market country locale wins. |
market_country_code | Select | — | The ISO 3166-1 alpha-2 country code of the primary market for this setup. Influences the default tax strategy and locale resolution when locale_resolution_strategy is market_first. Example: FI, SE. |
Tip: Use checkout_configuration_first when this setup is dedicated to a single market. Use request_first when one setup serves multiple languages, such as a Nordic-wide store where the customer's browser language should determine what they see.
| Field | Type | Default | Description |
|---|
allow_degraded_fallback | Boolean | true | The setup-level default for whether a degraded quote (delivery options without pickup points) is permitted as a fallback. Overridden by per-provider provider_fallback_policies. |
allow_cached_quote_fallback | Boolean | true | The setup-level default for whether a previously cached quote response may be served as a fallback. Overridden by per-provider provider_fallback_policies. |
Tip: Fallback settings protect checkout availability when a provider is slow or temporarily unavailable. degraded_only is the safest default — customers still see delivery options, just without pickup points. strict mode is appropriate when you need to guarantee data freshness over availability.
| Field | Type | Default | Description |
|---|
experiments | Array | — | A list of A/B experiment definitions. Each experiment can split incoming traffic between different rule sets or shipping option configurations. See the A/B Experiments core concepts page for full details. |
