Loyalty Program

Get Loyalty Settings

Changed on
get/v1/loyalty

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/loyalty
  • Auth
    HTTP bearer

Response

Program retrieved

namestring required

The name of the loyalty program

keystring nullable

External key of the loyalty program

descriptionstring nullable

A brief description of the loyalty program

custom_icon_urlstring uri nullable

Custom icon URL for loyalty points

activated_atinteger nullable

Timestamp when the program was activated (UNIX time)

end_atinteger nullable

Timestamp when the program ends (UNIX time)

periodinteger required

The duration of the loyalty program in days

repeatableboolean

Whether the program is repeatable

points_ratenumber required

Exchange rate against the dollar

price_source'local_price' | 'base_price'
excluded_sales_channelsOrderSourceType[] nullable

The list of Order Sources (sales channels) where paid orders will not issue Loyalty Points

show_store_buttonboolean

Whether to show the 'Go to Store' button in the loyalty program widget

idstring required

The unique identifier for the loyalty tier

game_idstring required

The unique identifier of the game the accosiated with the loyalty program

Changes

  • 84e35f2954bfRevision changes
    • warning

      added the new store enum value to the /// response property for the response status

    • warning

      added the new store enum value to the /// response property for the response status

  • 1816e2044c07Revision changes
    • warning

      added the new function enum value to the /// response property for the response status

    • warning

      added the new function enum value to the /// response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status