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 ​

TópicoEventoDescrição
contract.approvedContrato AprovadoOcorre quando um contrato é aprovado
na plataforma.
contract.attachment.createdAnexo de Contrato CriadoDisparado quando um novo anexo
é adicionado a um contrato.
contract.attachment.deletedAnexo de Contrato ExcluídoDisparado quando um anexo vinculado
a um contrato é removido.
contract.createdContrato CriadoOcorre quando um contrato é criado
na plataforma.
contract.statusStatus do ContratoOcorre toda vez que o status
do documento muda.
contract.updatedContrato AtualizadoOcorre quando um contrato é atualizado
na plataforma.
integration.resultResultado da IntegraçãoOcorre quando uma solicitação de integração
é concluída na plataforma.
integration.supplier.resultResultado da Integração do FornecedorOcorre quando uma solicitação de integração
do fornecedor é concluída na plataforma.
invoice.attachment.createdAnexo de Nota Fiscal CriadoOcorre quando um novo anexo
é enviado.
invoice.attachment.deletedAnexo de Nota Fiscal ExcluídoDisparado quando um arquivo de nota fiscal
é removido.
invoice.createdNota Fiscal CriadaOcorre quando uma Nota Fiscal
é criada.
invoice.creditmemo.requestedNota Fiscal de Crédito SolicitadaOcorre 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.statusStatus da Nota FiscalOcorre toda vez que o status
do documento muda.
invoice.updatedNota Fiscal AtualizadaOcorre quando uma Nota Fiscal é atualizada
na plataforma.
member.createdUsuário cadastradoDisparado quando um novo usuário
é cadastrado na plataforma.
member.updatedUsuário atualizadoDisparado quando dados ou permissões
do usuário são alterados.
order.attachment.createdAnexo do Pedido CriadoDisparado quando um anexo é adicionado
a um pedido.
order.attachment.deletedAnexo do Pedido ExcluídoDisparado quando um anexo é excluído
de um pedido.
order.cancellation.requestedSolicitação de Cancelamento do PedidoDisparado quando é solicitado ao ERP
o cancelamento completo do pedido.
order.canceledPedido CanceladoOcorre quando um pedido é cancelado
na plataforma.
order.createdPedido CriadoOcorre quando um pedido é criado
na plataforma.
order.deliveredPedido EntregueOcorre quando uma entrega de pedido
é criada.
order.item.cancellationrequestedSolicitação de Cancelamento de Item do PedidoDisparado quando é solicitado ao ERP
o cancelamento de um item específico.
order.item.closedItem do Pedido EncerradoDisparado quando um item do pedido
é encerrado.
order.item.deliverydateupdatedData de entrega do Item alteradaDisparado quando a data de entrega
de um item é alterada.
order.item.refusedItem do Pedido RecusadoDisparado quando um item específico
é recusado.
order.receivedPedido RecebidoOcorre quando um pedido é recebido
na plataforma.
order.refusedPedido RecusadoDisparado quando o pedido é recusado
por completo.
order.update.noapprovalPedido Editado sem Exigência de AprovaçãoDisparado quando o pedido é editado
sem exigir nova aprovação.
order.updatedPedido AtualizadoOcorre quando um pedido é atualizado.
preorder.approvedPré-Pedido AprovadoOcorre quando um pré-pedido
é aprovado na plataforma.
preorder.createdPré-Pedido CriadoOcorre quando um pré-pedido
é criado na plataforma.
preorder.statusStatus do Pré-PedidoOcorre toda vez que o status
do documento muda.
prerequest.submittedPré-Requisição EnviadaOcorre quando uma pré-requisição
é enviada.
product.createdProduto CriadoOcorre quando um produto
é criado na plataforma.
product.updatedProduto AtualizadoOcorre quando um produto é atualizado
na plataforma.
request-item.status.updatedStatus do Item da RequisiçãoOcorre quando o status do item
é atualizado.
request.approvedRequisição AprovadaOcorre quando uma requisição
é aprovada na plataforma.
request.statusStatus da RequisiçãoOcorre toda vez que o status
do documento muda.
rfq.answer.createdRFQ - Criação da respostaOcorre quando uma resposta de cotação
é criada na plataforma.
rfq.answer.updatedRFQ - Atualização da respostaOcorre quando uma resposta de cotação
é atualizada na plataforma.
rfq.canceledRFQ CanceladaOcorre quando uma RFQ é cancelada
na plataforma.
rfq.closedRFQ EncerradaOcorre quando uma RFQ é encerrada
na plataforma.
rfq.createdRFQ CriadaOcorre quando uma RFQ é criada
na plataforma.
rfq.expiredRFQ ExpiradaOcorre quando uma RFQ é expirada
na plataforma.
rfq.receivedRFQ RecebidaOcorre quando uma RFQ é recebida
na plataforma.
rfq.updatedRFQ AtualizadaOcorre quando uma RFQ é atualizada
na plataforma.
service-sheet.approvedFolha de Serviço AprovadaOcorre quando uma folha de serviço
é aprovada na plataforma.
service-sheet.createdFolha de Serviço CriadaOcorre quando uma folha de serviço
é criada na plataforma.
service-sheet.statusStatus da Folha de ServiçoOcorre toda vez que o status da folha
de serviço muda.
service-sheet-document.createdDocumento da Folha de Serviço CriadoDisparado quando um documento da folha
de serviço é criado.
service-sheet-document.statusStatus do Documento da Folha de ServiçoDisparado quando o status do documento
da folha de serviço muda.
supplier.approval.pendingFornecedor - Aprovação PendenteOcorre quando uma homologação
é necessária.
supplier.approvedFornecedor AprovadoOcorre quando uma homologação
é aprovada.
supplier.createdFornecedor CriadoOcorre quando um fornecedor
é criado na plataforma.
supplier.updatedFornecedor AtualizadoOcorre 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 ​

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

Anexo de Contrato Criado ​

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

Anexo de Contrato Excluído ​

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

Contrato Criado ​

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

Status de Contrato ​

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

Contrato Atualizado ​

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

Resultado da 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"
  }
}

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 Criada ​

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

Nota Fiscal de Crédito Solicitada ​

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

Status de Nota Fiscal ​

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

Nota Fiscal Atualizada ​

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

Usuário cadastrado ​

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

Usuário atualizado ​

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

Anexo do Pedido Criado ​

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

Anexo do Pedido Excluído ​

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

Solicitação de Cancelamento do Pedido ​

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

Pedido Cancelado ​

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

Pedido Criado ​

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

Pedido Entregue ​

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

Solicitação de Cancelamento de Item do Pedido ​

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

Item do Pedido Encerrado ​

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

Data de entrega do Item do Pedido alterada ​

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

Item do Pedido Recusado ​

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

Pedido Recebido ​

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

Pedido Recusado ​

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

Pedido Editado sem Exigência de Aprovação ​

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

Pedido Atualizado ​

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

Pré-Pedido Aprovado ​

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

Pré-Pedido Criado ​

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

Status do Pré-Pedido ​

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

Pré-Requisição Enviada ​

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

Produto Criado ​

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

Produto Atualizado ​

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

Status do item da Requisição ​

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

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"
  }
}

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"
    }
}

RFQ Cancelada ​

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

RFQ Encerrada ​

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

RFQ Criada ​

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

RFQ Expirada ​

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

RFQ Recebida ​

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

RFQ Atualizada ​

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

Folha de Serviço Aprovada ​

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

Folha de Serviço Criada ​

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

Status da Folha de Serviço ​

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

Documento da Folha de Serviço Criado ​

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

Status do Documento da Folha de Serviço ​

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

Fornecedor com Aprovação Pendente ​

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

Fornecedor Aprovado ​

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

Fornecedor Criado ​

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

Fornecedor Atualizado ​

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