PriceRule object

Version unstable

Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.

Required access

read_price_rules access scope.

Connections

  • List of the price rule's discount codes.

    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:

    • times_used

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

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

    savedSearchId ( ID )

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

    sortKey ( DiscountCodeSortKeys )

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

  • events (EventConnection!)

    The paginated list of events associated with the price rule.

    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 (