checkoutDiscountRule

Required scopes: checkout_read

Arguments

ID!

required

The rule’s id.

Returns

A store-level checkout discount rule: when its conditions match the cart, its discount applies to the targeted delivery options. The first matching active rule wins.

Show fields

Boolean!

required

Whether the rule is evaluated at checkout while discount rules are on.

CheckoutDiscountRuleConditions!

required

When the rule applies.

Show fields

[CheckoutDiscountRuleConditionBlock!]!

required

Groups of conditions, at most 6.

Show fields

[CheckoutDiscountRuleCondition!]!

required

The conditions in this block.

CheckoutDiscountRuleConjunction!

required

How the conditions in this block combine.

CheckoutDiscountRuleConjunction!

required

How the blocks combine.

DateTime!

required

When the rule was created.

CheckoutDiscountRuleDiscount!

required

What the rule takes off.

ID!

required

The rule’s id.

String!

required

Shopper-facing text shown with the discounted price.

CheckoutDiscountRuleTarget!

required

What the rule discounts.

DateTime!

required

When the rule was last changed.

Example

query {
  checkoutDiscountRule(id: "...") {
    active
    createdAt
    id
    message
    updatedAt
  }
}

Getting Started

Guides

Reference

checkoutDiscountRule

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example