API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

PriceRuleCustomerSelection object

Version unstable

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope.

Connections

  • customers (CustomerConnection!)

    List of customers to whom the price rule applies.

    Argument 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.

    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: false

    savedSearchId ( ID )

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

    sortKey ( CustomerSortKeys )

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

Fields

  • forAllCustomers (Boolean!)

    Whether the price rule applies to all customers.

  • savedSearches ([SavedSearch!]!)

    A list of customer saved searches that contain the customers who can use the price rule.

Types that return PriceRuleCustomerSelection

Version 2021-04 (Release candidate)

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope.

Connections

  • customers (CustomerConnection!)

    List of customers to whom the price rule applies.

    Argument 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.

    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: false

    savedSearchId ( ID )

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

    sortKey ( CustomerSortKeys )

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

Fields

  • forAllCustomers (Boolean!)

    Whether the price rule applies to all customers.

  • savedSearches ([SavedSearch!]!)

    A list of customer saved searches that contain the customers who can use the price rule.

Types that return PriceRuleCustomerSelection

Version 2021-01 (Latest)

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope.

Connections

  • customers (CustomerConnection!)

    List of customers to whom the price rule applies.

    Argument 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.

    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: false

    savedSearchId ( ID )

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

    sortKey ( CustomerSortKeys )

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

Fields

  • forAllCustomers (Boolean!)

    Whether the price rule applies to all customers.

  • savedSearches ([SavedSearch!]!)

    A list of customer saved searches that contain the customers who can use the price rule.

Types that return PriceRuleCustomerSelection

Version 2020-10

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope.

Connections

  • customers (CustomerConnection!)

    List of customers to whom the price rule applies.

    Argument 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.

    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: false

    savedSearchId ( ID )

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

    sortKey ( CustomerSortKeys )

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

Fields

  • forAllCustomers (Boolean!)

    Whether the price rule applies to all customers.

  • savedSearches ([SavedSearch!]!)

    A list of customer saved searches that contain the customers who can use the price rule.

Types that return PriceRuleCustomerSelection

Version 2020-07

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope.

Connections

  • customers (CustomerConnection!)

    List of customers to whom the price rule applies.

    Argument 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.

    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: false

    savedSearchId ( ID )

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

    sortKey ( CustomerSortKeys )

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

Fields

  • forAllCustomers (Boolean!)

    Whether the price rule applies to all customers.

  • savedSearches ([SavedSearch!]!)

    A list of customer saved searches that contain the customers who can use the price rule.

Types that return PriceRuleCustomerSelection

Version 2020-04

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope.

Connections

  • customers (CustomerConnection!)

    List of customers to whom the price rule applies.

    Argument 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.

    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: false

    savedSearchId ( ID )

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

    sortKey ( CustomerSortKeys )

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

Fields

  • forAllCustomers (Boolean!)

    Whether the price rule applies to all customers.

  • savedSearches ([SavedSearch!]!)

    A list of customer saved searches that contain the customers who can use the price rule.

Types that return PriceRuleCustomerSelection

Version 2020-01 (Unsupported)

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope.

Connections

  • customers (CustomerConnection!)

    List of customers to whom the price rule applies.

    Argument 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.

    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: false

    savedSearchId ( ID )

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

    sortKey ( CustomerSortKeys )

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

Fields

  • forAllCustomers (Boolean!)

    Whether the price rule applies to all customers.

  • savedSearches ([SavedSearch!]!)

    A list of customer saved searches that contain the customers who can use the price rule.

Types that return PriceRuleCustomerSelection

Version 2019-10 (Unsupported)

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope.

Connections

  • customers (CustomerConnection!)

    List of customers to whom the price rule applies.

    Argument 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.

    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: false

    savedSearchId ( ID )

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

    sortKey ( CustomerSortKeys )

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

Fields

  • forAllCustomers (Boolean!)

    Whether the price rule applies to all customers.

  • savedSearches ([SavedSearch!]!)

    A list of customer saved searches that contain the customers who can use the price rule.

Types that return PriceRuleCustomerSelection

Version 2019-07 (Unsupported)

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope.

Connections

  • customers (CustomerConnection!)

    List of customers to whom the price rule applies.

    Argument 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.

    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: false

    savedSearchId ( ID )

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

    sortKey ( CustomerSortKeys )

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

Fields

  • forAllCustomers (Boolean!)

    Whether the price rule applies to all customers.

  • savedSearches ([SavedSearch!]!)

    A list of customer saved searches that contain the customers who can use the price rule.

Types that return PriceRuleCustomerSelection

Version 2019-04 (Unsupported)

A selection of customers for whom the price rule applies.

Required access

read_price_rules access scope.

Connections

  • customers (CustomerConnection!)

    List of customers to whom the price rule applies.

    Argument 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.

    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: false

    savedSearchId ( ID )

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

    sortKey ( CustomerSortKeys )

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

Fields

  • forAllCustomers (Boolean!)

    Whether the price rule applies to all customers.

  • savedSearches ([SavedSearch!]!)

    A list of customer saved searches that contain the customers who can use the price rule.

Types that return PriceRuleCustomerSelection