Campos de status
Referência de todos os campos de um objeto de status, com descrição, valor padrão e valores aceitos.
Um status tem várias propriedades, representadas por campos. Cada campo define um comportamento ou uma característica específica do status.
Referência dos campos de status
| Nome do campo | Descrição | Valor padrão | Valores aceitos |
|---|---|---|---|
description* | Título do status | n/d | string |
email_header | Cabeçalho do e-mail enviado quando o status é aplicado | '' | HTML |
email_subj | Assunto do e-mail enviado quando o status é aplicado | '' | string |
is_default | Flag que define se o status é padrão (não pode ser excluído). Não é recomendado retirar a marca de padrão de um status que já é padrão. | N | Y, N |
lang_code | Código do idioma | en | en, ru etc. |
params | Parâmetros do status | {} | Objeto JSON |
status | Letra que identifica o status | Definido automaticamente | char |
status_id | Id do status | Definido automaticamente | integer |
type | Tipo do status | O | Tipo de status válido (só O por padrão) |
Exemplo de objeto de status
json
{
"description": "Processing",
"email_header": "<h1>Your order is being processed</h1>",
"email_subj": "Order #12345 is now being processed",
"is_default": "N",
"lang_code": "en",
"params": {},
"status": "P",
"status_id": 5,
"type": "O"
}