Guia de integração de ERPs - Pedidos

VTEX Team

VTEX Team

Última atualização
Este artigo é parte do Guia de integração de ERPs.

Este documento tem por objetivo auxiliar na integração de pedidos entre uma loja hospedada na VTEX e seu ERP. O fluxo consiste em ler os pedidos prontos pro ERP na VTEX, inserir os pedidos no ERP, enviar para a loja na VTEX as informações de nota fiscal e tracking e ou cancelamento de pedido.

Pedidos

Obter a lista de pedidos prontos para o ERP na VTEX e inserir os pedidos no ERP, atualizando a VTEX que o pedido já está no ERP.

Fluxo:

Obter a Lista de Pedidos por Status na API do OMS

Através da API do OMS pegar a lista de pedidos prontos para o ERP paginados com o método OMS - Get feed order status.

Esse exemplo retorna uma lista com o resumo de cada pedido, onde para cada pedido, deve se fazer uma chamada na API REST do OMS para pegar o pedido completo passando o “orderId” do pedido.

Obter um Pedido Pelo Identificador na API do OMS

Através da API do OMS pegar um pedido pelo identificador (orderId): OMS - Get order

Pedido Está no ERP - Preparando Entrega

Uma vez tendo os dados de pedidos obtidas na API do OMS da VTEX, persiste se o pedido no respectivo ERP e informa se a VTEX que o pedido está sendo tratado pelo ERP.

OMS - Confirm item feed order status

Informações de Transação de Pagamento de Pedido

Caso necessário obter dados possíveis de transação de pagamento de um pedido (como endereço da fatura do cartão de crédito por exemplo), deve se acessar a API REST de Payments passando o “TID” ("paymentData.transactions.transactionId": "33CD3CC4D11A4FA49A2C9EE20D771F98") do gateway VTEX.

No retorno, além de um resumo da transação, poderá obter se as URLs de acesso aos detalhes transação.

PCI - Transaction Details

Nota Fiscal e Tracking

Uma vez o pedido no ERP e o status do pedido na loja VTEX como preparando entrega, vem a parte da Nota Fiscal e do Rastreamento de Entrega.

Fluxo:

Envio de Nota Fiscal

Após receber o pedido, o ERP emite a nota fiscal do pedido e informa a loja VTEX sobre a mesma.

O envio de notas fiscais pode ser parcial, obrigando assim ao enviador informar além dos valores da nota fiscal, os items que está mandando na nota fiscal parcial.

OMS - Post Invoice Notification

Envio de Tracking

A Nota Fiscal e o Tracking podem ser enviados na mesma chamada, basta preencher todos os dados do DTO (objeto de transporte) no método acima.

Mas, se necessário, também pode ser enviado posteriormente com a seguinte API do OMS: Update invoice

Cancelar Pedidos

O pedido desceu pro ERP, mas por algum motivo foi cancelado. Neste caso o ERP deve invocar uma solicitação de cancelamento para a API do OMS da loja VTEX. Caso o pedido ainda esteja num estado em que se possa cancelar, o mesmo será cancelado.

Pedidos que já possuem nota fiscal não podem ser cancelados.

OMS - Cancel Order