The orderForm is the main object processed by VTEX Checkout and one of the most important data structures in the architecture of every VTEX store. It stores a lot of contextual information about the order, which is essential for processing order information, such as order items, customer personal information, delivery address, and shipping information.

This guide will describe how to remove all messages from the messages field of the orderForm, leaving it empty.

To remove all messages from the orderForm messages field of the shopping cart, you need to use the Clear orderForm messages endpoint. The orderFormId information of the shopping cart must be sent through the URL request, as in the example below:

https://{accountname}.{environment.com.br}/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/messages/clear

Additionally, you need to send the request body containing only two curly brackets, as shown below:

After sending the request, the endpoint will return the response body containing the shopping cart information and the messages field will empty, as in the example below:

For more information about the meaning of each field available in the shopping cart, please refer to the orderForm overview.

The following errors may appear as messages in the response body:

• Message error example (code 001): "Bad Request". This message indicates that information other than {} was sent in the request body.

• Message error example (code ORD002): "Carrinho inválido" (Invalid Cart). This message indicates that the orderFormId used in the request does not exist or is incorrect.

• Message error example: "The requested URL was not found on the server": check if the URL is correct.