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 profile information 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 profile information to the shopping cart, use the Add client profile 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/clientProfileData

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

• Required:

  • email: Customer email address.
  • firstName: Customer first name.
  • lastName: Customer last name.
  • documentType: Type of document provided by the customer (e.g., CPF in Brazil, SSN in the U.S.).
  • document: Document number provided by the customer.

• Recommended (optional):

  • phone: Customer phone number.

• If the client is a legal entity:

  • corporateName: Company name.
  • tradeName: Trade name.
  • corporateDocument: Corporate document.
  • stateInscription: State document number.
  • corporatePhone: Business phone number.
  • isCorporate: True.

After sending the request, the endpoint will return the response body containing the client 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 (code ORD007): "The email field in the customer profile attachment is invalid": This message indicates that the email 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.