LogoLogo
HomepageCase studiesBook a demo
User Guide
User Guide
  • Welcome to Open Loyalty!
  • What's New
    • 2024
    • 2023
    • 2022
  • What's Next
  • Technical Guide
  • Main Features
    • Global Management
      • Analytics
      • Settings
      • Config Duplication
      • Usage
    • Dashboard
      • General Overview
      • Units Wallet Overview
      • Additional Metrics
      • Members by Tiers
    • Members
      • Member List
        • Configuration
        • Creating Members
        • Managing Members
        • Removing Members
      • Segments
        • Creating Segments
        • Managing Segments
        • Segment Conditions
      • Referred Members
    • Campaigns
      • Creating Campaigns
        • Return Campaign
        • Referral Campaign
        • Time-Based Campaign
        • Redemption Code Campaign
        • Internal event - Achievement progressed
        • Percent value distribution
      • Managing Campaigns
      • Campaign Simulation
      • Follow-up Campaigns
    • Custom Events
      • Custom Event Schemas
    • Transactions
      • Adding Transactions
      • Managing Transactions
      • Channels
    • Tiers
      • Adding Tiers
      • Managing Tiers
      • Tiers Configuration
      • Tier Benefits
    • Wallets
      • Wallet Types and Configuration
      • Unit Transfers
        • Creating Unit Transfers
        • Importing Unit Transfers
        • Managing Unit Transfers
    • Achievements
      • Creating Achievement
      • Managing Achievements
      • Follow up Achievements
    • Rewards
      • Reward List
        • Rewards Configuration
        • Creating Reward
        • Reward Types
        • Units Conversion Coupon
        • Adding Coupons
        • Reward Flow
      • Reward Fulfillment
      • Reward Categories
    • Webhooks
      • How to Configure a Webhook
      • What Triggers a Webhook
      • Expiring Notifications
    • Collections
    • Imports / Exports
      • Imports
        • Sample Import Files
      • Exports
        • UI Data Exports
        • Configuration Exports
        • S3 Bucket Exports
    • Settings
      • Roles
      • Admins
        • System Logs
      • Tenants
      • Translations
    • Expressions
      • Attributes List
      • Operators
      • Custom Functions
      • Expression Examples
      • Sample Use Cases
        • Using Member Custom Attributes
        • Complex Effects (if, else)
        • Excluding Members
        • Elapsed Time Conditions
        • Using Additional Dates for Calculations
        • Register on Birthday
        • Transaction on Birthday
        • Tier Upgrade or Downgrade
  • Sample Setups
    • Good Practices
    • Pay with Points
    • Promo and Discounts in Cart
    • Sample Campaigns
      • #1 Earn 1 point for every $1 spent
      • #2 Earn 2x points when shopping on Monday morning
      • #3 Earn 1 stamp for every transaction
      • #4 Buy product ACME 123 and earn 100 points
      • #5 Refer a friend and get 100 points
      • #6 Refer 5 friends and get a $50 off coupon for the next purchase
      • #7 Register to the program and get 50 bonus points
      • #8 Get 30 bonus points for your first transaction in the loyalty program
      • #9 Cashback campaign
      • #10 Product meets selected criteria
    • Sample Achievements
      • #1 Celebrate summer - Buy 5 times between June and August
      • #2 Place 10 Orders above 50€ - Complete 10 transactions, for more than 50€ each
      • #3 Ambitious player - Log in to the game 3 times per week for 8 consecutive weeks
      • #4 SKU 'ABC' configuration - Spend total of 100$ on products with SKU 'ABC132' in September
      • #5 Workout track -Track a workout of at least 30 minutes for 5 days in a row
      • #6 4 referees made the transactions for 2 consecutive weeks
      • #7 2 referees made a transaction configuration
  • FAQ
    • Configuration Migration
    • Custom Attributes
    • Achievements
    • GDPR
    • Opt-Out
    • Referral Programs
    • Returns and Cancellations
    • Timezones
Powered by GitBook
On this page

Was this helpful?

  1. Main Features
  2. Settings

Translations

In this section, you will learn how to manage the translations.

Last updated 8 months ago

Was this helpful?

Translations

The Translations section allows the defining of many language versions used throughout the Open Loyalty platform. All content elements will appear in the selected default language.

Most of the text that appears to be hard-coded on pages throughout your loyalty platform can be instantly changed to a different language by changing the default language parameter. The Default language is selected during the translation creation process but can be changed at any time in edition mode.

Moreover, during Campaigns and Tier creation/edition processes, an Admin can fulfill the Basic Information section in every language version listed here. For example, if we have Polish and English translations, there is a possibility to provide Basic information on Tiers and Campaigns in both languages.

Thanks to this, changing the default language translates the text word-for-word and references a different translation table that provides the interface text that is used in the Admin and Client cockpit. The text that can be changed includes navigational titles, labels, buttons, and links such as “List of customers” and “Account”, Campaigns and Tier names, descriptions, etc.

Currently, Open Loyalty is available in English.

To open the Translations list, go to Settings -> Translations. All available languages are listed in the table. You can change the number of rows displayed per page by clicking on the arrow icon below the table and picking a handy number from the list.

RTL (right-to-left) is supported for Arabic and Hebrew language.


Adding translations

To add a new translation:

  1. Go to Settings -> Translations

  2. Click on the 'Add Language' button. From these units, please complete such information as:

    • Code - Language identifier

    • Name - Language name

    • Order

If you would like to set such language as a default right away, please mark the 'Default' check box. But this may be marked only when the translation is already prepared and added.

To dismiss the 'Add language' screen, click on the 'X' button next to the header.

  1. Click SAVE

To add a new language via the API, use this endpoint:


Managing translations

Editing language

To edit the selected language, click on the overflow button and pick from the expanded list Edit language option, here you can edit such values as Name and Order, as well as change the default language by marking the checkbox.

To set the selected language as the default one you need to find yourself on the 'Translations list' view, here click on the overflow button, next to the picked language, and choose the 'Edit language' option. In the Edit language 'name' screen mark Admin default and API default checkboxes and click 'Save'. You will return to the 'Translations list' view where the 'Language updated' toast message will appear, and information on which language is defaulted and when it was updated will be updated in the table.


Editing translation

To edit/add a translation, click on the overflow button and pick from the expanded list Edit translation option. On the 'Edit translation name' screen, you can add the translation for any value in the app. In the middle column, you need to add translation and on the left, you have the default language value present. Click on the record you would like to add (right in the middle) and add a new value. To dismiss this screen, click on the 'X' button and the value will be saved - so if you reopen the Edit translation, the screen will be presented.

To save all the currently active key names, you can retrieve them and save them via this endpoint:

Afterwards, you can translate all the entries and upload them via this endpoint (one key at a time):


Removing language

To remove the language, click on the overflow button and pick the Remove option from the list. 'Do you want to remove this translation?' pop-up window will show up, confirm your action by clicking on the YES button. The Toast message will appear and the selected translation will be removed from the list.

Get translations list

get

Management This method returns all Translations.

Authorizations
Query parameters
_localestringOptional
Responses
200Success
application/json
get
GET /api/translation HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Get translation key details

get

Management This method returns one Translation key and its value in all Languages supported.

Authorizations
Path parameters
keystringRequired
Responses
200Success
application/json
401
Unauthorized
application/json
403
Forbidden.
application/json
404
Not found.
application/json
get
GET /api/translation/key/{key} HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Accept: */*
[
  {
    "languageCode": "text",
    "key": "text",
    "value": "text",
    "updatedAt": "2025-05-16T14:23:53.661Z"
  }
]
  • Translations
  • Adding translations
  • POSTAdd a language
  • Managing translations
  • Editing language
  • Editing translation
  • GETGet translations list
  • GETGet translation key details
  • Removing language

Add a language

post

Management This method allows creating a new Language.

Authorizations
Body
namestringRequired
codestringRequired
apiDefaultbooleanRequired
adminDefaultbooleanRequired
orderintegerRequired
Responses
200
Returned when successful
application/json
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden.
application/json
post
POST /api/language HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "name": "text",
  "code": "text",
  "apiDefault": true,
  "adminDefault": true,
  "order": 1
}
{
  "name": "text",
  "code": "text",
  "apiDefault": true,
  "adminDefault": true,
  "order": 1
}