Overview

Mercado Eletrônico's e-Procurement platform provides the WebHooks feature so that we can interact with the events that occur on the platform.

❗️ Attention
Please refer to Webhooks page in Guides section to check the first information about the webhooks before proceeding on this page.

You can use webhook subscriptions to receive notifications about particular events.

Topic	Event	Descroption
contract.approved	Contract Approved	Occurs when a contract is approved on the platform.
contract.attachment.created	Contract Attachment Created	Triggered when a new attachment is added to a contract.
contract.attachment.deleted	Contract Attachment Deleted	Triggered when an attachment linked to a contract is removed.
contract.created	Contract Created	Occurs when a contract is created on the platform.
contract.status	Contract Status	Occurs whenever the document status changes.
contract.updated	Contract Updated	Occurs when a contract is updated on the platform.
integration.result	Integration Result	Occurs when an integration request is completed on the platform.
integration.supplier.result	Supplier Integration Result	Occurs when a supplier integration request is completed on the platform.
invoice.attachment.created	Invoice Attachment Created	Occurs when a new attachment is uploaded.
invoice.attachment.deleted	Invoice Attachment Deleted	Triggered when an invoice file is removed.
invoice.created	Invoice Created	Occurs when an invoice is created.
invoice.creditmemo.requested	Credit Note Requested	Occurs when a credit note is requested. Used to return part of a sale amount, for example: item not delivered, defective product, or partial return. Example: An invoice has 10 items, but the client received 9. Instead of canceling the entire invoice, a credit note is issued and linked, which "reverses" the value of the problematic item. In the portal, requesting a credit note sends an email to the supplier for issuance and also allows creating it.
invoice.status	Invoice Status	Occurs whenever the document status changes.
invoice.updated	Invoice Updated	Occurs when an invoice is updated on the platform.
member.created	User Created	Triggered when a new user is registered on the platform.
member.updated	User Updated	Triggered when user data or permissions are changed.
order.attachment.created	Order Attachment Created	Triggered when an attachment is added to an order.
order.attachment.deleted	Order Attachment Deleted	Triggered when an attachment is removed from an order.
order.cancellation.requested	Order Cancellation Requested	Triggered when a full order cancellation is requested to the ERP.
order.canceled	Order Canceled	Occurs when an order is canceled on the platform.
order.created	Order Created	Occurs when an order is created on the platform.
order.delivered	Order Delivered	Occurs when an order delivery is created.
order.item.cancellationrequested	Order Item Cancellation Requested	Triggered when cancellation of a specific item is requested to the ERP.
order.item.closed	Order Item Closed	Triggered when an order item is closed.
order.item.deliverydateupdated	Order Item Delivery Date Updated	Triggered when the delivery date of an item is changed.
order.item.refused	Order Item Refused	Triggered when a specific order item is refused.
order.received	Order Received	Occurs when an order is received on the platform.
order.refused	Order Refused	Triggered when the entire order is refused.
order.update.noapproval	Order Updated Without Approval	Triggered when an order is updated without requiring a new approval.
order.updated	Order Updated	Occurs when an order is updated.
preorder.approved	Pre-Order Approved	Occurs when a pre-order is approved on the platform.
preorder.created	Pre-Order Created	Occurs when a pre-order is created on the platform.
preorder.status	Pre-Order Status	Occurs whenever the document status changes.
prerequest.submitted	Pre-Request Submitted	Occurs when a pre-request is submitted.
product.created	Product Created	Occurs when a product is created on the platform.
product.updated	Product Updated	Occurs when a product is updated on the platform.
request-item.status.updated	Request Item Status Updated	Occurs when the request item status is updated.
request.approved	Request Approved	Occurs when a request is approved on the platform.
request.status	Request Status	Occurs whenever the document status changes.
rfq.answer.created	RFQ - Answer Created	Occurs when a quotation answer is created on the platform.
rfq.answer.updated	RFQ - Answer Updated	Occurs when a quotation answer is updated on the platform.
rfq.canceled	RFQ Canceled	Occurs when an RFQ is canceled on the platform.
rfq.closed	RFQ Closed	Occurs when an RFQ is closed on the platform.
rfq.created	RFQ Created	Occurs when an RFQ is created on the platform.
rfq.expired	RFQ Expired	Occurs when an RFQ is expired on the platform.
rfq.received	RFQ Received	Occurs when an RFQ is received on the platform.
rfq.updated	RFQ Updated	Occurs when an RFQ is updated on the platform.
service-sheet.approved	Service Sheet Approved	Occurs when a service sheet is approved on the platform.
service-sheet.created	Service Sheet Created	Occurs when a service sheet is created on the platform.
service-sheet.status	Service Sheet Status	Occurs whenever the service sheet status changes.
service-sheet-document.created	Service Sheet Document Created	Triggered when a service sheet document is created.
service-sheet-document.status	Service Sheet Document Status	Triggered whenever the service sheet document status changes.
supplier.approval.pending	Supplier - Approval Pending	Occurs when approval is required.
supplier.approved	Supplier Approved	Occurs when approval is granted.
supplier.created	Supplier Created	Occurs when a supplier is created on the platform.
supplier.updated	Supplier Updated	Occurs when a supplier is updated on the platform.

These are some example responses you can consume for each topic described above:

Contract Approved

json

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

Contract Attachment Created

json

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

Contract Attachment Deleted

json

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

Contract Created

json

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

Contract Status

json

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

Contract Updated

json

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

Integration Result

json

{
  "topic": "integration.result",
  "data": {
    "correlationId": "YOUR_CORRELATION_ID",
    "resource": "order",
    "identifier": "3211",
    "statusCode": 201,
    "message": "Order 3211 created successfully."
  } 
}

Supplier Integration Result

json

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

Invoice Attachment Created

json

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

Invoice Attachment Deleted

json

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

Invoice Created

json

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

Credit Note Requested

json

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

Invoice Status

json

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

Invoice Updated

json

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

User Created

json

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

User Updated

json

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

Order Attachment Created

json

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

Order Attachment Deleted

json

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

Order Cancellation Requested

json

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

Order Canceled

json

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

Order Created

json

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

Order Delivered

json

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

Order Item Cancellation Requested

json

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

Order Item Closed

json

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

Order Item Delivery Date Updated

json

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

Order Item Refused

json

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

Order Received

json

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

Order Refused

json

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

Order Updated Without Approval

json

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

Order Updated

json

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

Pre-Order Approved

json

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

Pre-Order Created

json

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

Pre-Order Status

json

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

Pre-Request Submitted

json

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

Product Created

json

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

Product Updated

json

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

Request Item Status Updated

json

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

Request Approved

json

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

Request Status

json

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

RFQ - Answer Created

json

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

RFQ - Answer Updated

json

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

RFQ Canceled

json

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

RFQ Closed

json

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

RFQ Created

json

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

RFQ Expired

json

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

RFQ Received

json

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

RFQ Updated

json

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

Service Sheet Approved

json

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

Service Sheet Created

json

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

Service Sheet Status

json

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

Service Sheet Document Created

json

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

Service Sheet Document Status

json

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

Supplier - Approval Pending

json

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

Supplier Approved

json

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

Supplier Created

json

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

Supplier Updated

json

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

Overview ​

These are some example responses you can consume for each topic described above: ​

Contract Approved ​

Contract Attachment Created ​

Contract Attachment Deleted ​

Contract Created ​

Contract Status ​

Contract Updated ​

Integration Result ​

Supplier Integration Result ​

Invoice Attachment Created ​

Invoice Attachment Deleted ​

Invoice Created ​

Credit Note Requested ​

Invoice Status ​

Invoice Updated ​

User Created ​

User Updated ​

Order Attachment Created ​

Order Attachment Deleted ​

Order Cancellation Requested ​

Order Canceled ​

Order Created ​

Order Delivered ​

Order Item Cancellation Requested ​

Order Item Closed ​

Order Item Delivery Date Updated ​

Order Item Refused ​

Order Received ​

Order Refused ​

Order Updated Without Approval ​

Order Updated ​

Pre-Order Approved ​

Pre-Order Created ​

Pre-Order Status ​

Pre-Request Submitted ​

Product Created ​

Product Updated ​

Request Item Status Updated ​

Request Approved ​

Request Status ​

RFQ - Answer Created ​

RFQ - Answer Updated ​

RFQ Canceled ​

RFQ Closed ​

RFQ Created ​

RFQ Expired ​

RFQ Received ​

RFQ Updated ​

Service Sheet Approved ​

Service Sheet Created ​

Service Sheet Status ​

Service Sheet Document Created ​

Service Sheet Document Status ​

Supplier - Approval Pending ​

Supplier Approved ​

Supplier Created ​

Supplier Updated ​

Overview

These are some example responses you can consume for each topic described above:

Contract Approved

Contract Attachment Created

Contract Attachment Deleted

Contract Created

Contract Status

Contract Updated

Integration Result

Supplier Integration Result

Invoice Attachment Created

Invoice Attachment Deleted

Invoice Created

Credit Note Requested

Invoice Status

Invoice Updated

User Created

User Updated

Order Attachment Created

Order Attachment Deleted

Order Cancellation Requested

Order Canceled

Order Created

Order Delivered

Order Item Cancellation Requested

Order Item Closed

Order Item Delivery Date Updated

Order Item Refused

Order Received

Order Refused

Order Updated Without Approval

Order Updated

Pre-Order Approved

Pre-Order Created

Pre-Order Status

Pre-Request Submitted

Product Created

Product Updated

Request Item Status Updated

Request Approved

Request Status

RFQ - Answer Created

RFQ - Answer Updated

RFQ Canceled

RFQ Closed

RFQ Created

RFQ Expired

RFQ Received

RFQ Updated

Service Sheet Approved

Service Sheet Created

Service Sheet Status

Service Sheet Document Created

Service Sheet Document Status

Supplier - Approval Pending

Supplier Approved

Supplier Created

Supplier Updated