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 shipping address and delivery 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 shipping address and delivery options. For more information, read the Getting cart information by ID guide.

To add a shipping address to the shopping cart, you need to use the Add shipping address and select delivery option endpoint. In this request, you must send the orderFormId through the URL address, as in the example below:

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

Additionally, you need to send the request body with the selectedAddresses array containing the following information:

• addressType: Address type (e.g. residential, pickup point).
• receiverName: Name of the person who will receive the order at the address.
• postalCode: Postal code number.
• city: City of the shipping address.
• state: State of the shipping address.
• country: Country of the shipping address, indicated by the three-letter ISO code (e.g. BRA, USA).
• street: Street of the shipping address.
• number: Number of the shipping address.
• neighborhood: Neighborhood of the shipping address.
• complement: Shipping address additional information (if necessary).
• reference: Additional information that might help locate the shipping address more precisely in case of delivery.
• geoCoordinates: Longitude and latitude of the shipping address.

After sending the request, the endpoint will return the response body containing the shipping address 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.

To add a delivery option to the shopping cart, you must add a shipping address (following the previous section), and use the same Add shipping address and select delivery option endpoint. However, you need to send the request body with the logisticsInfo array containing the following information:

• itemIndex: Item position in the array or cart.
• selectedDeliveryChannel: Delivery option selected by the customer (e.g. delivery, pickup-in-point).
• selectedSla: The selected SLA (e.g. normal, express).

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

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

• Message error example (code ORD001): "The CEP (XXXX) field in the shipping attachment is invalid": This message indicates that the postalCode used in the request does not exist or is incorrect.

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

• Message error example (code ORD015): "Unable to communicate with seller VTEX- Test International": This message indicates that the geoCoordinates used in the request do not exist or are incorrect.

• Message error example (code ORD026): "A communication error with Postal Code Service has occurred": This message indicates that the country information used in the request is not in three-letter ISO code format or does not exist.

• Message error example (code CHK0041): "Invalid item index": This message indicates that the itemIndex 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.