Docs
Dashboard

CheckoutSettingsConfigureInput

Input

Input for configuring checkout settings.

#

Fields


companyNameRequirement
CheckoutFieldRequirement!

Whether the checkout includes a company-name field, and whether it is required.

Possible enum values
  • DISABLED

    The field is not shown or collected during checkout.

  • OPTIONAL

    The field is shown but a value is not required.

  • REQUIRED

    The field is shown and a value must be provided.

companyVatNumberRequirement
CheckoutFieldRequirement!

Whether the checkout includes a company VAT-number field. Cannot be required.

Possible enum values
  • DISABLED

    The field is not shown or collected during checkout.

  • OPTIONAL

    The field is shown but a value is not required.

  • REQUIRED

    The field is shown and a value must be provided.

faviconMediaId
ID

Optional media ID for the checkout favicon.

logoMediaId
ID

Optional media ID for the checkout logo.

marketingConsent
Boolean!

Whether the checkout displays a marketing-consent checkbox to the customer.

nameRequirement
CheckoutNameRequirement!

Whether the checkout requires both first and last name, or only the last name.

Possible enum values
  • FIRST_AND_LAST_NAME

    Requires both a first name and a last name.

  • LAST_NAME_ONLY

    Requires only a last name.

redirectUrl
String!

The absolute storefront URL used when customers leave checkout.

shippingPhoneNumberRequirement
CheckoutFieldRequirement!

Whether the checkout includes a shipping phone-number field, and whether it is required.

Possible enum values
  • DISABLED

    The field is not shown or collected during checkout.

  • OPTIONAL

    The field is shown but a value is not required.

  • REQUIRED

    The field is shown and a value must be provided.