VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Idiomas

Alterar, padrão e remover

Altera os dados de um idioma da loja, define o idioma padrão e remove um idioma com suas traduções.

Três operações sobre um idioma que a loja já registrou. Todas exigem o privilégio manage_settings. O code na URL é normalizado (pt-br vale pt-BR).

Alterar idioma

PATCH/api/v1/admin/languages/{code}Admin

Altera nome, direção, ordem ou habilitação

Alteração parcial: só os campos enviados mudam. Serve para desabilitar um idioma sem apagar suas traduções, reabilitá-lo, mudar a ordem no seletor ou sobrescrever nomes e direção.

Parâmetros de caminho

codestringobrigatório
Código do idioma.

Corpo da requisição

enabledboolean
false desabilita, true reabilita. Desabilitar o idioma padrão ou um idioma usado por mercado ativo é recusado.
positioninteger
Ordem no seletor de idiomas.
nameEnOverridestring
Nome em inglês só desta loja. Texto vazio ("") volta ao valor do catálogo.
nameNativeOverridestring
Nome nativo só desta loja. Texto vazio volta ao catálogo.
directionOverridestring
LTRRTL
Direção do texto só desta loja.

Exemplo de requisição

bash
curl -X PATCH "$BASE_URL/api/v1/admin/languages/fr" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false}'
200Idioma atualizado
json
{
  "code": "fr",
  "nameEn": "French",
  "nameNative": "Français",
  "direction": "LTR",
  "locale": "fr-FR",
  "enabled": false,
  "isDefault": false,
  "position": 0,
  "createdAt": "2026-07-13T21:39:52.087304Z",
  "updatedAt": "2026-10-11T14:10:00.000Z"
}

Definir idioma padrão

POST/api/v1/admin/languages/{code}/set-defaultAdmin

Promove um idioma habilitado a padrão

O idioma padrão é a fonte do conteúdo: as traduções automáticas partem dele e a vitrine cai nele quando o cliente não escolhe um idioma. Só um idioma é padrão por vez; o anterior perde a marca na mesma operação. Chamar para o idioma que já é padrão não faz nada.

Parâmetros de caminho

codestringobrigatório
Código do idioma. Precisa estar habilitado.

A resposta é 204 No Content, sem corpo.

Remover idioma

DELETE/api/v1/admin/languages/{code}Admin

Remove um idioma e suas traduções da loja

Apaga o registro do idioma na loja junto com todas as traduções da interface e todo o conteúdo traduzido do catálogo naquele idioma. O idioma volta a aparecer no catálogo disponível. Para só tirá-lo da vitrine sem perder o trabalho, prefira desabilitar com PATCH.

Parâmetros de caminho

codestringobrigatório
Código do idioma.

A resposta é 204 No Content.

Erros

StatusQuandoCorpo
400Corpo inválido (alterar){"error":"invalid request body","detail":"..."}
401Sem token ou token expirado{"error":"missing authorization header"}
403Sem o privilégio manage_settings{"error":"insufficient privileges","required":"manage_settings"}
404Idioma sem registro na loja{"error":"language not enabled on this tenant"} (alterar, definir padrão) ou {"error":"language not found"} (remover)
409Desabilitar ou remover o idioma padrão; desabilitar ou remover idioma usado por mercado ativo; promover idioma desabilitado{"error":"cannot disable default language","detail":"cannot disable default language"}, {"error":"cannot remove default language",...}, {"error":"language in use by an active market","detail":"market: Brasil"}, {"error":"cannot promote disabled language","detail":"..."}
422directionOverride diferente de LTR e RTL{"error":"direction must be LTR or RTL","detail":"direction must be LTR or RTL"}
Remover é irreversível

Remover apaga todas as traduções do idioma, inclusive as que pessoas revisaram. Não há lixeira. Se a ideia é só esconder o idioma, use PATCH com enabled: false.

Veja também

  • Habilitar idioma
  • Traduções da interface
Anterior
Habilitar idioma
Próxima
Traduções da interface
Nesta página
  • Alterar idioma
  • Exemplo de requisição
  • Definir idioma padrão
  • Remover idioma
  • Erros
  • Veja também