[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides create a regular order from an existing cart in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/orders-2)

[Creating a regular order with the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-with-the-checkout-api)

[Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/shopping-cart-section-api-quick-start-guides)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/orders-2)

[Creating a regular order with the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-with-the-checkout-api)

[Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/shopping-cart-section-api-quick-start-guides)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides)

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/checkout-api-overview)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/orders-2)

[Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart)

Creating a regular order from an existing cart

Learn how to use VTEX APIs to place a regular order from an existing cart.

This step-by-step guide will walk you through the process of using the [Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api) and [Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api) to create an order from an existing shopping cart. It is divided into the following steps:

1. **Get cart information:** Begin by retrieving the `orderFormId` of the current shopping cart via the [Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm) endpoint.
2. **Place the order:** Continue by placing the order on the VTEX platform via the [Place order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/transaction) endpoint.
3. **Handling the order payment and processing:** The process ends by [sending the necessary payment data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api%23post-/api/pub/transactions/-transactionId-/payments) to resolve the order payment and by [processing order details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/gatewayCallback/-orderGroup-).

## Before you begin

Before proceeding any further, ensure that you have a valid `appKey` and `appToken` with the necessary permissions to access the [Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api) and [Payments Gateway](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api) APIs. For more information, refer to the [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) article.

## Preparing the cart

In addition to valid credentials, ensure that the cart used to create the order already includes all the required information. Without these details, the steps described in this guide cannot be completed:

* **Selected products**: Ensure the cart includes the desired items.
* **Customer data and shipping address**: Confirm that the information is complete and valid.
* **Payment method**: Define the payment option in advance. For credit cards, also include the number of installments and the card brand.

All of these details can be easily verified on the checkout screen, as shown in the illustration below.

![{"base64":"  ","img":{"width":817,"height":604,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":91726,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Checkout/checkout_cart.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Checkout/checkout_cart.png)

> Click the steps below to navigate through this article and explore specific topics. Relevant code for each phase or parameter is highlighted on the right side of the screen.

## Step 1 - Getting cart information

Send a `GET` request to the [Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm) endpoint to retrieve the `orderFormId` of the shopping cart you intend to use to create an order. The `orderFormId` is a unique identifier for the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) linked to a specific shopping cart.

> For more information, refer to the [Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id) guide.

## Step 2 - Placing the order

Place a new order via the [Place order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/transaction) endpoint, using the shopping cart identification (`orderFormId`) as a path parameter and providing the following information in the request body:

* `referenceId`: the same `orderFormId` value used in the path parameter.
* `value`: total value of the order in cents (e.g., $24.99 is represented by `2499`).
* `referenceValue`: reference value of the order in cents (e.g., $24.99 is represented by `2499`). This is used for calculating interest, if applicable.
* `interestValue`: interest value to be applied, if applicable.
* `savePersonalData`: set as `true` if the shopper's data provided during checkout should be saved for future reference (default is `false`).
* `optinNewsLetter`: set as `true` if the shopper opted to receive the newsletter (default is `false`).

Upon receiving a `200 OK` response, the request will provide a response body containing the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) with comprehensive details of the newly created regular order. Note the following details. Then, proceed to [Resolving the order payment](#step-3---resolving-the-order-payment).

* `orderGroup` \- ID that groups all orders related to the same purchase. For example, when an order is fulfilled by multiple sellers, each seller has its own order ID (`v71021570str-01` and `v71021570str-02`), but they share the same order group ID (`v71021570str`).
* `transactionId` \- ID of the transaction, which can be found within an object contained in the `merchantTransactions` array.

> If you encounter errors during the request submission, refer to [Handling HTTP response errors when placing the order](#handling-http-response-errors-when-placing-the-order) for common error scenarios when placing an order.

## Step 3 - Resolving the order payment

Now, we will communicate the necessary payment data to VTEX to finalize the order payment.

> Note that from now on (once Step 2 has been completed), you have 5 minutes to submit the payment information (Step 3) and process the order (Step 4). If Steps 3 and 4 are not completed within 5 minutes, the order will be automatically canceled.

* Send a request to the [Send payments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api%23post-/api/pub/transactions/-transactionId-/payments) endpoint, considering the following:
   * Use the `transactionId` value from the previous step as both the path parameter and the value for the `id` field within the `transaction` object.
   * Set the `merchantName` field within the `transaction` object to your account name.
   * Use the `orderId` value as a query string parameter. This is the same `orderGroup` obtained in the previous step.
   * Ensure that the request body is based on the `paymentData` section of your `orderForm`.
   * In the `fields` object, you can:
         * Fill in the credit or debit card information (when applicable).
         * Use the `addressId` field to reference an existing address, or provide a new `address` object for an entirely new address. This type of information is only required if the shopper's address was not previously entered during checkout.

> This request does not return any data in the response body, only a `201 Created` success confirmation message.

## Step 4 - Processing and validating the order

In this final step, we will process the order.

* Send a request to the [Process order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/gatewayCallback/-orderGroup-) endpoint, using the `orderGroup` value (which is the `orderFormId`) as a path parameter.

> If the payment is processed without any issues, the order should be successfully placed (`204 No Content` status). Otherwise, a `500 Internal Server Error` message might occur.

> Note that this process uses the gateway connectors configured in your VTEX environment. Be careful to prevent any unwanted charges or unexpected payment denials.

Shell

Python

Node.js

`1

curl --request get \

2

 --url https://apiexamples.vtexcommercestable.com.br/api/checkout/pub/orderForm \

3

 --header 'Accept: application/json' \

4

 --header 'Content-Type: application/json'

`

Response

`1

{

2

 "orderFormId": "9563daa04ee24ac09be80d272dcc9e72",

3

 "salesChannel": "1",

4

 "loggedIn": false,

5

 "isCheckedIn": false,

6

 "storeId": null,

7

 "checkedInPickupPointId": null,

8

 "allowManualPrice": false,

9

 "canEditData": true,

10

 "userProfileId": "string",

11

 "userType": null,

12

 "ignoreProfileData": false,

13

 "value": 30000,

14

 "messages": [],

15

 "items": [

16

 {

17

 "uniqueId": "07FA7060463B48B7A8761E72C763DCE4",

18

 "id": "102",

19

 "productId": "11",

20

 "productRefId": "00011",

21

 "refId": "00012",

22

 "ean": null,

23

 "name": "Adidas x South Park Forum Low “AWESOM-O” caramel 38",

24

 "skuName": "Adidas x South Park Forum Low “AWESOM-O” caramel 38",

25

 "modalType": null,

26

 "parentItemIndex": null,

27

 "parentAssemblyBinding": null,

28

 "assemblies": [],

29

 "priceValidUntil": "2026-09-22T22:02:39Z",

30

 "tax": 0,

31

 "price": 30000,

32

 "listPrice": 30000,

33

 "manualPrice": null,

34

 "manualPriceAppliedBy": null,

35

 "sellingPrice": 30000,

36

 "rewardValue": 0,

37

 "isGift": false,

38

 "additionalInfo": {

39

 "dimension": null,

40

 "brandName": "VTEX Brand",

41

 "brandId": "2000002",

42

 "offeringInfo": null,

43

 "offeringType": null,

44

 "offeringTypeId": null

45

 },

46

 "preSaleDate": null,

47

 "productCategoryIds": "/2000017/",

48

 "productCategories": {

49

 "2000017": "VTEX Day Hackthon"

50

 },

51

 "quantity": 1,

52

 "seller": "1",

53

 "sellerChain": [

54

 "1"

55

 ],

56

 "imageUrl": "https://accountname.vteximg.com.br/arquivos/ids/155427-55-55/gy6475-1.jpg?v=638418000550100000",

57

 "detailUrl": "/adidas-southpark-awesome/p",

58

 "components": [],

59

 "bundleItems": [],

60

 "attachments": [],

61

 "attachmentOfferings": [],

62

 "offerings": [],

63

 "priceTags": [],

64

 "availability": "available",

65

 "measurementUnit": "un",

66

 "unitMultiplier": 1.0000,

67

 "manufacturerCode": null,

68

 "priceDefinition": {

69

 "calculatedSellingPrice": 30000,

70

 "total": 2200,

71

 "sellingPrices": [

72

 {

73

 "value": 30000,

74

 "quantity": 1

75

 }

76

 ],

77

 "reason": null

78

 },

79

 "taxCode": ""

80

 }

81

 ],

82

 "selectableGifts": [],

83

 "totalizers": [

84

 {

85

 "id": "Items",

86

 "name": "Total dos Itens",

87

 "value": 30000

88

 },

89

 {

90

 "id": "Shipping",

91

 "name": "Total do Frete",

92

 "value": 0

93

 }

94

 ],

95

 "shippingData": {

96

 "address": {},

97

 "logisticsInfo": [],

98

 "selectedAddresses": [],

99

 "availableAddresses": [],

100

 "pickupPoints": [],

101

 "contactInformation": []

102

 },

103

 "clientProfileData": {

104

 "email": "name.surname@test.com",

105

 "firstName": "Name",

106

 "lastName": "Surname",

107

 "document": "5555555555",

108

 "documentType": "cpf",

109

 "phone": "+55125555555",

110

 "corporateName": null,

111

 "tradeName": null,

112

 "corporateDocument": null,

113

 "stateInscription": null,

114

 "corporatePhone": null,

115

 "isCorporate": false,

116

 "profileCompleteOnLoading": null,

117

 "profileErrorOnLoading": null,

118

 "customerClass": null

119

 },

120

 "paymentData": {

121

 "updateStatus": "updated",

122

 "installmentOptions": [

123

 {

124

 "paymentSystem": "1",

125

 "bin": null,

126

 "paymentName": null,

127

 "paymentGroupName": null,

128

 "value": 30000,

129

 "installments": [

130

 {

131

 "count": 1,

132

 "hasInterestRate": false,

133

 "interestRate": 0,

134

 "value": 30000,

135

 "total": 30000,

136

 "sellerMerchantInstallments": [

137

 {

138

 "id": "accountName",

139

 "count": 1,

140

 "hasInterestRate": false,

141

 "interestRate": 0,

142

 "value": 30000,

143

 "total": 30000

144

 }

145

 ]

146

 },

147

 {

148

 "count": 2,

149

 "hasInterestRate": true,

150

 "interestRate": 200,

151

 "value": 15451,

152

 "total": 30902,

153

 "sellerMerchantInstallments": [

154

 {

155

 "id": "accountName",

156

 "count": 2,

157

 "hasInterestRate": true,

158

 "interestRate": 200,

159

 "value": 15451,

160

 "total": 30902

161

 }

162

 ]

163

 },

164

 ...

165

 ]

166

 }

167

 ],

168

 "paymentSystems": [

169

 "paymentSystems": [

170

 {

171

 "id": 64,

172

 "name": "Customer Credit",

173

 "groupName": "creditControlPaymentGroup",

174

 "validator": {

175

 "regex": null,

176

 "mask": null,

177

 "cardCodeRegex": null,

178

 "cardCodeMask": null,

179

 "weights": null,

180

 "useCvv": false,

181

 "useExpirationDate": false,

182

 "useCardHolderName": false,

183

 "useBillingAddress": false

184

 },

185

 ...

186

 }

187

 ]

188

 ],

189

 "payments": [

190

 {

191

 "paymentSystem": "2",

192

 "bin": null,

193

 "accountId": null,

194

 "tokenId": null,

195

 "installments": 1,

196

 "referenceValue": 30000,

197

 "value": 30000,

198

 "merchantSellerPayments": [

199

 {

200

 "id": "accountName",

201

 "installments": 1,

202

 "referenceValue": 30000,

203

 "value": 30000,

204

 "interestRate": null,

205

 "installmentValue": 30000

206

 }

207

 ]

208

 }

209

 ],

210

 "giftCards": [],

211

 "giftCardMessages": [],

212

 "availableAccounts": [],

213

 "availableTokens": []

214

 },

215

 "marketingData": null,

216

 "sellers": [

217

 {

218

 "id": "1",

219

 "name": "accountName",

220

 "logo": "",

221

 "minimumOrderValue": 0

222

 }

223

 ],

224

 "clientPreferencesData": {

225

 "locale": "pt-BR",

226

 "optinNewsLetter": null

227

 },

228

 "commercialConditionData": null,

229

 "storePreferencesData": {

230

 "countryCode": "BRA",

231

 "saveUserData": true,

232

 "timeZone": "E. South America Standard Time",

233

 "currencyCode": "BRL",

234

 "currencyLocale": 1046,

235

 "currencySymbol": "R$",

236

 "currencyFormatInfo": {

237

 "currencyDecimalDigits": 2,

238

 "currencyDecimalSeparator": ",",

239

 "currencyGroupSeparator": ".",

240

 "currencyGroupSize": 3,

241

 "startsWithCurrencySymbol": true

242

 }

243

 },

244

 "giftRegistryData": null,

245

 "openTextField": null,

246

 "invoiceData": null,

247

 "customData": null,

248

 "itemMetadata": {

249

 "items": [

250

 {

251

 "id": "102",

252

 "seller": "1",

253

 "name": "Adidas x South Park Forum Low “AWESOM-O” caramel 38",

254

 "skuName": "Adidas x South Park Forum Low “AWESOM-O” caramel 38",

255

 "productId": "11",

256

 "refId": "00012",

257

 "ean": null,

258

 "imageUrl": "https://accountname.vteximg.com.br/arquivos/ids/155427-55-55/gy6475-1.jpg?v=638418000550100000",

259

 "detailUrl": "/adidas-southpark-awesome/p",

260

 "assemblyOptions": []

261

 }

262

 ]

263

 },

264

 "hooksData": null,

265

 "ratesAndBenefitsData": null,

266

 "subscriptionData": null,

267

 "itemsOrdination": null

268

}

`

## Handling HTTP response errors when placing the order

### 400 - Bad Request (`ORD002`)

`Message error example (code ORD002): "Invalid order form"`

* **Issue:** The `orderFormId` information is not valid.
* **Troubleshooting:**
   * Verify that the `orderFormId` is correct.
   * Ensure that the `orderFormId` corresponds to an existing shopping cart.

### 400 - Bad Request (`CHK0016`)

`Message error example (code CHK0016): "Payment value does not match with reference value"`

* **Issue:** The `value` and `referenceValue` fields have different values even when no interest is applied to the payment.
* **Troubleshooting:**
   * Confirm that the provided `value` and `referenceValue` align correctly.
   * Check if the interest rate is correctly configured.

### 404 - Not Found

`Message error example: "The requested URL was not found on the server"`

* **Issue:** The requested URL was not found on the server.
* **Troubleshooting:** Check if the endpoint used is correct.

### 500 - Internal Server Error

`Message error example (code ORD005): "The purchase cannot be done without items"`

* **Issue:** The shopping cart (`orderFormId`) informed in the request does not have any item, making it impossible to create an order.
* **Troubleshooting:**
   * Verify that the specified shopping cart has items.
   * Confirm that the `orderFormId` corresponds to a valid and non-empty shopping cart.

Response

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "ORD002",

5

 "message": "Invalid order form",

6

 "exception": null

7

 },

8

 "operationId": "f01ef909-8b81-4ffd-a91d-82be680d60ff"

9

}

`

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F87548049%3Fv%3D4%26w=64%26q=75)](https://github.com/ricardoaerobr)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/creating-a-regular-order-from-an-existing-cart.mdx)

[Creating a regular order with the Checkout API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart//docs/guides/creating-a-regular-order-with-the-checkout-api)[SecurityNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart//docs/guides/checkout-security)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F87548049%3Fv%3D4%26w=64%26q=75)](https://github.com/ricardoaerobr)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23before-you-begin)

[Preparing the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23preparing-the-cart)

[Step 1 - Getting cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-1-getting-cart-information)

[Step 2 - Placing the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-2-placing-the-order)

[Step 3 - Resolving the order payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-3-resolving-the-order-payment)

[Step 4 - Processing and validating the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-4-processing-and-validating-the-order)

[Handling HTTP response errors when placing the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23handling-http-response-errors-when-placing-the-order)

[400 - Bad Request (ORD002)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23400-bad-request-ord002)[400 - Bad Request (CHK0016)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23400-bad-request-chk0016)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23404-not-found)[500 - Internal Server Error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23500-internal-server-error)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/creating-a-regular-order-from-an-existing-cart.mdx)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23before-you-begin)

[Preparing the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23preparing-the-cart)

[Step 1 - Getting cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-1-getting-cart-information)

[Step 2 - Placing the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-2-placing-the-order)

[Step 3 - Resolving the order payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-3-resolving-the-order-payment)

[Step 4 - Processing and validating the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23step-4-processing-and-validating-the-order)

[Handling HTTP response errors when placing the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23handling-http-response-errors-when-placing-the-order)

[400 - Bad Request (ORD002)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23400-bad-request-ord002)[400 - Bad Request (CHK0016)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23400-bad-request-chk0016)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23404-not-found)[500 - Internal Server Error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-from-an-existing-cart/docs/guides/creating-a-regular-order-from-an-existing-cart%23500-internal-server-error)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides master data how it works in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data)

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/understanding-master-data)

[Master Data components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-components)

[Master Data infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-infrastructure)

[Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-api)

[Data consistency and synchronization in Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/data-consistency-and-synchronization-in-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-best-practices)

[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-v2)

[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-v1)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data)

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/understanding-master-data)

[Master Data components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-components)

[Master Data infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-infrastructure)

[Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-api)

[Data consistency and synchronization in Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/data-consistency-and-synchronization-in-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-best-practices)

[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-v2)

[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data-v1)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides)

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/master-data)

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/docs/guides/understanding-master-data)

Understanding Master Data

Learn about the fundamental concepts of Master Data, including its components, architecture, API usage, and schema lifecycle.

[ComponentsLearn about Data Entities, Documents, Fields, and Indexes in Master Data, and how these components work together to structure and optimize data for efficient querying.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components)[InfrastructureLearn how the Master Data core services (API, Worker, Storage, and Search Engine) ensure data consistency and efficient document management.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-infrastructure)[Master Data APILearn how to manage and retrieve documents, define data structures, and configure searchable fields in Master Data.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-schema-lifecycle)[Data consistency and synchronization in Master DataLearn how data synchronization operates across Master Data API endpoints.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-consistency-and-synchronization-in-master-data)[Schema LifecycleLearn how changes in a Master Data v2 Schema affect Data Entities.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-schema-lifecycle)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/understanding-master-data/understanding-master-data.md)

[Master Data« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works//docs/guides/master-data)[Master Data componentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works//docs/guides/master-data-components)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/understanding-master-data/understanding-master-data.md)

Copy page

On this page

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Explain troubleshooting i cant install the headless cms plugins in my account in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/updates/release-notes)

Troubleshooting

API

---

Development

[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)

[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)

[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)

[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/unable-to-access-headless-cms)

[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)

[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-vtex-io-cli)

[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-integrate-my-external-search-provider)

[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)

[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)

[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)

[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)

[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)

[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)

[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)

[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)

[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-create-a-new-workspace)

[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)

[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-dont-see-my-store-theme-changes)

---

Store performance

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/updates/release-notes)

Troubleshooting

API

---

Development

[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)

[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)

[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)

[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/unable-to-access-headless-cms)

[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)

[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-vtex-io-cli)

[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-integrate-my-external-search-provider)

[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)

[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)

[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)

[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)

[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)

[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)

[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)

[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)

[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-create-a-new-workspace)

[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)

[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-dont-see-my-store-theme-changes)

---

Store performance

---

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting)

Development

I can’t install the Headless CMS plugins in my account

Users may encounter errors related to symbolic links and node version incompatibility.

FastStore users may encounter the following errors after [installing the Headless CMS plugin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-1-configuring-the-vtex-account%23step-1-setting-up-the-command-line-environment).

| Error message                                                                                | Possible cause                                                                                | Solution                                                                                |
| ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Error: EPERM: operation not permitted, symlink                                                                           | Your device isn’t enabled for development.                                                                        | [Enable Developer Mode in your machine](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/error-installing-headless-cms-plugins-on-windows%23enable-developer-mode-in-your-machine) |
| error @oclif/core@1.26.2: The engine "node" is incompatible with this module. Expected version ">=14.0.0". Got "12.12.0" | The VTEX IO CLI’s node version isn’t updated. Expected version was \>=14.0.0, but the current version is 12.12.0. | [Update VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/error-installing-headless-cms-plugins-on-windows%23update-vtex-io-cli)                                       |

## Solutions

To solve these issues, follow the instructions below:

* [Enable Developer Mode on your machine](#enable-developer-mode-on-your-machine)
* [Update VTEX IO CLI](#update-vtex-io-cli)

### Enable Developer Mode on your machine

While running the `vtex plugins install cms`, Windows users can get the following error:

`1

vtex plugins install cms

2

warning "@vtex/cli-plugin-cms > @vtex/api > apollo-server-core > apollo-graphql@0.9.5" has incorrect peer dependency "graphql@^14.2.1 || ^15.0.0".

3

Installing plugin @vtex/cli-plugin-cms... failed

4

 Error: EPERM: operation not permitted, symlink

5

 'C:\Users\LukeSkywalker\AppData\Roaming\npm\node_modules\vtex' ->

6

 'C:\Users\LukeSkywalker\AppData\Local\vtex\node_modules\vtex'

7

 Code: EPERM

`

FastStore projects rely on creating symbolic links (symlinks). To solve this error, you must enable [Developer Mode](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development%23accessing-settings-for-developers) on your machine. Developer Mode grants the necessary permissions and privileges to use symlinks, which reduces the probability of encountering errors during development.

> Running the FastStore project as an administrator isn't recommended.

Learn how to enable Developer Mode in Microsoft's official guide [Enable your device for development](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development%23accessing-settings-for-developers).

After enabling Developer Mode, launch Windows Terminal and run `vtex cms`. This will allow the system to create the necessary symlinks for running commands from the Headless CMS plugin.

### Update VTEX IO CLI

If you run the `vtex plugins install cms` command and get the error below, you need to update the VTEX IO CLI version you're using.

`1

vtex plugins install cms

2

error @oclif/core@1.26.2: The engine "node" is incompatible with this module. Expected version ">=14.0.0". Got "12.12.0"

3

error Found incompatible module.

4

Installing plugin @vtex/cli-plugin-cms... failed

5

 Error: yarn add @vtex/cli-plugin-cms@latest --non-interactive --mutex=file:C:\Users\barbara.celi\AppData\Local\vtex\yarn.lock --preferred-cach

`

Even if you update the `node` version on your machine, you must also keep VTEX IO CLI updated to avoid errors.

To update VTEX IO CLI, open Windows Terminal and follow these instructions:

1. Run the `vtex autoupdate` command in Windows Terminal.
2. Run the `vtex -v` command to check if the VTEX IO CLI and `node` versions are updated.
3. Run the `vtex plugins install cms` command to install the Headless CMS plugins.
4. Check if the installation of Headless CMS plugins was successful by running `vtex cms`. You should see the following:

`1

$ vtex cms

2

Syncs CMS schemas with the current workspace in use.

3

4

USAGE

5

 $ vtex cms COMMAND

6

COMMANDS

7

 cms sync Syncs CMS schemas with the current workspace in use.

`

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-cant-install-the-headless-cms-plugins-in-my-account.md)

[I can’t access the Headless CMS« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/unable-to-access-headless-cms)[I can't install VTEX IO CLINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-vtex-io-cli)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

ON THIS PAGE

[Solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23solutions)

[Enable Developer Mode on your machine](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23enable-developer-mode-on-your-machine)[Update VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23update-vtex-io-cli)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-cant-install-the-headless-cms-plugins-in-my-account.md)

Copy page

On this page

ON THIS PAGE

[Solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23solutions)

[Enable Developer Mode on your machine](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23enable-developer-mode-on-your-machine)[Update VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account%23update-vtex-io-cli)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides enable the manual price in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/features)

[Enable the Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price)

[Enable the Save user data opt-in](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-save-user-data-opt-in)

[Enable the Region for SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-region-for-skus)

[Configure the Global Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/configure-the-global-checkout)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/shopping-cart-section-api-quick-start-guides)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/features)

[Enable the Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price)

[Enable the Save user data opt-in](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-save-user-data-opt-in)

[Enable the Region for SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-region-for-skus)

[Configure the Global Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/configure-the-global-checkout)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/shopping-cart-section-api-quick-start-guides)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides)

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/checkout-api-overview)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/features)

[Enable the Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price)

Enable the Manual Price

At VTEX, stores can manually set the price of an item ([SKU](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/o-que-e-um-sku--1K75s4RXAQyOuGUYKMM68u%23)) when it is in the cart, on the product page on [inStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/allow-manual-prices-on-instore), or is a subscription item. This feature is called **Manual Price** and can only be performed by some Admin VTEX user profiles.

Before starting to manually set prices in your store, the following information should be considered:

* Item prices can be modified (increased/decreased) freely, without any kind of restriction. However, if the price is changed to a value that is outside the parameters defined in the [Order Authorization](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/how-order-authorization-works--3MBK6CmKHAuUjMBieDU0pn%23) feature, the order will not be invoiced.
* Users with the following roles or permission will have access to modify the price of all items registered to your account (including all stores/sub-accounts):
   * **Roles**: Owner (Admin Super) or Call Center Operator (Telesales)
   * **Permission**: Shopping Cart Full Access

## Manual Price activation

To use the Manual Price functionality in your store, you must first enable it. Then, follow the settings below:

1. Make a `GET` request using the endpoint [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm).
2. Make a `POST` request using the endpoint [Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) with the same data obtained in the GET request, just modifying the value of the `allowManualPrice` parameter from `null` to `true`.
3. Make a new `GET` request using the endpoint [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm) to confirm activation.

## Setting the price of an item manually

For each sales method, there is a different way of manually modifying the price. The list below describes the procedure for each of these methods:

* **Cart items:** making a `PUT` request using the endpoint [Change Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/pricechange), or configuring directly on the shop cart screen, check [Change the price of an item in the shopping cart](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/modificar-o-preco-de-um-item-no-carrinho-de-compras--7Cd37aCAmtL1qmoZJJvjNf).
* **inStore items:** check [Allow manual prices on inStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/allow-manual-prices-on-instore%23usage).
* **Subscription items:** check [Enabling Manual Prices for Subscriptions v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enabling-manual-prices-for-subscriptions-v3).

## Recording manual changes to item prices

All price changes made manually are recorded and the user responsible for the change can be identified. To verify the user responsible for modifying the price of an item, follow the steps below:

1. Makes a `GET` request using the endpoint [Get Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getorder). You will need to provide the specific `orderId` on which the price was manually modified.
2. Register the information available in the `manualPriceAppliedBy` property. It will bring up the _user ID_ or the _appKey_ used to make the change.
3. Makes a `GET` request using the endpoint [License Manager - Get User](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/reference/getuser), filling in with the _user ID_ or _appKey_, to obtain the data of the person responsible for the modification.

Example of information available in `manualPriceAppliedBy` property:

![{"base64":"  ","img":{"width":522,"height":70,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":28479,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/enable-the-manual-price-0.PNG"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/enable-the-manual-price-0.PNG)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F87548049%3Fv%3D4%26w=64%26q=75)](https://github.com/ricardoaerobr)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/features/enable-the-manual-price.md)

[Features« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price//docs/guides/features)[Enable the Save user data opt-inNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price//docs/guides/enable-the-save-user-data-opt-in)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F87548049%3Fv%3D4%26w=64%26q=75)](https://github.com/ricardoaerobr)

ON THIS PAGE

[Manual Price activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price%23manual-price-activation)

[Setting the price of an item manually](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price%23setting-the-price-of-an-item-manually)

[Recording manual changes to item prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price%23recording-manual-changes-to-item-prices)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/features/enable-the-manual-price.md)

Copy page

On this page

ON THIS PAGE

[Manual Price activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price%23manual-price-activation)

[Setting the price of an item manually](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price%23setting-the-price-of-an-item-manually)

[Recording manual changes to item prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-manual-price/docs/guides/enable-the-manual-price%23recording-manual-changes-to-item-prices)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)