Skip to main content

OrderSettings Object

Represents the channel-specific order settings.

type OrderSettings {
  automaticallyConfirmAllNewOrders: Boolean!
  automaticallyFulfillNonShippableGiftCard: Boolean!
  expireOrdersAfter: Minute
  markAsPaidStrategy: MarkAsPaidStrategyEnum!
  deleteExpiredOrdersAfter: Day!
  allowUnpaidOrders: Boolean!
  includeDraftOrderInVoucherUsage: Boolean!
  draftOrderLinePriceFreezePeriod: Hour
  useLegacyLineDiscountPropagation: Boolean!
}

Fields​

OrderSettings.automaticallyConfirmAllNewOrders ● Boolean! non-null scalar miscellaneous​

When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately.

OrderSettings.automaticallyFulfillNonShippableGiftCard ● Boolean! non-null scalar miscellaneous​

When enabled, all non-shippable gift card orders will be fulfilled automatically.

OrderSettings.expireOrdersAfter ● Minute scalar miscellaneous​

Expiration time in minutes. Default null - means do not expire any orders.

OrderSettings.markAsPaidStrategy ● MarkAsPaidStrategyEnum! non-null enum channels​

Determine what strategy will be used to mark the order as paid. Based on the chosen option, the proper object will be created and attached to the order when it's manually marked as paid. PAYMENT_FLOW - [default option] creates the Payment object. TRANSACTION_FLOW - creates the TransactionItem object.

OrderSettings.deleteExpiredOrdersAfter ● Day! non-null scalar miscellaneous​

The time in days after expired orders will be deleted.

OrderSettings.allowUnpaidOrders ● Boolean! non-null scalar miscellaneous​

Determine if it is possible to place unpaid order by calling checkoutComplete mutation.

OrderSettings.includeDraftOrderInVoucherUsage ● Boolean! non-null scalar miscellaneous​

Determine if voucher applied on draft order should be count toward voucher usage.

Added in Saleor 3.18
This API is currently in Feature Preview and can be subject to changes at later point.

OrderSettings.draftOrderLinePriceFreezePeriod ● Hour scalar miscellaneous​

Time in hours after which the draft order line price will be refreshed.

Added in Saleor 3.21 (unreleased)
This API is currently in Feature Preview and can be subject to changes at later point.

OrderSettings.useLegacyLineDiscountPropagation ● Boolean! non-null scalar miscellaneous​

This flag only affects orders created from checkout and applies specifically to vouchers of the types: SPECIFIC_PRODUCT and ENTIRE_ORDER with applyOncePerOrder enabled.

  • When legacy propagation is enabled, discounts from these vouchers are represented as OrderDiscount objects, attached to the order and returned in the Order.discounts field. Additionally, percentage-based vouchers are converted to fixed-value discounts.
  • When legacy propagation is disabled, discounts are represented as OrderLineDiscount objects, attached to individual lines and returned in the OrderLine.discounts field. In this case, percentage-based vouchers retain their original type. In future releases, OrderLineDiscount will become the default behavior, and this flag will be deprecated and removed.
Added in Saleor 3.21 (unreleased)

Returned By​

orderSettings query

Member Of​

Channel object ● OrderSettingsUpdate object