Developer

Portuguese

English

Portuguese

English

Appearance

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 ​

EventoTópicoDescrição
Pedido Recebidoorder.receivedOcorre quando um pedido é recebido na plataforma.
Pedido Criadoorder.createdOcorre quando um pedido é criado na plataforma.
Pedido Canceladoorder.canceledOcorre quando um pedido é cancelado na plataforma.
Pedido Entregueorder.deliveredOcorre quando uma entrega de pedido é criada.
Pedido Atualizadoorder.updatedOcorre quando um pedido é atualizado.
Pré-Requisição Enviadaprerequest.submittedOcorre quando uma pré-requisição é enviada.
Requisição Aprovadarequest.approvedOcorre quando uma requisição é aprovada na plataforma.
Status da Requisiçãorequest.statusOcorre toda vez que o status do documento muda.
Status do Item da Requisiçãorequest-item.status.updatedOcorre toda vez que o status do item da requisição é atualizado.
RFQ Criadarfq.createdOcorre quando uma RFQ é criada na plataforma.
RFQ Encerradarfq.closedOcorre quando uma RFQ é encerrada na plataforma.
RFQ Expiradarfq.expiredOcorre quando uma RFQ é expirada na plataforma.
RFQ Canceladarfq.canceledOcorre quando uma RFQ é cancelada na plataforma.
RFQ Atualizadarfq.updatedOcorre quando uma RFQ é atualizada na plataforma.
RFQ Recebidarfq.receivedOcorre quando uma RFQ é recebida na plataforma.
RFQ - Criação da respostarfq.answer.createdOcorre quando uma resposta de cotação é criada na plataforma.
RFQ - Atualização da respostarfq.answer.updatedOcorre quando uma resposta de cotação é atualizada na plataforma.
Pré-Pedido Criadopreorder.createdOcorre quando um pré-pedido é criado na plataforma.
Pré-Pedido Aprovadopreorder.approvedOcorre quando um pré-pedido é aprovado na plataforma.
Status do Pré-Pedidopreorder.statusOcorre toda vez que o status do documento muda.
Folha de Serviço Criadaservice-sheet.createdOcorre quando uma folha de serviço é criada na plataforma.
Folha de Serviço Aprovadaservice-sheet.approvedOcorre quando uma folha de serviço é aprovada na plataforma.
Status do Documento da Folha de Serviçoservice-sheet-document.statusOcorre toda vez que o status do documento muda.
Status da Folha de Serviçoservice-sheet.statusOcorre toda vez que o status da folha de serviço muda.
Contrato Aprovadocontract.approvedOcorre quando um contrato é aprovado na plataforma.
Contrato Criadocontract.createdOcorre quando um contrato é criado na plataforma.
Contrato Atualizadocontract.updatedOcorre quando um contrato é atualizado na plataforma.
Status do Contratocontract.statusOcorre toda vez que o status do documento muda.
Status da Nota Fiscalinvoice.statusOcorre toda vez que o status do documento muda.
Nota Fiscal Criadainvoice.createdOcorre quando uma Nota Fiscal é criada.
Nota Fiscal Atualizadainvoice.updatedOcorre quando uma Nota Fiscal é atualizada na plataforma.
Anexo de Nota Fiscal Criadoinvoice.attachment.createdOcorre quando um novo anexo é enviado.
Anexo de Nota Fiscal Excluídoinvoice.attachment.deletedOcorre quando um anexo é excluído.
Nota Fiscal de Crédito Solicitadainvoice.creditmemo.requestedOcorre quando uma nota fiscal de crédito é solicitada. Este documento é usado para devolver parte do valor de uma venda quando, por exemplo: algum item não foi entregue, algum produto chegou com defeito, o cliente devolveu parte da mercadoria.
Exemplo: É emitida uma nota fiscal com 10 itens, mas o cliente recebeu só 9, ou 1 item veio com problema Então, para não cancelar a nota inteira. É feita uma nota fiscal de crédito, associada a nota fiscal original, que "anula" ou devolve o valor daquele item com problema.
No portal é possível solicitar uma nota de crédito, isso é apenas um e-mail enviado ao fornecedor para este emitir uma nota de crédito. E tambem criar a nota de crédito.
Fornecedor Criadosupplier.createdOcorre quando um fornecedor é criado na plataforma.
Fornecedor Atualizadosupplier.updatedOcorre quando um fornecedor é atualizado na plataforma.
Fornecedor - Aprovação Pendentesupplier.approval.pendingOcorre quando uma homologação é necessária.
Fornecedor Aprovadosupplier.approvedOcorre quando uma homologação é aprovada.
Resultado da Integraçãointegration.resultOcorre quando uma solicitação de integração é concluída na plataforma.
Resultado da Integração do Fornecedorintegration.supplier.resultOcorre quando uma solicitação de integração do fornecedor é concluída na plataforma.
Produto Criadoproduct.createdOcorre quando um produto é criado na plataforma.
Produto Atualizadoproduct.updatedOcorre quando um produto é atualizado na plataforma

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

Pedido Recebido ​

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

Pedido Criado ​

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

Pedido Cancelado ​

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

Pedido Entregue ​

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

Pedido Atualizado ​

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

Pré-Requisição Enviada ​

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

Folha de Serviço Criada ​

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

Folha de Serviço Aprovada ​

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

Status do Documento da Folha de Serviço ​

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

Status da Folha de Serviço ​

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

Requisição Aprovada ​

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

Status da Requisição ​

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

Status do item da Requisição ​

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

Pré-Pedido Criado ​

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

Pré-Pedido Aprovado ​

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

Status de Pré-Pedido ​

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

RFQ Criada ​

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

RFQ Encerrada ​

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

RFQ Expirada ​

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

RFQ Cancelada ​

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

RFQ Atualizada ​

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

RFQ Recebida ​

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

RFQ - Criação da resposta ​

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

RFQ - Atualização da resposta ​

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

Status de Nota Fiscal ​

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

Nota Fiscal Criada ​

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

Nota Fiscal Atualizada ​

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

Anexo de Nota Fiscal Criado ​

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

Anexo de Nota Fiscal excluído ​

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

Nota Fiscal de Crédito Solicitada ​

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

Contrato Criado ​

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

Contrato Aprovado ​

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

Contrato Atualizado ​

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

Status de Contrato ​

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

Fornecedor Criado ​

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

Fornecedor Atualizado ​

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

Fornecedor Aprovado ​

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

Fornecedor com Aprovação Pendente ​

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

Resultado de Integração ​

json
{
  "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 ​

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

Produto Criado ​

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

Produto Atualizado ​

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