The shopping cart is where the information of the products chosen by the customer while browsing a store is gathered. This data may include item prices, shipping value, payment, and delivery methods, among others.

This guide will describe how to create an order from an existing shopping cart by the API.

To place an order from a new cart, access the Create a regular order using the Checkout API.

Try the interactive version of this article by accessing this link. Code will be highlighted and focused for your convenience.

The first step is to get the orderFormId of the shopping cart you want to create an order. For more information, access the Get cart information by ID guide.

To create an order via a specific shopping cart, you need to use the Place order from an existing cart endpoint. In this request, you must send the orderFormId through the URL address, as shown by the example below:

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

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

• referenceId: ID of the orderForm corresponding to the cart in which the order will be created (orderFormId).
• savePersonalData: this parameter should be set as "true" if the shopper’s data provided during checkout should be saved for future reference. Default value is "false".
• optinNewsLetter: this parameter should be set as "true" if the shopper opted to receive the newsletter. Default value is "false".
• value: total value of the order without separating cents. For example, $24.99 is represented by 2499.
• referenceValue: reference value of the order for calculating interest (if applicable). It can be equal to the total value and does not separate cents. For example, $24.99 is represented by 2499.
• interestValue: interest rate to be used in case it applies.

See a request body example below:

After sending the request, the endpoint will return the response body containing all information of a regular order. The example below shows only some of the data returned in this request.

For more information about the meaning of each of the fields available in the shopping cart, access the orderForm guide.

After creating an order using this procedure, you have 5 (five) minutes to send payment information and then request order processing. Otherwise, the order is automatically canceled and tagged incomplete.

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 CHK0016): "Payment value does not match with reference value": the fields value and referenceValue have different values even without the use of interest in the payment. Modify the values used or check if the interest rate is applicable to this order.

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

• Message error example (code ORD005): "The purchase cannot be done without items": this message will appear when the shopping cart (orderFormId) informed in the request does not have any item, making it impossible to create an order.