[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 adding payment information to the 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/adding-payment-information-to-the-cart/docs/guides)

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

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

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

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-api-overview)

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

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-security)

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

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/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/adding-payment-information-to-the-cart/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/adding-payment-information-to-the-cart/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/adding-payment-information-to-the-cart/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/adding-payment-information-to-the-cart/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/adding-payment-information-to-the-cart/docs/guides/add-marketing-information-to-the-cart)

[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-cart-items)

[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/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/adding-payment-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-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/adding-payment-information-to-the-cart/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-api-overview)

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

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-security)

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

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/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/adding-payment-information-to-the-cart/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/adding-payment-information-to-the-cart/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/adding-payment-information-to-the-cart/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/adding-payment-information-to-the-cart/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/adding-payment-information-to-the-cart/docs/guides/add-marketing-information-to-the-cart)

[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-cart-items)

[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/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/adding-payment-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-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/adding-payment-information-to-the-cart/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides)

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-api-overview)

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

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

Adding payment information to the cart

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

This guide will describe how to add payment information to the shopping cart via API.

> The payment information attached to the shopping cart does not determine the final order payment method. However, it allows the platform to update any relevant information that might be affected by the payment method.

## Getting shopping cart information

The first step is to get the `orderFormId` of the shopping cart to which you want to add the payment information. For more information, read the [Getting cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/get-cart-information-by-id) guide.

## Adding payment information to the shopping cart

To add payment information to the shopping cart, you need to use the [Add payment data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/attachments/paymentData) endpoint. In this request, you must send the `orderFormId` through the URL address, as in the example below:

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

Additionally, you must send the request body containing the following payment information:

* `paymentSystem`: Payment system ID.
* `paymentSystemName`: Payment system name.
* `group`: Payment system group.
* `installments`: Number of installments.
* `installmentsInterestRate`: Installment interest rate.
* `installmentsValue`: Amount of each installment.
* `value`: Total payment amount.
* `referenceValue`: Base value used to calculate total order amount with interest.
* `hasDefaultBillingAddress`: Indicates whether the billing address for this order is the default address.

See a request body example below:

`1

{

2

 "payments": [

3

 {

4

 "paymentSysytem": 1,

5

 "paymentSystemName": "Boleto Bancário",

6

 "group": "bankInvoicePaymentGroup",

7

 "installments": 3,

8

 "installmentsInterestRate": 0,

9

 "installmentsValue": 100,

10

 "value": 300,

11

 "referenceValue": 300,

12

 "hasDefaultBillingAddress": false

13

 }

14

 ]

15

}

`

If you are using a gift card as a payment method, the request body can be similar to this:

`1

{

2

 "giftCards": [

3

 {

4

 "redemptionCode": "480030010012333619",

5

 "provider": "CartaoPresente",

6

 "value": 15289,

7

 "balance": 100000,

8

 "name": null,

9

 "caption": null,

10

 "id": "480030010012333619",

11

 "inUse": true,

12

 "isSpecialCard": false,

13

 "groupName": null

14

 }

15

 ]

16

}

`

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

`1

...

2

"paymentData": {

3

 "updateStatus": "updated",

4

 "installmentOptions": [

5

 {

6

 "paymentSystem": "1",

7

 "bin": null,

8

 "paymentName": "Boleto Bancário",

9

 "paymentGroupName": "bankInvoicePaymentGroup",

10

 "value": 300,

11

 "installments": [

12

 {

13

 "count": 3,

14

 "hasInterestRate": false,

15

 "interestRate": 0,

16

 "value": 300,

17

 "total": 300,

18

 "sellerMerchantInstallments": [

19

 {

20

 "id": "COSMETICS2",

21

 "count": 3,

22

 "hasInterestRate": false,

23

 "interestRate": 0,

24

 "value": 300,

25

 "total": 300

26

 }

27

 ]

28

 }

29

 ]

30

 }

31

...

`

>  For more information on the meaning of each field available in the shopping cart, see the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.

## Error codes

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

### 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

}

`

* **Message error example (code ORD020)**: `"Invalid payment"`. The `referenceValue` information has not been sent. \[block:code\]

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "ORD020",

5

 "message": "Invalid payment",

6

 "exception": null

7

 },

8

 "operationId": "9d14e7af-a63d-4c26-8974-bad734b758da"

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

3

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

[Add cart items« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart//docs/guides/add-cart-items)[Adding merchant context information to the cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart//docs/guides/add-merchant-context-information-to-the-cart)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-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/adding-payment-information-to-the-cart/_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/adding-payment-information-to-the-cart/_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 shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23getting-shopping-cart-information)

[Adding payment information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23adding-payment-information-to-the-shopping-cart)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23error-codes)

[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%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/adding-payment-information-to-the-cart.md)

Copy page

On this page

ON THIS PAGE

[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23getting-shopping-cart-information)

[Adding payment information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23adding-payment-information-to-the-shopping-cart)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23error-codes)

[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%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 consult store search terms information 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/consult-store-search-terms-information/docs/guides)

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

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

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

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/how-search-parameters-work)

[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/search-control-fulltextsearchbox)

[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information)

[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-product-search-information)

[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/get-banner-list-for-a-specific-search)

[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)

[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/vtex-io-documentation-segmenting-the-search-result)

[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/access-control-list)

[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/delivery-promise-for-headless-stores)

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/how-search-parameters-work)

[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/search-control-fulltextsearchbox)

[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information)

[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-product-search-information)

[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/get-banner-list-for-a-specific-search)

[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)

[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/vtex-io-documentation-segmenting-the-search-result)

[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/access-control-list)

[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/delivery-promise-for-headless-stores)

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides)

Search

[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information)

Improving product discovery with autocomplete suggestions and search insights

To deliver relevant search results to your store's shoppers, it's essential to understand how they search for products in your store. The [Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23overview) offers powerful insights into [popular search terms](#get-the-most-searched-terms) and [autocomplete suggestions](#get-autocomplete-suggested-terms-and-similar-attributes). The sections below outline how to use these tools to optimize your store's search experience.

## Retrieving the most searched terms

To get your customers' most searched terms, use the [Get list of the 10 most searched terms](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/get%5Ftop-searches) endpoint. This endpoint allows you to filter results by specifying a `locale` in the query parameters.

The response will return the most searched terms in order of popularity along with the number of searches:

![{"base64":"  ","img":{"width":1342,"height":640,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":188854,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/consult-store-search-terms-information-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/consult-store-search-terms-information-0.png)

### Response body example

`1

{

2

 "searches": [

3

 {

4

 "term": "home",

5

 "count": 14

6

 },

7

 {

8

 "term": "shirt",

9

 "count": 10

10

 },

11

 {

12

 "term": "top",

13

 "count": 9

14

 },

15

 {

16

 "term": "tops",

17

 "count": 6

18

 },

19

 {

20

 "term": "camera",

21

 "count": 5

22

 },

23

 {

24

 "term": "kit",

25

 "count": 5

26

 },

27

 {

28

 "term": "work shirt",

29

 "count": 2

30

 },

31

 {

32

 "term": "shirts",

33

 "count": 2

34

 },

35

 {

36

 "term": "clothing",

37

 "count": 2

38

 },

39

 {

40

 "term": "classic shoes",

41

 "count": 1

42

 }

43

 ]

44

}

`

## Retrieving autocomplete suggested terms and similar attributes

To gather data on [autocomplete suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete) and similar attributes, use the [Get list of suggested terms and attributes similar to the search term](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/get%5Fautocomplete-suggestions) endpoint. You can refine the response by defining the `locale` and `query` parameters.

The response will return the searched terms by popularity order and the corresponding autocomplete suggestions for each term.

![{"base64":"  ","img":{"width":1358,"height":692,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":340366,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/consult-store-search-terms-information-1.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/consult-store-search-terms-information-1.png)

### Response body example

`1

{

2

 "searches": [

3

 {

4

 "term": "tv",

5

 "count": 28861,

6

 "attributes": [

7

 {

8

 "key": "departamento",

9

 "value": "tvs-e-video",

10

 "labelKey": "Departamento",

11

 "labelValue": "TVs e Vídeo"

12

 },

13

 {

14

 "key": "categoria",

15

 "value": "tvs",

16

 "labelKey": "Categoria",

17

 "labelValue": "TVs"

18

 },

19

 {

20

 "key": "subcategoria",

21

 "value": "receptor-de-controle-de-acesso",

22

 "labelKey": "Subcategoria",

23

 "labelValue": "Receptor de Controle de Acesso"

24

 }

25

 ]

26

 },

27

 {

28

 "term": "smarth tv",

29

 "count": 2308

30

 },

31

 {

32

 "term": "painel para tv",

33

 "count": 975

34

 },

35

 {

36

 "term": "rack tv",

37

 "count": 589

38

 }

39

 ]

40

}

`

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/_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/Search/consult-store-search-terms-information.md)

[Search Control – fulltextSearchBox« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information//docs/guides/search-control-fulltextsearchbox)[Consult product search informationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information//docs/guides/consult-product-search-information)

Contributors

1

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

ON THIS PAGE

[Retrieving the most searched terms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23retrieving-the-most-searched-terms)

[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23response-body-example)

[Retrieving autocomplete suggested terms and similar attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23retrieving-autocomplete-suggested-terms-and-similar-attributes)

[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23response-body-example)

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/Search/consult-store-search-terms-information.md)

Copy page

On this page

ON THIS PAGE

[Retrieving the most searched terms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23retrieving-the-most-searched-terms)

[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23response-body-example)

[Retrieving autocomplete suggested terms and similar attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23retrieving-autocomplete-suggested-terms-and-similar-attributes)

[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23response-body-example)

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 service path patterns 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/service-path-patterns/docs/guides)

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

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

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

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/app-development-guides)

[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-service)

[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/calling-commerce-apis-on-vtex-io)

[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-clients)

Handling events

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns)

[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/configuring-dynamic-routes-in-vtex-io-services)

[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-developing-service-configuration-apps)

[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/node-builder-7x-migration-guide)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides)

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

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

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

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/troubleshooting)

---

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

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/app-development-guides)

[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-service)

[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/calling-commerce-apis-on-vtex-io)

[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-clients)

Handling events

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns)

[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/configuring-dynamic-routes-in-vtex-io-services)

[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-developing-service-configuration-apps)

[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/node-builder-7x-migration-guide)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

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

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/app-development-guides)

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns)

Service path patterns

Learn how to define the path for your VTEX IO service route to manage caching and session data effectively.

When developing a new [VTEX IO service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service), you must define a proper path for your service to handle requests effectively. This guide provides insights into service path patterns, outlining the recommended approaches based on the desired behavior.

Paths are specified within the `service.json` file. Check the following example:

service.json

`1

{

2

 "memory": 256,

3

 "ttl": 10,

4

 "timeout": 2,

5

 "minReplicas": 2,

6

 "maxReplicas": 4,

7

 "routes": {

8

 "status": {

9

 "path": "/_v/status/:code",

10

 "public": true

11

 }

12

 }

13

}

`

For more information on developing service apps, refer to [Developing services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io).

## Path patterns

There are three possible path formats, each influencing the behavior of your service.

Let's delve into these patterns using an illustrative example of implementing the service `/examplepath/123`. You can change how VTEX handles requests to this service by appending `/_v/segment` or `/_v/private` to the beginning of your path. This means you have three possible paths in this example:

* **Public:** `/examplepath/123`
* **Segment dependent:** `/_v/segment/examplepath/123`
* **Private:** `/_v/private/examplepath/123`

VTEX has an edge layer that handles all requests to the platform, including those related to VTEX IO apps. Given this architecture, each of these possible paths is handled differently in terms of caching and cookie management. Refer to the [Sessions System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview) guide to learn more about how VTEX handles cookies.

Check the table below for a comprehensive overview of the behavior of different path patterns:

| **Path type**     | **Pattern**             | **Cookies behavior**                                                                                | **Caching behavior**                                                       | **Example use case**                                                                                |
| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Public            | {yourPath}              | No guarantee that the app will receive the cookies from the request.                                                                                | VTEX edge will cache the service's response whenever possible.             | Retrieving information that does not vary according to user or segment, such as product images.                                                  |
| Segment dependent | /\_v/segment/{yourPath} | The app will receive the [vtex\_segment cookie](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview%23cookie-vtexsegment)                                                                                | VTEX edge will cache the service's response based on the received segment. | Retrieving information that may change depending on the segment. For instance, applying promotions according to the shopper's selected currency. |
| Private           | /\_v/private/{yourPath} | The app will receive both the [vtex\_segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview%23cookie-vtexsegment) and [vtex\_session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview%23cookie-vtexsession) cookies. | VTEX will not cache the service's response.                                | Retrieving information depending on the shopper's identity or session, such as the shopper's order history or registered address.                |

## Troubleshooting

### Unavailable cookies with CloudFront CDN

If your store uses CloudFront as a CDN and you encounter difficulties in obtaining the expected cookies from the app’s service context, [open a ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) with the VTEX support team to report the issue.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/_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/vtex-io/Getting-Started/back-end-development-guides/service-path-patterns.md)

[Receiving Order Notifications« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns//docs/guides/how-to-receive-order-notifications-on-vtex-io)[Configuring dynamic routes in VTEX IO servicesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns//docs/guides/configuring-dynamic-routes-in-vtex-io-services)

Contributors

1

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

ON THIS PAGE

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns%23path-patterns)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns%23troubleshooting)

[Unavailable cookies with CloudFront CDN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns%23unavailable-cookies-with-cloudfront-cdn)

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/vtex-io/Getting-Started/back-end-development-guides/service-path-patterns.md)

Copy page

On this page

ON THIS PAGE

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns%23path-patterns)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns%23troubleshooting)

[Unavailable cookies with CloudFront CDN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns%23unavailable-cookies-with-cloudfront-cdn)

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] How do I use the VTEX store components 3.178.5 ProductSpecifications app? Provide documentation and configuration details.

[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/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/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/apps/vtex.store-components@3.178.5/ProductSpecifications/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/guides/vtex-io-deprecated-apps)

---

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/vtex-io-apps)

Product Specifications

[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)

Version: 3.178.5

Latest version: 3.178.5

![{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAABCAIAAAB2XpiaAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAFUlEQVR4nGNoYGD6v3v+/6ask37WACanBhm9KoMJAAAAAElFTkSuQmCC","img":{"src":"https://img.shields.io/badge/-Deprecated-red","width":73,"height":20,"type":"svg"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/-Deprecated-red)

> Warning
>
> **The Product Specifications block has been deprecated in favor of the [Product Specifications app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-specifications/).** Although support for this block is still granted, we strongly recommend you to update your store theme with the Product Specification's blocks in order to keep up with the component's evolution.

The `product-specifications` block shows the technical [specifications](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-are-fields-or-specifications--2lB4AgibEseceMggKE2k2m) of a product.

![{"base64":"  ","img":{"width":1265,"height":367,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":72299,"url":"https://user-images.githubusercontent.com/27777263/71525823-4bd8a380-28b2-11ea-8d5c-7678426ec1ab.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/27777263/71525823-4bd8a380-28b2-11ea-8d5c-7678426ec1ab.png)

## Configuration

1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:

`1

 "dependencies": {

2

 "vtex.store-components": "3.x"

3

 }

`

1. Add the `product-specifications` block to any child of the `store.product` template (Product Details Page template). For example:

`1

 "store.product": {

2

 "children": [

3

 "flex-layout.row#product",

4

 ]

5

 },

6

 "flex-layout.row#product": {

7

 "children": [

8

+ "product-specifications#product"

9

 ]

10

 },

`

1. Then, declare the `product-specifications` block using the props stated in the [Props](#props) table. For example:

`1

 "product-specifications#product": {

2

 "props": {

3

 "shoudCollapseOnTabChange": true,

4

 "collapsible": "desktopOnly"

5

 }

6

 },

`

### Props

| Prop name                 | Type                                 | Description                                                                                | Default value |
| ------------------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------- | ------------- |
| collapsible               | mobileOnly\|desktopOnly|always|never | Defines when the content of the specifications should be collapsed.                                            | always        |
| hiddenSpecifications      | String\[\]                           | Name of the specifications to be hidden.                                                                       | \[\]          |
| shouldCollapseOnTabChange | Boolean                              | If it should collapse if you change the tab.                                                                   | false         |
| showSpecificationsTab     | Boolean                              | Shows the component in the tabs mode if true.                                                                  | false         |
| visibleSpecifications     | String\[\]                           | Name of the specifications to be presented. Only provide one of hiddenSpecifications or visibleSpecifications. | \[\]          |

## Customization

To apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.

| CSS Handles                                                           |
| --------------------------------------------------------------------- |
| specificationItemProperty\[data-specification="{specificationName}"\] |
| specificationItemSpecifications                                       |
| specificationsTab                                                     |
| specificationsTable                                                   |
| specificationsTableBody                                               |
| specificationsTableContainer                                          |
| specificationsTableHead                                               |
| specificationsTablePropertyHeading                                    |
| specificationsTableSpecificationHeading                               |
| specificationsTableRow                                                |
| specificationsTabsContainer                                           |
| specificationsTitle                                                   |

See also

[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/apps/vtex.store-components@3.178.5/ProductSpecifications%23configuration)

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/apps/vtex.store-components@3.178.5/ProductSpecifications%23props)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/apps/vtex.store-components@3.178.5/ProductSpecifications%23customization)

Was this helpful?

[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 authentication 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/authentication/docs/guides)

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

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

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

Guides

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

---

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

[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/getting-started-list-of-rest-apis)

[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/making-your-first-request)

[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication)

[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-authentication-using-api-keys)

[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/rotating-vtex-api-tokens)

[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/app-authentication-using-auth-tokens)

[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-authentication-using-user-tokens)

[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/checking-which-user-is-currently-authenticated)

[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/expiring-a-shoppers-password)

[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/refresh-token-flow-for-headless-implementations)

[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-response-codes)

Error handling and best practices

---

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

---

Integration Guides

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/getting-started-list-of-rest-apis)

[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/making-your-first-request)

[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication)

[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-authentication-using-api-keys)

[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/rotating-vtex-api-tokens)

[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/app-authentication-using-auth-tokens)

[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-authentication-using-user-tokens)

[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/checking-which-user-is-currently-authenticated)

[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/expiring-a-shoppers-password)

[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/refresh-token-flow-for-headless-implementations)

[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-response-codes)

Error handling and best practices

---

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

---

Integration Guides

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication)

Authentication

Authentication is a crucial aspect of API integrations, backend, and frontend app development. It ensures authorized access by requiring valid credentials like API keys or tokens. This shields sensitive data, prevents breaches, and builds user trust. Get started with VTEX authentication for developers with the following guides:

* [API authentication using application keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)
* [API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens)
* [App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens)

There are different contexts in which authentication is required in the regular functioning of a VTEX store. Below are some example use cases and the recommended authentication methods.

| **Use case**                              | **Indicated authentication methods**                                                                                |
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Backend VTEX IO app                       | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) via VTEX IO context, or, if needed, [app authentication token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens) via VTEX IO context |
| Frontend VTEX IO app                      | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) via VTEX IO context                                                                                |
| Self-hosted backend request to VTEX APIs  | [Application keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)                                                                                |
| Self-hosted frontend request to VTEX APIs | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens)                                                                                |

## Single sign on integrations

VTEX allows stores to integrate with external identity providers to provide single sign on (SSO) experiences to shoppers and Administrative users. You can learn more about this in the article [Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/login-integration-guide) and below you can find more information on these and other SSO use cases:

* [Store SSO with OAuth 2.0](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-webstore-oauth2)
* [Admin SSO with SAML 2.0](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2)
* [Use your VTEX account as an OAuth provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x)

## Learn more

* **Authorization**: [Users](https://read.calvincode.net/reader?url=https://help.vtex.com/en/subcategory/users--63DHe3VQEEE6Uuua8gIs2M), [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) and [License Manager Resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3)
* **Auditability**: [Audit](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/searching-for-events-on-audit--5RXf9WJ5YLFBcS8q8KcxTA)

Contributors

2

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

[Making your first request« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication//docs/guides/making-your-first-request)[API authentication using API keysNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication//docs/guides/api-authentication-using-api-keys)

See also

[API authentication using API keysGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-authentication-using-api-keys)[API authentication using user tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-authentication-using-user-tokens)[App authentication using auth tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/app-authentication-using-auth-tokens)

Contributors

2

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

ON THIS PAGE

[Single sign on integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication%23single-sign-on-integrations)

[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication%23learn-more)

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/Getting-Started/authentication/authentication.md)

Copy page

On this page

ON THIS PAGE

[Single sign on integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication%23single-sign-on-integrations)

[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication%23learn-more)

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=)