Order management

Order management is done through REST APIs, with which you can perform actions depending on the current status of the order.

Changes in the status of the order, from the moment of creation to the completion of delivery, will be notified via webhook containing the resource and the user_id in its body.

The resource attribute returns the shipment_id that will be used for any operation involving the order and the user_id attribute returns the user ID of the store that received the order.

With shipment_id in hand you can:

• Get order data.
• Accept orders.
• Print the order receipt.
• Cancel the order.

On Mercado Pago Delivery there are two types of logistics. In this way, the flow of states may vary according to the type of logistics that will be linked to the order. Below there is a description of those two flows.

This type of logistics is generally used in restaurants that have their own delivery men. Deliverers must have access to the Mercado Envios Flex mobile application to scan the QR code to register and make the delivery. By scanning this QR code, buyers will be notified that the order is on its way. It is possible to use the QR code present in the pdf available in the API or generate the QR code in its integration. The information, which must be contained in the QR code, can be obtained through the Mercado Pago Delivery API using the consult endpoint, where this data will be returned in the “extension.qr” attribute. It is important that the QR code is available on the order ticket so that the delivery flow can be carried out correctly. The following is a description of the status of all notifications that will reach the webhook of orders linked to this type of logistics:

• ready_to_ship/ready_to_print: Initial status of an order. In this Status, some action must be performed (accept or cancel) within a maximum of 5 minutes, otherwise the order will be canceled by timeout.
• cancelled/cancelled_manually: Status indicating that a cancel operation was performed on the order.
• cancelled/time_expired: In this Status, the order was canceled due to timeout. It occurs when no operations have been performed in the first five minutos since the creation of the order.
• ready_to_ship/printed: Status indicating that the order has been accepted.
• shipped/out_for_delivery: Status that indicates the order is on its way to its destination location. This Status is generated right after the delivery person scans the order's QR code, using the Mercado Envios Flex application.
• shipped/delivery_failed: Status that indicates that there was a problem during the delivery of the order. This is generated through the Mercado Envios Flex application when the delivery person is unable to deliver.
• delivered: Delivery was completed successfully. This Status is generated through the Mercado Envios Flex application by the delivery person shortly after the delivery is completed.

This type of logistics is used by restaurants that have agreed that logistics companies, which are integrated with Mercado Pago, carry out the delivery of orders. In this flow, shortly after accepting an order, a notification will be sent that a courier will be on the way to receive the order. It is important to note that, unlike the flow mentioned above, in this Dropoff modality, orders will not have a QR code, and because of this, when consulting the order using the Mercado Pago Delivery API, the extension.qr attribute will be empty. With this type of logistics, it is possible to have a delivery person assigned before the order has been accepted. When accepting the order following the normal flow, the status/substatus: ready_to_ship / ready_to_print would be shown when performing the first GET. But in cases where a courier is assigned very quickly (before accepting the order) it is possible to have the status/substatus: ready_to_ship / on_route_to_pickup in the first GET. Therefore, the recommendation for this type of logistics is to accept orders observing only the status (ready_to_ship). Even with the assigned courier, it is necessary to accept the order within 5 minutes of its creation, otherwise it will be canceled by timeout. And once the courier is assigned, the previous states of the flow will not be shown in the GET. The following is a description of the status of all notifications that will reach the webhook of orders linked to this logistics modality:

• ready_to_ship/ready_to_print: In this status, some action must be performed (accept or cancel) within a maximum of 5 minutes, otherwise the order will be canceled by timeout.
• cancelled/cancelled_manually: Status indicating that a cancel operation was performed on the order.
• cancelled/time_expired: In this Status, the order was canceled due to timeout. It occurs when no operations have been performed in the first five minutos since the creation of the order.
• ready_to_ship/printed: Status indicating that an order has been accepted.
• ready_to_ship/on_route_to_pickup: This status indicates that the delivery person is on his way to the restaurant. It is important to note that orders can have a courier even without the order being accepted, but it is still necessary to accept the order within 5 minutes, otherwise it will end up being canceled due to timeout.
• ready_to_ship/picking_up: The status indicates that the delivery person has arrived at the restaurant and is picking up the order.
• shipped/out_for_delivery: Indicates that the delivery person has already left to deliver the order.
• shipped/at_the_door: Indicates that the delivery person has arrived at the order's destination.
• delivered: Delivery was successful.
• not_delivered: There was a problem and the delivery person was unable to complete the delivery.