Os fluxos que serão executados a cada status recebido

As ações executadas na plataforma são baseadas em fluxos que executam determinadas tarefas para que alguma ação ocorra, como, por exemplo, o envio de um pedido para uma fila de integração para que um ERP faça a leitura do pedido. 

Para que os status sejam alterados ao enviar as informações na API, precisa configurar previamente um fluxo para cada ação acessando as configurações em Configs > Configurações gerais > Configurações por grupo > Fluxos

Ao abrir as configurações dos fluxos, teremos todos os fluxos de pedidos que temos preparados para receber a atualização via API e seus respectivos tipos. Agora, precisamos configurar o fluxo que será executado na plataforma quando recebermos determinado tipo de fluxo nas requisições via API.

Temos 5 fluxos previamente criados que executam tarefas costumeiras para cada tipo, conforme explicamos abaixo. Ao configurar cada alteração, clique em "Selecione" e escolha de acordo com a tabela abaixo. 

Campo Fluxo para selecionar
Confirmar pagamento (4) Pedido - Pagamento
Faturar pedido (5) Pedido - Faturado
Despachar pedido (6) Pedido - Enviado
Marcar como entregue (7) Pedido - Entregue
Cancelar pedido (8) Pedido - Cancelamento

? É válido saber...

Caso seja necessário que (ao recebermos estas alterações via API) seu pedido execute alguma tarefa/ação específica diferente do que temos previamente programado, nós permitimos que isso seja feito através da alteração da configuração do fluxo. 

 

 

Enviando a atualização de status via API

Temos um método específico para a ação da alteração dos status em nossa API, chamado de UpdateOrder.

Para escolhermos os status para qual alteraremos um pedido, basta passar no campo WorkflowType os valores, de acordo com a especificação abaixo:

  • ConfirmPayment: pedido pago
  • Invoiced: pedido faturado
    Necessário enviar: informações da NFe no corpo da requisição conforme detalhado na documentação do método na API.
  • Shipped: pedido enviado
  • Delivered: pedido entregue
  • Canceled: pedido cancelado

REQUEST DE EXEMPLO

{
    "OrderNumber": "TESTE-000286",
    "WorkflowType": "ConfirmPayment"
}

Ao enviar esta requisição, será executado o fluxo (4) Pedido - Pagamento que efetuará a confirmação do pagamento do pedido e alteração do status do mesmo para PAGO.

  • Sem rótulos