PriceRuleItemEntitlements

Required access

read_price_rules access scope

The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned.

Show definition
# The items to which this price rule applies. This may be multiple products,
# product variants, collections or combinations of the aforementioned.
type PriceRuleItemEntitlements {
  # The collections to which the price rule applies.
  collections(
    # Returns the elements that come after the specified cursor.
    after: String

    # Returns the elements that come before the specified cursor.
    before: String

    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns up to the last `n` elements from the list.
    last: Int

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): CollectionConnection!

  # The product variants to which the price rule applies.
  productVariants(
    # Returns the elements that come after the specified cursor.
    after: String

    # Returns the elements that come before the specified cursor.
    before: String

    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns up to the last `n` elements from the list.
    last: Int

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): ProductVariantConnection!

  # The products to which the price rule applies.
  products(
    # Returns the elements that come after the specified cursor.
    after: String

    # Returns the elements that come before the specified cursor.
    before: String

    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns up to the last `n` elements from the list.
    last: Int

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): ProductConnection!

  # Whether the price rule applies to all line items.
  targetAllLineItems: Boolean!
}

Connections

collections   (CollectionConnection!)

The collections to which the price rule applies.

Argument Type Default Description
after

String

Returns the elements that come after the specified cursor.

before

String

Returns the elements that come before the specified cursor.

first

Int

Returns up to the first n elements from the list.

last

Int

Returns up to the last n elements from the list.

reverse

Boolean

false

Reverse the order of the underlying list.

productVariants   (ProductVariantConnection!)

The product variants to which the price rule applies.

Argument Type Default Description
after

String

Returns the elements that come after the specified cursor.

before

String

Returns the elements that come before the specified cursor.

first

Int

Returns up to the first n elements from the list.

last

Int

Returns up to the last n elements from the list.

reverse

Boolean

false

Reverse the order of the underlying list.

products   (ProductConnection!)

The products to which the price rule applies.

Argument Type Default Description
after

String

Returns the elements that come after the specified cursor.

before

String

Returns the elements that come before the specified cursor.

first

Int

Returns up to the first n elements from the list.

last

Int

Returns up to the last n elements from the list.

reverse

Boolean

false

Reverse the order of the underlying list.

Fields

targetAllLineItems   (Boolean!)

Whether the price rule applies to all line items.

Sign up for a Partner account to get started.

Sign up