Get Translations

This API endpoint is used to get all translations lang_keys depending on the language path param request, these translations are variable texts that load on the website, emails and push notifications.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

mode:dictionary

This param returns an object with only the keys and text values, instead of an array of objects with all attributes as the compared example shows below:

Without mode dictionary

{ 
 "error": false,
    "result": [
        {
            "id": 1,
            "key": "MAIN_PAGE_SEARCH_VALIDATION_MSG",
            "text": "Please fill all the fields"
        },
        {
            "id": 2,
            "key": "MAIN_PAGE_SEARCH_ZIPCODE_VALIDATION_MSG",
            "text": "Enter valid zipcode"
        },
        {
            "id": 3,
            "key": "MAIN_PAGE_CHECK_ORDER",
            "text": "Check order status:"
        },
        ...
    ]
}
{
    "error": false,
    "result": {
        "MAIN_PAGE_SEARCH_VALIDATION_MSG": "Please fill all the fields",
        "MAIN_PAGE_SEARCH_ZIPCODE_VALIDATION_MSG": "Enter valid zipcode",
        "MAIN_PAGE_CHECK_ORDER": "Check order status:",
        "BODY_WHERE_ARE_YOU": "Where are you?",
        "FRONT_VISUALS_MOST_POPULAR": "Most Popular",
        "BODY_FOLLOW_US": "Like Us!",
        "BODY_ORDER_FOOD_TITLE": "Order online from the best delivery businesses in your area!",
        "LOGIN_INPUT_EMAIL": "e-mail",
        ...
    }
}

With mode dictionary

{
  "error": false,
  "result": {
    "MAIN_PAGE_SEARCH_VALIDATION_MSG": "Please fill all the fields",
    "LOGIN_INPUT_EMAIL": "e-mail",
    "LOGIN_INPUT_PASSWORD": "password",
        ...
    ]
}

Using Ordering SDK

//Normal
const response = await ordering.translations().get();

//Dictionary
const response = await ordering.translations().asDictionary.get();
Path Params
string
required
Defaults to en
string
required
Defaults to demo
string
required
Defaults to v400
Query Params
string
int32
int32
string
Defaults to dictionary
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json