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.
Topics
Event | Topic | Description |
---|---|---|
Order Received | order.received | Occurs when you receive an order on the platform. |
Order Created | order.created | Occurs when you create an order on the platform. |
Order Canceled | order.canceled | Occurs when an order is canceled on the platform. |
Order Delivered | order.delivered | Occurs when an order delivery is created. |
Order Updated | order.updated | Occurs when an order is updated. |
Request Approved | request.approved | Occurs when a request is approved on the platform. |
Request Status | request.status | Occurs every time the document status changes. |
Request Item Status Updated | request-item.status.updated | Occurs every time the status of a request item is updated. |
RFQ Created | rfq.created | Occurs when an RFQ is created on the platform. |
RFQ Closed | rfq.closed | Occurs when an RFQ is closed on the platform. |
RFQ Expired | rfq.expired | Occurs when an RFQ expires on the platform. |
RFQ Canceled | rfq.canceled | Occurs when an RFQ is canceled on the platform. |
RFQ Updated | rfq.updated | Occurs when an RFQ is updated on the platform. |
RFQ – Response Created | rfq.answer.created | Occurs when a quotation response is created on the platform. |
RFQ – Response Updated | rfq.answer.updated | Occurs when a quotation response is updated on the platform. |
Preorder Created | preorder.created | Occurs when a preorder is created on the platform. |
Preorder Approved | preorder.approved | Occurs when a preorder is approved on the platform. |
Preorder Status | preorder.status | Occurs every time the document status changes. |
Service Sheet Created | service-sheet.created | Occurs when a service sheet is created on the platform. |
Service Sheet Approved | service-sheet.approved | Occurs when a service sheet is approved on the platform. |
Service Sheet Status | service-sheet.status | Occurs every time the document status changes. |
Contract Created | contract.created | Occurs when a contract is created on the platform. |
Contract Status | contract.status | Occurs every time the document status changes. |
Invoice Status | invoice.status | Occurs every time the document status changes. |
Invoice Created | invoice.created | Occurs when an invoice is created. |
Invoice Updated | invoice.updated | Occurs when an invoice is updated on the platform. |
Invoice Attachment Created | invoice.attachment.created | Occurs when a new attachment is uploaded. |
Invoice Attachment Deleted | invoice.attachment.deleted | Occurs when an attachment is deleted. |
Supplier Created | supplier.created | Occurs when you create a supplier on the platform. |
Supplier Updated | supplier.updated | Occurs when a supplier is updated on the platform. |
Supplier – Approval Pending | supplier.approval.pending | Occurs when an approval process is required. |
Supplier Approved | supplier.approved | Occurs when an approval is granted. |
Integration Result | integration.result | Occurs when an integration request is completed on the platform. |
These are some response examples you may consume for each topic described above:
Order Received
json
{
"topic": "order.received",
"data": {
"orderId": "123",
"clientId": "456",
"supplierId": "789"
}
}
Order Created
json
{
"topic": "order.created",
"data": {
"orderId": "123"
}
}
Order Canceled
json
{
"topic": "order.canceled",
"data": {
"orderId": "123",
"customerId": "456",
"supplierId": "789"
}
}
Order Delivered
json
{
"topic": "order.delivered",
"data": {
"deliveryId": "55421",
"orderId": "12442",
"orderItemId": "1"
}
}
Order Updated
json
{
"topic": "order.updated",
"data": {
"orderId": "123",
"customerId": "456",
"supplierId": "789"
}
}
Service-Sheet Created
json
{
"topic": "service-sheet.created",
"data": {
"serviceSheetId": "32211"
}
}
Service-Sheet Approved
json
{
"topic": "service-sheet.approved",
"data": {
"serviceSheetId": "32211"
}
}
Service-Sheet Status
json
{
"topic": "service-sheet.status",
"data": {
"serviceSheetId": "32211",
"status": "103",
"previousStatus": "101"
}
}
Request Approved
json
{
"topic": "request.approved",
"data": {
"requestId": "55331112"
}
}
Request Status
json
{
"topic": "request.status",
"data": {
"requestId": "32211",
"status": "103",
"previousStatus": "101"
}
}
Request Item Status Updated
json
{
"topic":
"request-item.status.updated",
"data": {
"requestId": "38510943",
"requestItemId": "5"
}
}
Pre-Order Created
json
{
"topic": "preorder.created",
"data": {
"preOrderId": "331123",
"customerId": "456",
}
}
Pre-Order Approved
json
{
"topic": "preorder.approved",
"data": {
"preOrderId": "331123"
}
}
Pre-Order Status
json
{
"topic": "preorder.status",
"data": {
"preOrderId": "32211",
"status": "103",
"previousStatus": "101"
}
}
RFQ Created
json
{
"topic": "rfq.created",
"data": {
"rfqId": "4331"
}
}
RFQ Closed
json
{
"topic": "rfq.closed",
"data": {
"rfqId": "4331"
}
}
RFQ Expired
json
{
"topic": "rfq.expired",
"data": {
"rfqId": "4331"
}
}
RFQ Canceled
json
{
"topic": "rfq.canceled",
"data": {
"rfqId": "4331"
}
}
RFQ Updated
json
{
"topic": "rfq.updated",
"data": {
"rfqId": "4331"
}
}
RFQ Answer Created
json
{
"topic":
"rfq.answer.created",
"data": {
"rfqId": "9149480",
"supplierId": "5380963",
"clinteSupplierId": "0004970001"
}
}
RFQ Answer Updated
json
{
"topic":
"rfq.answer.update",
"data": {
"rfqId": "9149480",
"supplierId": "5380963",
"clinteSupplierId": "0004970001"
}
}
Invoice Status
json
{
"topic": "invoice.status",
"data": {
"invoiceId": "32211",
"status": "103",
"previousStatus": "101"
}
}
Invoice Created
json
{
"topic": "invoice.created",
"data": {
"invoiceId": "32211"
}
}
Invoice Updated
json
{
"topic": "invoice.updated",
"data": {
"invoiceId": "32211"
}
}
Invoice Attachment Created
json
{
"topic": "invoice.attachment.created",
"data": {
"invoiceId": "32211",
"attachmentId": "54421"
}
}
Invoice Attachment Created
json
{
"topic": "invoice.attachment.deleted",
"data": {
"invoiceId": "32211",
"attachmentId": "54421"
}
}
Contract Created
json
{
"topic": "contract.created",
"data": {
"contractId": "32211"
}
}
Contract Status
json
{
"topic": "contract.status",
"data": {
"contractId": "32211",
"status": "103",
"previousStatus": "101"
}
}
Supplier Created
json
{
"topic": "supplier.created",
"data": {
"supplierId": "54421"
}
}
Supplier Updated
json
{
"topic": "supplier.updated",
"data": {
"supplierId": "32111"
}
}
Supplier Approved
json
{
"topic": "supplier.approved",
"data": {
"supplierId": "32111"
}
}
Supplier Approval Pending
json
{
"topic": "supplier.approval.pending",
"data": {
"supplierId": "32111"
}
}
Integration Result
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."
}
}