Skip to main content

CheckoutSettings Object

Represents the channel-specific checkout settings.

type CheckoutSettings {
  useLegacyErrorFlow: Boolean!
  automaticallyCompleteFullyPaidCheckouts: Boolean!
  automaticCompletionDelay: Minute
  automaticCompletionCutOffDate: DateTime
  allowLegacyGiftCardUse: Boolean!
}

Fields​

CheckoutSettings.useLegacyErrorFlow ● Boolean! non-null scalar miscellaneous​

Default true. Determines if the checkout mutations should use legacy error flow. In legacy flow, all mutations can raise an exception unrelated to the requested action - (e.g. out-of-stock exception when updating checkoutShippingAddress.) If false, the errors will be aggregated in checkout.problems field. Some of the problems can block the finalizing checkout process. The legacy flow will be removed in Saleor 4.0. The flow with checkout.problems will be the default one.

CheckoutSettings.automaticallyCompleteFullyPaidCheckouts ● Boolean! non-null scalar miscellaneous​

Default false. Determines if the paid checkouts should be automatically completed. This setting applies only to checkouts where payment was processed through transactions.When enabled, the checkout will be automatically completed once the checkout charge_status reaches FULL. This occurs when the total sum of charged and authorized transaction amounts equals or exceeds the checkout's total amount.

Added in Saleor 3.20

CheckoutSettings.automaticCompletionDelay ● Minute scalar miscellaneous​

The time in minutes to wait after a checkout is fully paid before automatically completing it.

Added in Saleor 3.22

CheckoutSettings.automaticCompletionCutOffDate ● DateTime scalar miscellaneous​

The date time defines the earliest checkout creation date on which fully paid checkouts can begin to be automatically completed.

Added in Saleor 3.22

CheckoutSettings.allowLegacyGiftCardUse ● Boolean! non-null scalar miscellaneous​

Default to true. Determines whether gift cards can be attached to a Checkout via addPromoCode mutation. Usage of this mutation with gift cards is deprecated.

Added in Saleor 3.23 (unreleased)

Member Of​

Channel object