languages

• languages.find
• languages.create
• languages.update
• languages.delete

languages.find

Returns all the languages of the site.

Request

Admin SDK
Admin.api('site.languages.find', request, function(response) { … });

HTTP POST
/api/v10/site.languages.find

{
  "fields" : [ "code", "name", … ] // fields to return - string
}

Response

{
  "status" : "ok",
  "languages" : [ { // languages
    "code" : "de", // code (ISO) - string(2)
    "name" : "Deutsch (German)", // name - string(1…35)
    "region" : "DE", // region (ISO code) - string(2)
    "currency" : "EUR", // currency (ISO code) - string(3)
    "isActive" : true, // indicates if it is showed on the site - bool
    "isDefault" : true // indicates if it is the dafult language - bool
  }, … ]
}

languages.create

Creates a new language for the site

Request

Admin SDK
Admin.api('site.languages.create', request, function(response) { … });

HTTP POST
/api/v10/site.languages.create

{
  "language" : { // language to create (required)
    "code" : "de", // code (ISO) (required) - string(2)
    "region" : "DE", // region (ISO code) (required) - string(2)
    "currency" : "EUR", // currency (ISO code) - string(3)
    "isActive" : true // indicates if it is showed on the site - bool
  }
}

Response

{
  "status" : "ok"
}

Errors

languages.update

Updates a language. Any fields left out of the request will remain unchanged.

Request

Admin SDK
Admin.api('site.languages.update', request, function(response) { … });

HTTP POST
/api/v10/site.languages.update

{
  "code" : "de", // code (ISO) of the language to update (required) - string(2)
  "language" : { // language's fields to update (required)
    "code" : "en", // new code (ISO) - string(2)
    "region" : "UK", // region (ISO code) - string(2)
    "currency" : "GBP", // default currency (ISO code) - string(3)
    "isActive" : true // indicates if it is showed on the site - bool
  }
}

Response

{
  "status" : "ok"
}

Errors

languages.delete

Deletes one or more languages. The first language can not be deleted.

Request

Admin SDK
Admin.api('site.languages.delete', request, function(response) { … });

HTTP POST
/api/v10/site.languages.delete

{
  "codes" : [ "de", "en", … ] // codes (ISO) of the languages to delete (required) - string(2)
}

Response

{
  "status" : "ok"
}

Available languages

The following languages are supported: