Webhooks do Olist API 2.0
Você pode utilizar os webhooks para receber notificações de eventos que acontecem na Olist. Ao se inscrever em um webhook, a Olist notificará sua aplicação no momento em que um evento ocorrer.
Pré-requisitos
- Possuir o plano Evoluir ou Potencializar e ter a extensão Webhooks instalada.
Webhooks
Informa ao integrador quando um Pedido de Venda é criado ou alterado.
Configurações
Acesse Menu → Configurações → Aba Geral → Outras configurações → Webhooks.
Ative a opção Receber notificações de vendas.
Informe a URL em que deseja receber as notificações no campo URL da notificação de pedidos.
Payload enviado
| Elemento | Tipo | Tamanho | Ocorrência | Descrição | Exemplo |
|---|---|---|---|---|---|
| versao | string | - | obrigatório | Versão do Webhook | 1.0.0 |
| cnpj | string | - | obrigatório | CNPJ/CPF da conta Olist que está enviando o payload | 48404755000188 |
| tipo | string | - | obrigatório | Identificador do tipo de atualização: "inclusao_pedido" ou "atualizacao_pedido" | inclusao_pedido |
| dados | object | - | obrigatório | Elemento utilizado para representar os dados enviados pelo webhook | - |
| dados.id | int | - | obrigatório | Identificador do pedido de venda na Olist | - |
| dados.numero | int | - | obrigatório | Número do pedido de venda | - |
| dados.data | string | 10 | obrigatório | Data do pedido de venda no formato dd/mm/YYYY | 01/01/2020 |
| dados.idPedidoEcommerce | string | - | opcional | Identificador do pedido no integrador | X123 |
| dados.codigoSituacao | string | - | obrigatório | Código da situação do pedido, vide tabela de situações dos pedidos | aberto |
| dados.descricaoSituacao | string | - | obrigatório | Descrição da situação do pedido, vide tabela de situações dos pedidos | Em aberto |
| dados.idContato | int | - | obrigatório | Identificador do cliente do pedido. | - |
| dados.idNotaFiscal | int | - | opcional | Identificador da nota fiscal vinculada ao pedido. | - |
| dados.nomeEcommerce | string | - | opcional | Nome do integrador vinculado ao pedido | - |
| dados.formaEnvio | object | - | opcional | Elemento utilizado para representar a forma de envio | - |
| dados.formaEnvio.id | string | - | opcional | Identificador da forma de envio | - |
| dados.formaEnvio.descricao | string | 60 | opcional | Descrição da forma de envio | - |
| dados.cliente | object | - | obrigatório | Elemento utilizado para representar o cliente | - |
| dados.cliente.nome | string | 60 | obrigatório | Nome do cliente | - |
| dados.cliente.cpfCnpj | string | 18 | opcional | CPF ou CNPJ do cliente | - |
Confirmação de recebimento
Para confirmar o recebimento da notificação na URL configurada, o webhook deverá retornar o status HTTP 200. Caso o sistema integrado não retorne o status de recebimento, o payload será enviado novamente.
A Olist enviará o payload ao integrador até, no máximo, 10 vezes, com delay progressivo, aumentando em 5 minutos a cada tentativa.
