GiftCardSortKeys enum

Version unstable

The set of valid sort keys for the GiftCard query.

Values

  • AMOUNT_SPENT

    Sort by the amount_spent value.

  • BALANCE

    Sort by the balance value.

  • CODE

    Sort by the code value.

  • CREATED_AT

    Sort by the created_at value.

  • CUSTOMER_NAME

    Sort by the customer_name value.

  • DISABLED_AT

    Sort by the disabled_at value.

  • EXPIRES_ON

    Sort by the expires_on value.

  • ID

    Sort by the id value.

  • INITIAL_VALUE

    Sort by the initial_value value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

  • UPDATED_AT

    Sort by the updated_at value.

Version 2021-10 (Release candidate)

The set of valid sort keys for the GiftCard query.

Values

  • AMOUNT_SPENT

    Sort by the amount_spent value.

  • BALANCE

    Sort by the balance value.

  • CODE

    Sort by the code value.

  • CREATED_AT

    Sort by the created_at value.

  • CUSTOMER_NAME

    Sort by the customer_name value.

  • DISABLED_AT

    Sort by the disabled_at value.

  • EXPIRES_ON

    Sort by the expires_on value.

  • ID

    Sort by the id value.

  • INITIAL_VALUE

    Sort by the initial_value value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

  • UPDATED_AT

    Sort by the updated_at value.

Version 2021-07 (Latest)

The set of valid sort keys for the GiftCard query.

Values

  • AMOUNT_SPENT

    Sort by the amount_spent value.

  • BALANCE

    Sort by the balance value.

  • CODE

    Sort by the code value.

  • CREATED_AT

    Sort by the created_at value.