Consultar todas as situações de pedido da loja

A plataforma possui uma tela de gerenciamento de status de pedidos totalmente personalizável, oferecendo a possibilidade de que situações sejam permitidas ou não dependendo do status em que o pedido se encontra.

Existem na plataforma 23 opções de status de pedido já pré-definidos e é possível personalizar a nomenclatura dos status.

Confira algumas personalizações importantes que podem afetar sua integração de pedidos:

  • Descrição: situação do pedido personalizada, será retornada no campo descricao do response body;
  • Observação: utilizada uma breve descrição da situação do pedido, será retornada no campo observacao do response body;
  • Situações permitidas*: situações de pedidos que permitem alterações;

📘

Situações Permitidas

Uma vez que uma situação é vinculada, quando o pedido estiver com o status "Em Preparação" será permitido alterar a situação somente para "Cancelado ou Entregue". Os demais status não poderão ser utilizados. Se nenhuma situação for vinculada, todos os status podem ser alterados no pedido.

  • Reintegrar Pedido: quando ativada, uma vez que o pedido é alterado para o status correspondente o pedido será listado novamente para integração no GET de pedidos. Já ao manter a opção desativada não será disponibilizada a opção de realizar um novo GET de pedido.

❗️

Situações para controle de transações de Pagamento

É importante destacar que existem 5 situações específicas destinadas ao controle das transações de pagamento. Recomendamos evitar sua utilização para outras finalidades no processo de gestão de pedidos com o ERP.

Id da situaçãoSituação
1Pago
2Aguardando Pagamento
8Pedido Cancelado
10Pedido Autorizado
14Pedido Aprovado Análise

Para consultar todas as situações de pedidos disponíveis na loja, utilize o endpoint Retorna todas as situações de pedido da loja.

Response Body

[
  {
    "situacaoPedidoId": 1,
    "nome": "Pago",
    "descricao": "Pago",
    "observacao": "Pedido Pago"
  },
  {
    "situacaoPedidoId": 2,
    "nome": "Aguardando Pagamento",
    "descricao": "Aguardando Pagamento",
    "observacao": "Aguardando Liberação"
  },
  {
    "situacaoPedidoId": 3,
    "nome": "Pedido Cancelado",
    "descricao": "Pedido Cancelado",
    "observacao": "Cartão Temporariamente Negado"
  },
  {
    "situacaoPedidoId": 4,
    "nome": "Pedido Cancelado",
    "descricao": "Pedido Cancelado",
    "observacao": "Cartão Negado"
  },
  {
    "situacaoPedidoId": 5,
    "nome": "Pedido Cancelado",
    "descricao": "Pedido Cancelado",
    "observacao": "Fraude"
  },
  {
    "situacaoPedidoId": 6,
    "nome": "Pedido Cancelado",
    "descricao": "Pedido Cancelado (Suspeita)",
    "observacao": "Suspeito de Fraude"
  },
  {
    "situacaoPedidoId": 7,
    "nome": "Pedido Cancelado",
    "descricao": "Cancelado",
    "observacao": "Pedido Cancelado"
  },
  {
    "situacaoPedidoId": 8,
    "nome": "Pedido Cancelado",
    "descricao": "Pedido Cancelado",
    "observacao": "Cancelado"
  },
  {
    "situacaoPedidoId": 9,
    "nome": "Pedido Enviado",
    "descricao": "Pedido Enviado",
    "observacao": "Enviado"
  },
  {
    "situacaoPedidoId": 10,
    "nome": "Pedido Autorizado",
    "descricao": "Pedido Autorizado",
    "observacao": "Pedido Autorizado"
  },
  {
    "situacaoPedidoId": 11,
    "nome": "Pedido Enviado",
    "descricao": "Em preparação",
    "observacao": "Faturado - Nota fiscal emitida e Pedido Preparado."
  },
  {
    "situacaoPedidoId": 12,
    "nome": "Pedido Devolvido",
    "descricao": "Pedido Devolvido",
    "observacao": "Pedido devolvido pelo Correio"
  },
  {
    "situacaoPedidoId": 13,
    "nome": "Documentos Para Compra",
    "descricao": "Verificar Situação",
    "observacao": "Verificar"
  },
  {
    "situacaoPedidoId": 14,
    "nome": "Pedido Aprovado Analise",
    "descricao": "Pedido Aprovado Analise",
    "observacao": "Aprovado Analise"
  },
  {
    "situacaoPedidoId": 15,
    "nome": "Recebido",
    "descricao": "Recebido",
    "observacao": "Produto encomendado chega ao estoque"
  },
  {
    "situacaoPedidoId": 16,
    "nome": "Separado",
    "descricao": "Separado",
    "observacao": "Produto exite em estoque"
  },
  {
    "situacaoPedidoId": 17,
    "nome": "Encomendado",
    "descricao": "Encomendado",
    "observacao": "Produto não exite em estoque"
  },
  {
    "situacaoPedidoId": 18,
    "nome": "Entregue",
    "descricao": "Entregue",
    "observacao": "Entregue"
  },
  {
    "situacaoPedidoId": 19,
    "nome": "Aguardando Troca de Pagamento",
    "descricao": "Aguardando Troca de Pagamento",
    "observacao": "Aguardando Alteração de Forma de Pagamento"
  },
  {
    "situacaoPedidoId": 20,
    "nome": "Pedido Conferido",
    "descricao": "Pedido Conferido",
    "observacao": "Pedido Conferido"
  },
  {
    "situacaoPedidoId": 21,
    "nome": "Retirar na Loja",
    "descricao": "Retirar na Loja",
    "observacao": "Disponível para Retirar na Loja"
  },
  {
    "situacaoPedidoId": 22,
    "nome": "Pagamento Negado",
    "descricao": "Pagamento Negado",
    "observacao": "Pagamento negado, porém o pedido não foi cancelado"
  },
  {
    "situacaoPedidoId": 23,
    "nome": "Creditado",
    "descricao": "Entregue",
    "observacao": "Creditado na lista de eventos"
  }
]

Situação dos Pedidos e disparo dos E-mails Transacionais

Cada status dispara automaticamente um template de e-mail específico, cuja relação não pode ser alterada. Portanto, o usuário que deseja alterar essas informações, deve ficar atento a qual template de e-mail cada status envia e alterar somente as informações de descrição e observação já citadas.

Na tabela abaixo, consta a relação de todos os status e quais e-mails transacionais eles disparam:

Id da situaçãoSituaçãoTemplate
1PagoPEDIDO_PAGO
2Aguardando PagamentoPEDIDO_CONFIRMADO
3Pedido CanceladoCARTÃO_NEGADO
4Pedido CanceladoCARTÃO_NEGADO
5Pedido CanceladoPEDIDO_CANCELADO
6Pedido Cancelado (Suspeita)PEDIDO_CANCELADO
7Pedido CanceladoBOLETO_EXPIRADO
8Pedido CanceladoPEDIDO_CANCELADO
9Pedido EnviadoPEDIDO_ENVIADO
10Pedido AutorizadoNão dispara e-mail
11Em PreparaçãoPEDIDO_FATURADO
12Pedido DevolvidoPEDIDO_DEVOLVIDO
13Documentos Para CompraDOCUMENTOS
14Pedido Aprovado AnáliseNão dispara e-mail
15RecebidoPEDIDO_RECEBIDO
16SeparadoPEDIDO_SEPARADO
17EncomendadoPEDIDO_ENCOMENDADO
18EntreguePEDIDO_ENTREGUE
19Aguardando troca de PagamentoALTERAÇÃO_PAGAMENTO
20Pedido ConferidoNão dispara e-mail
21Retirar na LojaRETIRAR_NA_LOJA
22Pagamento NegadoPAGAMENTO_NEGADO
23Entregue (Lista de Eventos)PEDIDO_ENTREGUE (Lista de Eventos)