API Reference

Entidade order_status

Os status de pedidos definem em que etapa um pedido realizado na loja está.

state X status

Os conceitos de status e state para pedidos são distintos e desempenham papéis diferentes no fluxo de processamento de pedidos.

State (Estado do Pedido)

📍Definição: O State (ou "estado") de um pedido é uma etapa fixa no ciclo de vida do pedido e representa a posição desse pedido no fluxo de processamento. Os "states" são definidos pelo próprio sistema e não podem ser modificados ou excluídos.**

📍Objetivo: Os states são usados para controlar a lógica do pedido, e cada state indica um passo importante do ciclo de vida do pedido. A API geralmente utiliza os states para determinar o estágio de processamento.

CódigoTítuloDescrição
newNovoAplicado a todos os pedidos recém-chegados à loja e ainda não foram revisados ou processados.
pending_paymentPendenteAplicado a pedidos que aguardam confirmação de pagamento.
processingProcessandoAplicado a pedidos que tiveram seu pagamento confirmado e estão em fase de processamento para faturamento ou execução. Ou seja, pedidos faturados.
completeCompletoIndica que o pedido foi faturado, entregue e está finalizado, sem mais etapas pendentes.
closedFechadoO status é atribuído quando é gerado um reembolso integral do pedido, efetivamente fechando-o.
canceledCanceladoIndica que o pedido foi cancelado e não será completo.
holdedSeguradoPedidos temporariamente interrompidos, como aguardando compensação bancária para pagamentos via boleto.
payment_reviewAnálise de PagamentoIndica que o pagamento do pedido está sendo revisado pelo processador de pagamento para verificação adicional ou suspeita de problema.
fraudSuspeita de FraudeIndica que o pagamento foi sinalizado como suspeito de fraude pelo processador de pagamento.

Status (Status do Pedido)

📍Definição: O Status é uma representação mais descritiva e flexível do estado de um pedido. Ele fornece informações detalhadas sobre a situação atual do pedido, mas está vinculado a um determinado state.

📍Exemplos de Status: Um pedido com state processing pode ter status como nfe_emitida, indicando que a NFE do pedido já foi emitida. Para o sistema, o pedido ainda está na etapa processing, mas para o usuário será possível visualizar o pedido com este novo status, para fins de organização.

📍Personalização: Diferentemente dos states, os status podem ser configurados e adicionados através do painel de administração da loja virtual, permitindo customizar a descrição do estado do pedido para atender às necessidades específicas do lojista. Esses status adicionais são mapeados para states existentes, mas permitem uma maior granularidade e controle no acompanhamento dos pedidos.


Resumo da Diferença

States são fixos, predeterminados pelo sistema e representam etapas específicas do fluxo de processamento de pedidos.
Status são configuráveis, podendo ser criados e personalizados via painel de administração, oferecendo uma descrição mais detalhada do state do pedido.

Campos

Abaixo, segue a descrição dos possíveis campos e seus valores nas requisições desta entidade.

CampoCampo PaiTipoDescrição
status *-stringIdentificador único (código) do status
state*-stringStateao qual o status é vinculado
title*-stringTítulo do status