Visão Geral

A plataforma e-Procurement do Mercado Eletrônico oferece o recurso de WebHooks para que possamos interagir com os eventos que ocorrem na plataforma.

❗️ Atenção

Por favor, consulte a página Webhooks na seção de Guias para verificar as primeiras informações sobre os webhooks antes de prosseguir nesta página.

Você pode usar assinaturas de webhook para receber notificações sobre eventos específicos.

Tópicos

Tópico	Evento	Descrição
contract.approved	Contrato Aprovado	Ocorre quando um contrato é aprovado na plataforma.
contract.attachment.created	Anexo de Contrato Criado	Disparado quando um novo anexo é adicionado a um contrato.
contract.attachment.deleted	Anexo de Contrato Excluído	Disparado quando um anexo vinculado a um contrato é removido.
contract.created	Contrato Criado	Ocorre quando um contrato é criado na plataforma.
contract.status	Status do Contrato	Ocorre toda vez que o status do documento muda.
contract.updated	Contrato Atualizado	Ocorre quando um contrato é atualizado na plataforma.
integration.result	Resultado da Integração	Ocorre quando uma solicitação de integração é concluída na plataforma.
integration.supplier.result	Resultado da Integração do Fornecedor	Ocorre quando uma solicitação de integração do fornecedor é concluída na plataforma.
invoice.attachment.created	Anexo de Nota Fiscal Criado	Ocorre quando um novo anexo é enviado.
invoice.attachment.deleted	Anexo de Nota Fiscal Excluído	Disparado quando um arquivo de nota fiscal é removido.
invoice.created	Nota Fiscal Criada	Ocorre quando uma Nota Fiscal é criada.
invoice.creditmemo.requested	Nota Fiscal de Crédito Solicitada	Ocorre quando uma nota fiscal de crédito é solicitada. Usada para devolver parte do valor da venda, por exemplo: item não entregue, produto com defeito ou devolução parcial. Exemplo: Nota com 10 itens, cliente recebeu 9. Em vez de cancelar tudo, é gerada uma nota de crédito associada, que "anula" o valor do item com problema. No portal, a solicitação envia um e-mail ao fornecedor para emissão da nota e também permite criá-la.
invoice.status	Status da Nota Fiscal	Ocorre toda vez que o status do documento muda.
invoice.updated	Nota Fiscal Atualizada	Ocorre quando uma Nota Fiscal é atualizada na plataforma.
member.created	Usuário cadastrado	Disparado quando um novo usuário é cadastrado na plataforma.
member.updated	Usuário atualizado	Disparado quando dados ou permissões do usuário são alterados.
order.attachment.created	Anexo do Pedido Criado	Disparado quando um anexo é adicionado a um pedido.
order.attachment.deleted	Anexo do Pedido Excluído	Disparado quando um anexo é excluído de um pedido.
order.cancellation.requested	Solicitação de Cancelamento do Pedido	Disparado quando é solicitado ao ERP o cancelamento completo do pedido.
order.canceled	Pedido Cancelado	Ocorre quando um pedido é cancelado na plataforma.
order.created	Pedido Criado	Ocorre quando um pedido é criado na plataforma.
order.delivered	Pedido Entregue	Ocorre quando uma entrega de pedido é criada.
order.item.cancellationrequested	Solicitação de Cancelamento de Item do Pedido	Disparado quando é solicitado ao ERP o cancelamento de um item específico.
order.item.closed	Item do Pedido Encerrado	Disparado quando um item do pedido é encerrado.
order.item.deliverydateupdated	Data de entrega do Item alterada	Disparado quando a data de entrega de um item é alterada.
order.item.refused	Item do Pedido Recusado	Disparado quando um item específico é recusado.
order.received	Pedido Recebido	Ocorre quando um pedido é recebido na plataforma.
order.refused	Pedido Recusado	Disparado quando o pedido é recusado por completo.
order.update.noapproval	Pedido Editado sem Exigência de Aprovação	Disparado quando o pedido é editado sem exigir nova aprovação.
order.updated	Pedido Atualizado	Ocorre quando um pedido é atualizado.
preorder.approved	Pré-Pedido Aprovado	Ocorre quando um pré-pedido é aprovado na plataforma.
preorder.created	Pré-Pedido Criado	Ocorre quando um pré-pedido é criado na plataforma.
preorder.status	Status do Pré-Pedido	Ocorre toda vez que o status do documento muda.
prerequest.submitted	Pré-Requisição Enviada	Ocorre quando uma pré-requisição é enviada.
preorder.resubmitted	Pré-Pedido reenviado	Ocorre quando o usuário clica na funcionalidade “Disparar pré-pedido”.
product.created	Produto Criado	Ocorre quando um produto é criado na plataforma.
product.updated	Produto Atualizado	Ocorre quando um produto é atualizado na plataforma.
request.approved	Requisição Aprovada	Ocorre quando uma requisição é aprovada na plataforma.
request.attachment.created	Anexo da Requisição Criado	Ocorre quando o anexo da requisição é adicionado.
request.attachment.deleted	Anexo da Requisição Excluído	Ocorre quando o anexo da requisição é excluído.
request.item.canceled	Item da Requisição Cancelado	Ocorre quando o item da requisição é cancelado.
request-item.status.updated	Status do Item da Requisição	Ocorre quando o status do item é atualizado.
request.status	Status da Requisição	Ocorre toda vez que o status do documento muda.
request.updated	Requisição Atualizada	Disparado sempre que houver qualquer alteração no cabeçalho ou nos itens de uma requisição (Ex.: criação, edição, aprovação, inclusão de anexos, entre outras).
request.updated.history	Histórico de Atualização da Requisição	Ocorre quando a requisição é alterada e essa alteração fica registrada no histórico de modificações.
rfq.answer.created	RFQ - Criação da resposta	Ocorre quando uma resposta de cotação é criada na plataforma.
rfq.answer.updated	RFQ - Atualização da resposta	Ocorre quando uma resposta de cotação é atualizada na plataforma.
rfq.canceled	RFQ Cancelada	Ocorre quando uma RFQ é cancelada na plataforma.
rfq.closed	RFQ Encerrada	Ocorre quando uma RFQ é encerrada na plataforma.
rfq.created	RFQ Criada	Ocorre quando uma RFQ é criada na plataforma.
rfq.expired	RFQ Expirada	Ocorre quando uma RFQ é expirada na plataforma.
rfq.received	RFQ Recebida	Ocorre quando uma RFQ é recebida na plataforma.
rfq.updated	RFQ Atualizada	Ocorre quando uma RFQ é atualizada na plataforma.
service-sheet.approved	Folha de Serviço Aprovada	Ocorre quando uma folha de serviço é aprovada na plataforma.
service-sheet.created	Folha de Serviço Criada	Ocorre quando uma folha de serviço é criada na plataforma.
service-sheet.status	Status da Folha de Serviço	Ocorre toda vez que o status da folha de serviço muda.
service-sheet-document.created	Documento da Folha de Serviço Criado	Disparado quando um documento da folha de serviço é criado.
service-sheet-document.status	Status do Documento da Folha de Serviço	Disparado quando o status do documento da folha de serviço muda.
supplier.approval.pending	Fornecedor - Aprovação Pendente	Ocorre quando uma homologação é necessária.
supplier.approved	Fornecedor Aprovado	Ocorre quando uma homologação é aprovada.
supplier.created	Fornecedor Criado	Ocorre quando um fornecedor é criado na plataforma.
supplier.updated	Fornecedor Atualizado	Ocorre quando um fornecedor é atualizado na plataforma.

Estes são alguns exemplos de resposta que você pode consumir para cada tópico descrito acima:

Contrato Aprovado

{
  "topic": "contract.approved",
  "data": {
    "contractId": "125154"
  }
}

Anexo de Contrato Criado

{
  "topic": "contract.attachment.created",
  "data": {
    "contractId": "851233",
    "contractItemId": "1",
    "attachmentId": "5533111"
  }
}

Anexo de Contrato Excluído

{
  "topic": "contract.attachment.deleted",
  "data": {
    "contractId": "851233",
    "contractItemId": "1",
    "attachmentId": "5533111"
  }
}

Contrato Criado

{
  "topic": "contract.created",
  "data": {
    "contractId": "32211"
  }
}

Status de Contrato

{
  "topic": "contract.status",
  "data": {
    "contractId": "32211",
    "status": "103",
    "previousStatus": "101"
  }
}

Contrato Atualizado

{
  "topic": "contract.updated",
  "data": {
    "contractId": "125154"
  }
}

Resultado da Integração

{
  "topic": "integration.result",
  "data": {
    "correlationId": "YOUR_CORRELATION_ID", // The Request Id, Maybe your internal code
    "resource": "order",
    "identifier": "3211", // Internal ID
    "statusCode": 201,
    "message": "Order 3211 created successfully."
  } 
}

Resultado da Integração do Fornecedor

{
  "topic": "integration.supplier.result",
  "data": {
    "correlationId": "e170885a-f175-41ff-8712-0f6ccfbb09f9",
    "resource": "supplier",
    "identifier": "32211",
    "statusCode": 201,
    "message": "Some text"
  }
}

Anexo de Nota Fiscal Criado

{
  "topic": "invoice.attachment.created",
  "data": {
    "invoiceId": "32211",
    "attachmentId": "54421"
  }
}

Anexo de Nota Fiscal excluído

{
  "topic": "invoice.attachment.deleted",
  "data": {
    "invoiceId": "32211",
    "attachmentId": "54421"
  }
}

Nota Fiscal Criada

{
  "topic": "invoice.created",
  "data": {
    "invoiceId": "32211"
  }
}

Nota Fiscal de Crédito Solicitada

{
  "topic": "invoice.creditmemo.requested",
  "data": {
    "invoiceId": "851233"
  }
}

Status de Nota Fiscal

{
  "topic": "invoice.status",
  "data": {
    "invoiceId": "32211",
    "status": "103",
    "previousStatus": "101"
  }
}

Nota Fiscal Atualizada

{
  "topic": "invoice.updated",
  "data": {
    "invoiceId": "32211"
  }
}

Usuário cadastrado

{
  "topic": "member.created",
  "data": {
    "userId": "1"
  }
}

Usuário atualizado

{
  "topic": "member.updated",
  "data": {
    "userId": "1"
  }
}

Anexo do Pedido Criado

{
  "topic": "order.attachment.created",
  "data": {
    "orderId": "851233",
    "orderItemId": "1",
    "attachmentId": "5533111"
}
}

Anexo do Pedido Excluído

{
  "topic": "order.attachment.deleted",
  "data": {
    "orderId": "851233",
    "orderItemId": "1",
    "attachmentId": "5533111"
  }
}

Solicitação de Cancelamento do Pedido

{
  "topic": "order.cancellation.requested",
  "data": {
    "orderId": "851233"
  }
}

Pedido Cancelado

{
  "topic": "order.canceled",
  "data": {
    "orderId": "123",
    "customerId": "456",
    "supplierId": "789"
  }
}

Pedido Criado

{
  "topic": "order.created",
  "data": {
    "orderId": "123"
  }
}

Pedido Entregue

{
  "topic": "order.delivered",
  "data": {
    "deliveryId": "55421",
    "orderId": "12442",
    "orderItemId": "1"
  }
}

Solicitação de Cancelamento de Item do Pedido

{
  "topic": "order.item.cancellationrequested",
  "data": {
    "orderId": "851233",
    "orderItemId": "1"
  }
}

Item do Pedido Encerrado

{
  "topic": "order.item.closed",
  "data": {
    "orderId": "851233",
    "orderItemId": "1"
  }
}

Data de entrega do Item do Pedido alterada

{
  "topic": "order.item.deliverydateupdated",
  "data": {
    "orderId": "851233",
    "orderItemId": "1"
  }
}

Item do Pedido Recusado

{
  "topic": "order.item.refused",
  "data": {
    "orderId": "851233",
    "orderItemId": "1"
  }
}

Pedido Recebido

{
  "topic": "order.received",
  "data": {
    "orderId": "123",
    "clientId": "456",
    "supplierId": "789"
  }
}

Pedido Recusado

{
  "topic": "order.refused",
  "data": {
    "orderId": "851233"
  }
}

Pedido Editado sem Exigência de Aprovação

{
  "topic": "order.update.noapproval",
  "data": {
    "orderId": "851233"
  }
}

Pedido Atualizado

{
  "topic": "order.updated",
  "data": {
    "orderId": "123",
    "customerId": "456",
    "supplierId": "789"
  }
}

Pré-Pedido Aprovado

{
  "topic": "preorder.approved",
  "data": {
    "preOrderId": "331123"
  }
}

Pré-Pedido Criado

{
  "topic": "preorder.created",
  "data": {
    "preOrderId": "331123",
     "customerId": "456",
  }
}

Status do Pré-Pedido

{
  "topic": "preorder.status",
  "data": {
    "preOrderId": "851233",
    "status": "103",
    "previousStatus": "101"
  }
}

Pré-Requisição Enviada

{
  "topic": "prerequest.submitted",
  "data": {
    "preRequestId": "42490e28-ed00-4dc0-89b4-decad490b02a"
  }
}

Pré-Pedido reenviado

{
  "topic": "preorder.resubmitted",
  "data": {
    "preOrderId": "54411"
  }
}

Produto Criado

{
  "topic": "product.created",
  "data": {
    "productId": "102"
  }
}

Produto Atualizado

{
  "topic": "product.updated",
  "data": {
    "productId": "102"
  }
}

Status do item da Requisição

{
    "topic":
    "request-item.status.updated",
    "data": {
        "requestId": "38510943",
        "requestItemId": "5"
    }
}

Requisição Aprovada

{
  "topic": "request.approved",
  "data": {
    "requestId": "55331112"
  }
}

Anexo da requisição criado

{
  "topic": "request.attachment.created",
  "data": {
    "requestId": "851233",
    "requestItemId": "851233",
    "attachmentId": "5533111"
  }
}

Anexo da Requisição Excluído

{
  "topic": "request.attachment.deleted",
  "data": {
    "requestId": "851233",
    "requestItemId": "851233",
    "attachmentId": "5533111"
  }
}

Item da Requisição Cancelado

{
  "topic": "request.item.canceled",
  "data": {
    "requestId": "851233",
    "requestItemId": "851233",
    "message": "5533111"
  }
}

Status da Requisição

{
  "topic": "request.status",
  "data": {
    "requestId": "32211",
    "status": "103",
    "previousStatus": "101"
  }
}

Requisição Atualizada

{
  "topic": "request.updated",
  "data": {
    "requestId": "54411"
  }
}

Histórico de Atualização da Requisição

{
  "topic": "request.updated.history",
   "data": {
    "requestId": "851233"
  }
}

RFQ - Criação da resposta

{
    "topic":
    "rfq.answer.created",
    "data": {
        "rfqId": "9149480",
        "supplierId": "5380963",
        "clinteSupplierId": "0004970001"
    }
}

RFQ - Atualização da resposta

{
    "topic":
    "request-item.status.updated",
    "data": {
        "requestId": "38510943",
        "requestItemId": "5"
    }
}

RFQ Cancelada

{
  "topic": "rfq.canceled",
  "data": {
    "rfqId": "4331"
  }
}

RFQ Encerrada

{
  "topic": "rfq.closed",
  "data": {
    "rfqId": "4331"
  }
}

RFQ Criada

{
  "topic": "rfq.created",
  "data": {
    "rfqId": "4331"
  }
}

RFQ Expirada

{
  "topic": "rfq.expired",
  "data": {
    "rfqId": "4331"
  }
}

RFQ Recebida

{
  "topic": "rfq.received",
  "data": {
    "rfqId": "102",
    "clientId": "446",
    "supplierId": "789"
  }
}

RFQ Atualizada

{
  "topic": "rfq.updated",
  "data": {
    "rfqId": "4331"
  }
}

Folha de Serviço Aprovada

{
  "topic": "service-sheet.approved",
  "data": {
    "serviceSheetId": "32211"
  }
}

Folha de Serviço Criada

{
  "topic": "service-sheet.created",
  "data": {
    "serviceSheetId": "32211"
  }
}

Status da Folha de Serviço

{
  "topic": "service-sheet.status",
  "data": {
    "serviceSheetId": "32211",
    "status": "103",
    "previousStatus": "101"
  }
}

Documento da Folha de Serviço Criado

{
  "topic": "service-sheet-document.created",
  "data": {
    "serviceSheetHeaderId": "382821"
  }
}

Status do Documento da Folha de Serviço

{
  "topic": "service-sheet-document.status",
  "data": {
    "serviceSheetHeaderId": "250300",
    "status": "103",
    "previousStatus": "101"
  }
}

Fornecedor com Aprovação Pendente

{
  "topic": "supplier.approval.pending",
  "data": {
    "supplierId": "32111"
  }
}

Fornecedor Aprovado

{
  "topic": "supplier.approved",
  "data": {
    "supplierId": "32111"
  }
}

Fornecedor Criado

{
  "topic": "supplier.created",
  "data": {
    "supplierId": "54421"
  }
}

Fornecedor Atualizado

{
  "topic": "supplier.updated",
  "data": {
    "supplierId": "32111"
  }
}