Traduções dos status

Consulta e grava o nome, a descrição e o assunto do e-mail de cada status de pedido, por idioma.

Cada status de pedido (Status de pedido) pode ter um nome, uma descrição e um assunto de e-mail diferentes para cada idioma que a loja atende. É isso que o cliente lê na vitrine ("Enviado", "Shipped", "Enviado") e no e-mail de aviso de mudança de status.

As duas rotas abaixo leem e gravam esse conjunto de traduções para um status. Elas valem para os idiomas cadastrados na loja (um idioma que a loja não tem é recusado).

GET/api/v1/admin/order-statuses/{code}/descriptionsAdmin

Traduções de um status de pedido

Devolve as traduções gravadas para o status. Um status que nunca recebeu traduções devolve descriptions vazio ({}), e um code que não existe também responde 200 com o mapa vazio, não 404. Exige manage_order_statuses.

Path parameters

codestringobrigatório

Código do status (shipped).

PUT/api/v1/admin/order-statuses/{code}/descriptionsAdmin

Salva as traduções de um status de pedido

Grava as traduções enviadas. Cada idioma presente no mapa é gravado (criado ou substituído); idiomas ausentes do corpo não são tocados. A resposta devolve o conjunto completo, já atualizado. Exige manage_order_statuses.

Path parameters

codestringobrigatório

Código do status.

Corpo da requisição

descriptionsobjectobrigatório

Mapa de traduções, indexado pelo código do idioma da loja (pt-BR, es, en...).

namestring

Nome do status neste idioma.

descriptionstring

Descrição, mostrada ao cliente quando a loja a exibe.

email_subjectstring

Assunto do e-mail enviado ao cliente quando um pedido entra neste status.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/order-statuses/shipped/descriptions" \
  -H "Authorization: Bearer $TOKEN"

curl -X PUT "$BASE_URL/api/v1/admin/order-statuses/shipped/descriptions" \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{
    "descriptions": {
      "pt-BR": { "name": "Enviado", "description": "A transportadora retirou o pacote", "email_subject": "Seu pedido foi enviado" },
      "es": { "name": "Enviado", "email_subject": "Su pedido fue enviado" }
    }
  }'

Resposta

200Traduções do status

json

{
  "descriptions": {
    "pt-BR": {
      "lang_code": "pt-BR",
      "name": "Enviado",
      "description": "A transportadora retirou o pacote",
      "email_subject": "Seu pedido foi enviado"
    },
    "es": {
      "lang_code": "es",
      "name": "Enviado",
      "description": "",
      "email_subject": "Su pedido fue enviado"
    }
  }
}

Campos da resposta

descriptionsobject

Mapa idioma para tradução.

descriptions.{lang}.lang_codestring

Código do idioma (repete a chave).

descriptions.{lang}.namestring

Nome do status.

descriptions.{lang}.descriptionstring

Descrição. Vazia quando não definida.

descriptions.{lang}.email_subjectstring

Assunto do e-mail. Vazio quando não definido.

Erros

Status	Quando	Corpo
400	Corpo inválido, `descriptions` ausente ou vazio, ou idioma que a loja não tem	`{"error":"descriptions map is required"}` ou `{"error":"language zz is not registered on this tenant"}`
401	Sem token ou token expirado	`{"error":"invalid or expired token"}`
403	Sem `manage_order_statuses`	`{"error":"insufficient privileges","required":"manage_order_statuses"}`
500	Falha ao ler ou gravar	`{"error":"failed to load descriptions","detail":"..."}`

Veja também

Traduções dos status

Consulta e grava o nome, a descrição e o assunto do e-mail de cada status de pedido, por idioma.

As duas rotas abaixo leem e gravam esse conjunto de traduções para um status. Elas valem para os idiomas cadastrados na loja (um idioma que a loja não tem é recusado).

GET/api/v1/admin/order-statuses/{code}/descriptionsAdmin

Traduções de um status de pedido

Path parameters

codestringobrigatório

Código do status (shipped).

PUT/api/v1/admin/order-statuses/{code}/descriptionsAdmin

Salva as traduções de um status de pedido

Path parameters

codestringobrigatório

Código do status.

Corpo da requisição

descriptionsobjectobrigatório

Mapa de traduções, indexado pelo código do idioma da loja (pt-BR, es, en...).

namestring

Nome do status neste idioma.

descriptionstring

Descrição, mostrada ao cliente quando a loja a exibe.

email_subjectstring

Assunto do e-mail enviado ao cliente quando um pedido entra neste status.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/order-statuses/shipped/descriptions" \
  -H "Authorization: Bearer $TOKEN"

curl -X PUT "$BASE_URL/api/v1/admin/order-statuses/shipped/descriptions" \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{
    "descriptions": {
      "pt-BR": { "name": "Enviado", "description": "A transportadora retirou o pacote", "email_subject": "Seu pedido foi enviado" },
      "es": { "name": "Enviado", "email_subject": "Su pedido fue enviado" }
    }
  }'

Resposta

200Traduções do status

json

{
  "descriptions": {
    "pt-BR": {
      "lang_code": "pt-BR",
      "name": "Enviado",
      "description": "A transportadora retirou o pacote",
      "email_subject": "Seu pedido foi enviado"
    },
    "es": {
      "lang_code": "es",
      "name": "Enviado",
      "description": "",
      "email_subject": "Su pedido fue enviado"
    }
  }
}

Campos da resposta

descriptionsobject

Mapa idioma para tradução.

descriptions.{lang}.lang_codestring

Código do idioma (repete a chave).

descriptions.{lang}.namestring

Nome do status.

descriptions.{lang}.descriptionstring

Descrição. Vazia quando não definida.

descriptions.{lang}.email_subjectstring

Assunto do e-mail. Vazio quando não definido.

Erros

Status	Quando	Corpo
400	Corpo inválido, `descriptions` ausente ou vazio, ou idioma que a loja não tem	`{"error":"descriptions map is required"}` ou `{"error":"language zz is not registered on this tenant"}`
401	Sem token ou token expirado	`{"error":"invalid or expired token"}`
403	Sem `manage_order_statuses`	`{"error":"insufficient privileges","required":"manage_order_statuses"}`
500	Falha ao ler ou gravar	`{"error":"failed to load descriptions","detail":"..."}`