[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 getting a customer profile by email 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/getting-a-customer-profile-by-email/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/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/getting-a-customer-profile-by-email/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/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/getting-a-customer-profile-by-email/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/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/getting-a-customer-profile-by-email/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/shopping-cart-section-api-quick-start-guides)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/cart-attachments-section-api-quick-start-guides)

[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email)

[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-customer-profile-information-to-the-cart)

[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)

[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-customer-preferences-to-the-cart)

[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-marketing-information-to-the-cart)

[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-cart-items)

[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/adding-payment-information-to-the-cart)

[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-merchant-context-information-to-the-cart)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/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/getting-a-customer-profile-by-email/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/shopping-cart-section-api-quick-start-guides)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/cart-attachments-section-api-quick-start-guides)

[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email)

[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-customer-profile-information-to-the-cart)

[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)

[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-customer-preferences-to-the-cart)

[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-marketing-information-to-the-cart)

[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-cart-items)

[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/adding-payment-information-to-the-cart)

[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/add-merchant-context-information-to-the-cart)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/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/getting-a-customer-profile-by-email/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides)

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/checkout-api-overview)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/cart-attachments-section-api-quick-start-guides)

[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email)

Getting a customer profile by email

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

The information added to the customer profile can be used in the shopping cart to reduce the time the customer spends at Checkout and improve their shopping experience. For more information, read [Purchasing with SmartCheckout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/smartcheckout-customer-information-automatic-fill-in--2Nuu3xAFzdhIzJIldAdtan%23purchasing-with-smartcheckout).

This guide will describe how to get client profile information using the email address registered in your store.

## Getting customer profile information

To access the customer profile information, you must use the [Get client profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getclientprofilebyemail) endpoint. In this request, you must send the customer's email through the URL address, as in the example below:

`https://{accountname}.{environment.com.br}/api/checkout/pub/profiles?email=test1@test2.com`

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

`1

...

2

{

3

 "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",

4

 "profileProvider": "VTEX",

5

 "availableAccounts": [],

6

 "availableAddresses": [

7

 {

8

 "addressType": "residential",

9

 "receiverName": "Clark Kent",

10

 "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",

11

 "isDisposable": false,

12

 "postalCode": "12345-000",

13

 "city": "Metropolis",

14

 "state": "NY",

15

 "country": "USA",

16

 "street": "My street",

17

 "number": "123",

18

 "neighborhood": "My neighborhood",

19

 "complement": null,

20

 "reference": null,

21

 "geoCoordinates": [

22

 -47.924747467041016,

23

 -15.832582473754883

24

 ]

25

 }

26

 ],

27

 "userProfile": {

28

 "email": "clark.kent@example.com",

29

 "firstName": "Clark",

30

 "lastName": "Kent",

31

 "document": "12345678900",

32

 "documentType": "cpf",

33

 "phone": "+556199999999",

34

 "corporateName": null,

35

 "tradeName": null,

36

 "corporateDocument": null,

37

 "stateInscription": null,

38

 "corporatePhone": null,

39

 "isCorporate": false,

40

 "profileCompleteOnLoading": null,

41

 "profileErrorOnLoading": null,

42

 "customerClass": null

43

 },

44

 "isComplete": true

45

}

46

...

`

>  Fields not completed in the customer profile will be displayed as `null`.

## Error codes

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

### 200 - OK

Despite the `200` code, which indicates the success of the request, if the email used is not registered in your store or the customer profile is invalid or incomplete, the response body will not contain any customer profile information. In these conditions, the [SmartCheckout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/smartcheckout-customer-information-automatic-fill-in--2Nuu3xAFzdhIzJIldAdtan) feature cannot be used in the shopping cart.

`1

{

2

 "userProfileId": null,

3

 "profileProvider": null,

4

 "availableAccounts": [],

5

 "availableAddresses": [],

6

 "userProfile": null,

7

 "isComplete": false

8

}

`

### 400 - Bad Request

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

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "ORD002",

5

 "message": "Invalid order form",

6

 "exception": null

7

 },

8

 "operationId": "5d9f54e6-7db4-46d6-bca9-deeb278b8b98"

9

}

`

### 404 - Not Found

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

`1

2

404 Not Found

3

The requested URL was not found on this server.

4

`

Contributors

2

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F106821144%3Fv%3D4%26w=64%26q=75)](https://github.com/GeorgeLimaDev)

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/cart-attachments-section-quick-start-guides/getting-a-customer-profile-by-email.md)

[Cart Attachments« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email//docs/guides/cart-attachments-section-api-quick-start-guides)[Adding customer profile information to the cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email//docs/guides/add-customer-profile-information-to-the-cart)

Contributors

2

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F106821144%3Fv%3D4%26w=64%26q=75)](https://github.com/GeorgeLimaDev)

ON THIS PAGE

[Getting customer profile information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23getting-customer-profile-information)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23error-codes)

[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23404-not-found)

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/cart-attachments-section-quick-start-guides/getting-a-customer-profile-by-email.md)

Copy page

On this page

ON THIS PAGE

[Getting customer profile information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23getting-customer-profile-information)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23error-codes)

[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-a-customer-profile-by-email/docs/guides/getting-a-customer-profile-by-email%23404-not-found)

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 custom data 1 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/custom-data-1/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/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/custom-data-1/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/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/custom-data-1/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/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/custom-data-1/updates/release-notes)

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

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

[Add and handle custom information in the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/add-and-handle-custom-information-in-the-order)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/checkout-security)

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

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

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/configuration-section-api-quick-start-guides)

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

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/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/custom-data-1/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides)

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

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

[Add and handle custom information in the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/add-and-handle-custom-information-in-the-order)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/checkout-security)

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

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

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/configuration-section-api-quick-start-guides)

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

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/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/custom-data-1/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/docs/guides)

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

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

Custom Data

This section contains articles about custom information in the order. Here you will find the following articles:

* [Add and handle custom information in the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/_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/custom-data-1/_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/custom-data-1.md)

[Checkout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1//docs/guides/checkout-api-overview)[Add and handle custom information in the orderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1//docs/guides/add-and-handle-custom-information-in-the-order)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-data-1/_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/custom-data-1/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

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/custom-data-1.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] Provide a guide on guides creating 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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-a-regular-order-from-an-existing-cart/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-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/creating-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/creating-a-regular-order-from-an-existing-cart/docs/guides/customization)

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

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

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-a-regular-order-from-an-existing-cart/docs/guides)

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

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

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-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/creating-a-regular-order-from-an-existing-cart/docs/vtex-io-apps)

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

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-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/creating-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/creating-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/creating-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/creating-a-regular-order-from-an-existing-cart/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-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/creating-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/creating-a-regular-order-from-an-existing-cart/docs/guides/customization)

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

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

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-a-regular-order-from-an-existing-cart/docs/guides)

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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/creating-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 how to configure tradename to use in the organization search field 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/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/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/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/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/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/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/how-to-configure-tradename-to-use-in-the-organization-search-field/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

B2B Organizations

[Bulk Import Buyer Organizations Spreadsheet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/bulk-import-buyer-organizations-spreadsheet)

[How to configure tradeName to use in the organization search field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)

[Enabling an access control list ACL in B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/enabling-an-access-control-list-acl-in-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/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

B2B Organizations

[Bulk Import Buyer Organizations Spreadsheet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/bulk-import-buyer-organizations-spreadsheet)

[How to configure tradeName to use in the organization search field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)

[Enabling an access control list ACL in B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/enabling-an-access-control-list-acl-in-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/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides)

B2B Suite

B2B Organizations

[How to configure tradeName to use in the organization search field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)

How to configure tradeName to use in the organization search field

The `tradeName` field is used to identify buyer and supplier companies on the platform. When configured as `Filterable`, the field allows users to filter data and search for companies based on their trade name. The `tradeName` is displayed as one of the identification attributes on the **Organizations** page in the VTEX Admin, enabling its use in record search and filtering.

To configure the `tradeName` field, follow the steps below:

1. In VTEX Admin, go to **Store Settings** \> **Storefront** \> **Master Data**.

![{"base64":"  ","img":{"width":1852,"height":959,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":117893,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata1.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata1.png)

1. After logging in, click **Advanced settings** as shown in the image below.

![{"base64":"  ","img":{"width":1585,"height":962,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":36630,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata2.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata2.png)

1. In the Settings column, click on Data structure.

![{"base64":"  ","img":{"width":1521,"height":958,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":33193,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata3.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata3.png)

1. Click **Data Entities**, find the CL row, and click the **Edit** button as shown in the image below.

![{"base64":"  ","img":{"width":1534,"height":932,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":27407,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata4a.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata4a.png)

![{"base64":"  ","img":{"width":1549,"height":680,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":154126,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata4b.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata4b.png)

1. Find the **tradeName** field and click `Is filterable`.

![{"base64":"  ","img":{"width":1639,"height":1978,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":199119,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata5.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata5.png)

1. Click **Save**.

![{"base64":"  ","img":{"width":337,"height":169,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":6270,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata6.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata6.png)

1. Click the **Publish** button to apply the changes

![{"base64":"  ","img":{"width":1366,"height":621,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":155574,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata7.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/B2B-Suite/settings/masterdata7.png)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F136460310%3Fv%3D4%26w=64%26q=75)](https://github.com/geisecosta)

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/B2B-Suite/settings/how-to-configure-tradename-to-use-in-the-organization-search-field.md)

[Bulk Import Buyer Organizations Spreadsheet« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field//docs/guides/bulk-import-buyer-organizations-spreadsheet)[Enabling an access control list ACL in B2B SuiteNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field//docs/guides/enabling-an-access-control-list-acl-in-b2b-suite)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F136460310%3Fv%3D4%26w=64%26q=75)](https://github.com/geisecosta)

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/B2B-Suite/settings/how-to-configure-tradename-to-use-in-the-organization-search-field.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=)