Tiers Configurations

Changed on

This API call retrieves the tiers configuration, including the benefits and rewards associated with each tier.

get/api/v4.0/integrations/configurations/tiers

Request

  • Base URL: https://api.gameball.co
  • URL: https://api.gameball.co/api/v4.0/integrations/configurations/tiers
  • Auth: API key in header apikey

Headers

langstring

If the lang header is provided, the response will be returned in the specified language (e.g., en for English, fr for French). If this header is not included, the system will use the default language.

Response

VIP tiers retrieved successfully

namestring

The name of the tier.

minProgressnumber

The minimum amount of progress a customer needs to reach this tier in the program. This represents the threshold that must be met for a customer to reach this tier. Example: if the minProgress is set to 2000, the customer must accumulate 2000 points, referrals, or completed orders (depending on the tiering method) to reach this tier. Possible Values: Total amount spent, Total points earned, Friends referred, Orders completed, Score. Example: If the progress value is 1500 and the tiering-up method is total points earned, this means the customer has earned a total of 1500 points toward their next tier.

ordernumber

This represents the numerical order of a tier. Higher numbers indicate higher tiers.

iconstring

The URL for the icon associated with the tier. You can utilize this icon URL to display tier badges or indicators in your own custom interface, such as on customer profiles.

Changes

  • 8f6120fdd12dRevision changes
    • breaking

      the response's body type changed from object to array for status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id getTiersConfigurations was added

    • info

      added the new optional header request parameter lang

  • 1ef1de7fdc61Revision changes
    • info

      endpoint added