Listar e consultar idiomas

Lista os idiomas da loja, o catálogo de idiomas ainda não habilitados e consulta um idioma pelo código.

Use estas três rotas para montar a tela de idiomas da loja: o que já está habilitado, o que ainda dá para habilitar e o detalhe de cada um. Todas exigem o privilégio manage_settings. As respostas usam camelCase.

Listar idiomas da loja

GET/api/v1/admin/languagesAdmin

Lista os idiomas da loja

Devolve todos os idiomas que a loja já registrou, inclusive os desabilitados (enabled: false). Não há paginação nem filtros.

Exemplo de requisição

200Idiomas retornados

Campos da resposta

items[].codestring

Código do idioma (BCP 47), por exemplo pt-BR, es, zh-CN.

items[].nameEnstring

Nome em inglês. Vale a sobrescrita da loja, se houver; senão o do catálogo.

items[].nameNativestring

Nome no próprio idioma (Español). Mesma regra da sobrescrita.

items[].directionstring

LTRRTL

Direção do texto.

items[].localestring

Locale usado para formatar datas e números (pt-BR, ar-SA). Não pode ser sobrescrito.

items[].enabledboolean

Se a vitrine oferece o idioma. Um idioma desabilitado continua listado.

items[].isDefaultboolean

Se é o idioma padrão da loja. Só um idioma tem true.

items[].positioninteger

Ordem de exibição no seletor de idiomas. Menor aparece primeiro.

items[].createdAtstring

Quando foi registrado na loja (RFC 3339, UTC).

items[].updatedAtstring

Última alteração (RFC 3339, UTC).

Listar o catálogo disponível

GET/api/v1/admin/languages/catalogAdmin

Lista os idiomas do catálogo ainda não habilitados

Devolve os idiomas do catálogo mestre que a loja ainda não registrou. É a lista de onde você escolhe o code para habilitar um idioma.

200Catálogo retornado

Os campos são os mesmos da lista de idiomas, trocando enabled, isDefault e position por status: A indica entrada ativa do catálogo.

Consultar um idioma

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

Consulta um idioma da loja

Parâmetros de caminho

codestringobrigatório

Código do idioma (pt-BR).

200Idioma encontrado

Erros

Status	Quando	Corpo
401	Sem token ou token expirado	`{"error":"missing authorization header"}`
403	Sem o privilégio `manage_settings`	`{"error":"insufficient privileges","required":"manage_settings"}`
404	Idioma sem registro na loja (consultar)	`{"error":"language not enabled on this tenant"}`
500	Falha interna ao ler idiomas	`{"error":"failed to list languages","detail":"..."}`

Veja também