The shopping cart gathers information on the products the customer chooses while browsing a store, such as prices, shipping costs, payment methods, delivery methods, etc. This data may include item prices, shipping value, payment, and delivery methods, among others.

This guide will describe how to add customer preferences information (website locale and newsletter options) to the shopping cart via API.

The first step is to get the orderFormId of the shopping cart to which you want to add the customer preferences information. For more information, read the Getting cart information by ID guide.

To add customer preferences information to the shopping cart, use the Add client preferences endpoint. In this request, you must send the orderFormId through the URL address, as shown in the example below:

https://{accountName}.{environment.com.br}/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/attachments/clientPreferencesData

Additionally, you need to send the request body containing the following customer preferences information:

• locale: Defines the website language chosen by the customer (e.g. PT, EN, ES).
• optinNewsLetter: Indicates if the customer subscribed to the store newsletter.

See a request body example below:

After sending the request, the endpoint will return the response body containing the client preferences information in the shopping cart, as in the example below:

️ For more information on each field available in the shopping cart, see the orderForm overview.

The following errors may appear as a message in the response body.

• Message error example (code ORD002): "Invalid order form". The orderFormId information is not valid.

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