Documentação de Webhooks de ERP

Visão Geral

No contexto atual, os endpoints de Webhook são responsáveis pela comunicação direta entre o ERP e a plataforma 🔗

Por meio deles, o ERP pode enviar informações de pedidos e produtos para sincronização, iniciando o fluxo de integração.

Ao receber a requisição, a plataforma armazena o payload original enviado pelo ERP e insere o registro em uma fila de entrada, garantindo organização e processamento assíncrono.

Esse modelo permite maior controle, rastreabilidade e tolerância a falhas, assegurando que os dados sejam processados corretamente, mesmo em cenários de alto volume ou instabilidade 🔄

Webhook de Pedido

Descrição

Endpoint responsável por receber requisições de sincronização de pedido do ERP 📥

O corpo da requisição é variável, pois depende exclusivamente das informações enviadas pelo sistema de gestão.

Ao receber os dados, o endpoint insere o pedido na fila de entrada para processamento na plataforma e armazena a requisição original enviada pelo ERP, garantindo rastreabilidade e suporte a auditorias futuras.

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/erps/webhook/{erpStoreCredentialId}/order \
3  --data '{
4    "corpoVariavel":"..."
5  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  [
3    "Resposta variável"
4  ]
5}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Webhook de Produto

Descrição

Endpoint responsável por receber requisições de sincronização de produto do ERP 📥

O corpo da requisição é variável, pois depende exclusivamente das informações enviadas pelo sistema de gestão.

Ao receber os dados, o endpoint insere o produto na fila de entrada para processamento na plataforma e armazena a requisição original enviada pelo ERP, garantindo rastreabilidade e suporte a auditorias futuras.

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/erps/webhook/{erpStoreCredentialId}/product \
3  --data '{
4    "corpoVariavel":"..."
5  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  [
3    "Resposta variável"
4  ]
5}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.