PriceRuleCustomerSelection

Version 2019-04

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope

Show definition
"""
A selection of customers for whom the price rule applies.
"""
type PriceRuleCustomerSelection {
  """
  List of customers to whom the price rule applies.
  """
  customers(
    """
    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
    """
    Supported filter parameters:
     - `accepts_marketing`
     - `country`
     - `customer_date`
     - `email`
     - `last_abandoned_order_date`
     - `order_date`
     - `orders_count`
     - `phone`
     - `state`
     - `tag`
     - `total_spent`
     - `updated_at`
    See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    ID of an existing saved search.
    The search’s query string will be used as the query argument.
    """
    savedSearchId: ID
    """
    Sort the underlying list by the given key.
    """
    sortKey: CustomerSortKeys = ID
  ): CustomerConnection!
  """
  Whether the price rule applies to all customers.
  """
  forAllCustomers: Boolean!
  """
  List of customer saved searches that contain the customers to whom the price rule applies.
  """
  savedSearches: [SavedSearch!]!
}

Connections

customers (CustomerConnection!)

List of customers to whom the price rule applies.

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.

query ( String )

Supported filter parameters:

  • accepts_marketing
  • country
  • customer_date
  • email
  • last_abandoned_order_date
  • order_date
  • orders_count
  • phone
  • state
  • tag
  • total_spent
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( CustomerSortKeys )

Sort the underlying list by the given key.
Default value: true

Fields

forAllCustomers (Boolean!)

Whether the price rule applies to all customers.

savedSearches ([SavedSearch!]!)

List of customer saved searches that contain the customers to whom the price rule applies.

Version 2019-07

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope

Show definition
"""
A selection of customers for whom the price rule applies.
"""
type PriceRuleCustomerSelection {
  """
  List of customers to whom the price rule applies.
  """
  customers(
    """
    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
    """
    Supported filter parameters:
     - `accepts_marketing`
     - `country`
     - `customer_date`
     - `email`
     - `last_abandoned_order_date`
     - `order_date`
     - `orders_count`
     - `phone`
     - `state`
     - `tag`
     - `total_spent`
     - `updated_at`
    See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    ID of an existing saved search.
    The search’s query string will be used as the query argument.
    """
    savedSearchId: ID
    """
    Sort the underlying list by the given key.
    """
    sortKey: CustomerSortKeys = ID
  ): CustomerConnection!
  """
  Whether the price rule applies to all customers.
  """
  forAllCustomers: Boolean!
  """
  List of customer saved searches that contain the customers to whom the price rule applies.
  """
  savedSearches: [SavedSearch!]!
}

Connections

customers (CustomerConnection!)

List of customers to whom the price rule applies.

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.

query ( String )

Supported filter parameters:

  • accepts_marketing
  • country
  • customer_date
  • email
  • last_abandoned_order_date
  • order_date
  • orders_count
  • phone
  • state
  • tag
  • total_spent
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( CustomerSortKeys )

Sort the underlying list by the given key.
Default value: true

Fields

forAllCustomers (Boolean!)

Whether the price rule applies to all customers.

savedSearches ([SavedSearch!]!)

List of customer saved searches that contain the customers to whom the price rule applies.

Version 2019-10 (Latest)

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope

Show definition
"""
A selection of customers for whom the price rule applies.
"""
type PriceRuleCustomerSelection {
  """
  List of customers to whom the price rule applies.
  """
  customers(
    """
    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
    """
    Supported filter parameters:
     - `accepts_marketing`
     - `country`
     - `customer_date`
     - `email`
     - `last_abandoned_order_date`
     - `order_date`
     - `orders_count`
     - `phone`
     - `state`
     - `tag`
     - `total_spent`
     - `updated_at`
    See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    ID of an existing saved search.
    The search’s query string will be used as the query argument.
    """
    savedSearchId: ID
    """
    Sort the underlying list by the given key.
    """
    sortKey: CustomerSortKeys = ID
  ): CustomerConnection!
  """
  Whether the price rule applies to all customers.
  """
  forAllCustomers: Boolean!
  """
  List of customer saved searches that contain the customers to whom the price rule applies.
  """
  savedSearches: [SavedSearch!]!
}

Connections

customers (CustomerConnection!)

List of customers to whom the price rule applies.

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.

query ( String )

Supported filter parameters:

  • accepts_marketing
  • country
  • customer_date
  • email
  • last_abandoned_order_date
  • order_date
  • orders_count
  • phone
  • state
  • tag
  • total_spent
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( CustomerSortKeys )

Sort the underlying list by the given key.
Default value: true

Fields

forAllCustomers (Boolean!)

Whether the price rule applies to all customers.

savedSearches ([SavedSearch!]!)

List of customer saved searches that contain the customers to whom the price rule applies.

Version 2020-01 (Release candidate)

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope

Show definition
"""
A selection of customers for whom the price rule applies.
"""
type PriceRuleCustomerSelection {
  """
  List of customers to whom the price rule applies.
  """
  customers(
    """
    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
    """
    Supported filter parameters:
     - `accepts_marketing`
     - `country`
     - `customer_date`
     - `email`
     - `last_abandoned_order_date`
     - `order_date`
     - `orders_count`
     - `phone`
     - `state`
     - `tag`
     - `total_spent`
     - `updated_at`
    See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    ID of an existing saved search.
    The search’s query string will be used as the query argument.
    """
    savedSearchId: ID
    """
    Sort the underlying list by the given key.
    """
    sortKey: CustomerSortKeys = ID
  ): CustomerConnection!
  """
  Whether the price rule applies to all customers.
  """
  forAllCustomers: Boolean!
  """
  List of customer saved searches that contain the customers to whom the price rule applies.
  """
  savedSearches: [SavedSearch!]!
}

Connections

customers (CustomerConnection!)

List of customers to whom the price rule applies.

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.

query ( String )

Supported filter parameters:

  • accepts_marketing
  • country
  • customer_date
  • email
  • last_abandoned_order_date
  • order_date
  • orders_count
  • phone
  • state
  • tag
  • total_spent
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

savedSearchId ( ID )

ID of an existing saved search. The search’s query string will be used as the query argument.

sortKey ( CustomerSortKeys )

Sort the underlying list by the given key.
Default value: true

Fields

forAllCustomers (Boolean!)

Whether the price rule applies to all customers.

savedSearches ([SavedSearch!]!)

List of customer saved searches that contain the customers to whom the price rule applies.

Sign up for a Partner account to get started.

Sign up