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

[User] Explain troubleshooting i am getting 500 errors in vtex io cli in VTEX.

[Assistant]
Documentation

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

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/updates/release-notes)

Troubleshooting

API

---

Development

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

[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)

[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)

[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/unable-to-access-headless-cms)

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

[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-cant-install-vtex-io-cli)

[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-cant-integrate-my-external-search-provider)

[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)

[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)

[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)

[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)

[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)

[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)

[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)

[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)

[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-cant-create-a-new-workspace)

[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)

[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-dont-see-my-store-theme-changes)

---

Store performance

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/updates/release-notes)

Troubleshooting

API

---

Development

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

[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)

[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)

[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/unable-to-access-headless-cms)

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

[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-cant-install-vtex-io-cli)

[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-cant-integrate-my-external-search-provider)

[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)

[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)

[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)

[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)

[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)

[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)

[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)

[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)

[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-cant-create-a-new-workspace)

[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)

[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-dont-see-my-store-theme-changes)

---

Store performance

---

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting)

Development

I am getting 500 errors in VTEX IO CLI

Running VTEX IO CLI commands returns a 500 internal server error

When running VTEX IO CLI commands, e.g., `vtex link`, the following message may be displayed in the terminal:

`1

error: API: 500 Internal Server Error

`

This means an internal error occurred, and VTEX is working to fix it.

## Solution

No action is required from the user to fix the error. Below are some recommended instructions you can use in this situation:

* Try running the command again
* Check the VTEX Status page
* Contact VTEX Support

### Try running the command again

Wait some time and try running the command again to check if the error was fixed.

### Check the VTEX Status page

If the error is related to a platform incident, it will be published on the [VTEX Status page](https://read.calvincode.net/reader?url=https://status.vtex.com/).

### Contact VTEX Support

If the error persists after some time, contact [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7026595%3Fv%3D4%26w=64%26q=75)](https://github.com/henriquessb)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-am-getting-500-errors-in-vtex-io-cli.md)

[I can't update the EAN of my SKUs via API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api)[I am getting errors with my service configuration appNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7026595%3Fv%3D4%26w=64%26q=75)](https://github.com/henriquessb)

ON THIS PAGE

[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli%23solution)

[Try running the command again](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli%23try-running-the-command-again)[Check the VTEX Status page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli%23check-the-vtex-status-page)[Contact VTEX Support](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli%23contact-vtex-support)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-am-getting-500-errors-in-vtex-io-cli.md)

Copy page

On this page

ON THIS PAGE

[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli%23solution)

[Try running the command again](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli%23try-running-the-command-again)[Check the VTEX Status page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli%23check-the-vtex-status-page)[Contact VTEX Support](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli%23contact-vtex-support)

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 add shipping address and delivery option 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/add-shipping-address-and-delivery-option-to-the-cart/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-to-the-cart/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides)

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/checkout-api-overview)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)

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

Adding shipping address and delivery options 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 shipping address and delivery options to the shopping cart via API.

## Getting shopping cart information

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

## Adding a shipping address to the shopping cart

To add a shipping address to the shopping cart, you need to use the [Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addshippingaddress) endpoint. In this request, you must send the `orderFormId` through the URL address, as in the example below:

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

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

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

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

`1

...

2

"shippingData": {

3

 "address": {

4

 "addressType": "residential",

5

 "receiverName": "receiver-name",

6

 "addressId": "c1333270f408494c88858ddc8b3de07e",

7

 "isDisposable": true,

8

 "postalCode": "12345-000",

9

 "city": "Rio de Janeiro",

10

 "state": "RJ",

11

 "country": "BRA",

12

 "street": "Praia de Botafogo",

13

 "number": "300",

14

 "neighborhood": "Botafogo",

15

 "complement": "3rd floor",

16

 "reference": "Grey building",

17

 "geoCoordinates": [

18

 -47.924747467041016,

19

 -15.832582473754883

20

 ]

21

 },

22

...

`

>  For more information on 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.

## Adding a delivery option to the shopping cart

To add a delivery option to the shopping cart, you must add a shipping address (following the [previous section](#adding-a-shipping-address-to-the-shopping-cart)), and use the same [Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addshippingaddress) endpoint. However, you need to send the request body with the `logisticsInfo` array containing the following information:

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

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

`1

...

2

"logisticsInfo": [

3

 {

4

 "itemIndex": 0,

5

 "selectedSla": "normal",

6

 "selectedDeliveryChannel": "delivery",

7

 "addressId": "954ee939c1274633bfb7a5af4d6c642d",

8

 "slas": [],

9

 "shipsTo": [

10

 "BRA"

11

 ],

12

 "itemId": "5",

13

 "deliveryChannels": [

14

 {

15

 "id": "delivery"

16

 }

17

 ]

18

 },

19

...

`

## Error codes

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

### 400 - Bad Request

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

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "ORD001",

5

 "message": "The CEP (12340) field in the shipping attachment is invalid",

6

 "exception": null

7

 },

8

 "operationId": "37fcbaf6-9245-46b2-8735-f5fb304d1ac2"

9

}

`

* **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 ORD015)**: `"Unable to communicate with seller VTEX- Test International"`: This message indicates that the `geoCoordinates` used in the request do not exist or are incorrect.

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "ORD015",

5

 "message": "Unable to communicate with seller VTEX- Test International",

6

 "exception": null

7

 },

8

 "operationId": "37fcbaf6-9245-46b2-8735-f5fb304d1ac2"

9

}

`

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

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "ORD026",

5

 "message": "A communication error with Postal Code Service has occurred",

6

 "exception": null

7

 },

8

 "operationId": "37fcbaf6-9245-46b2-8735-f5fb304d1ac2"

9

}

`

* **Message error example (code CHK0041)**: `"Invalid item index"`: This message indicates that the `itemIndex` used in the request does not exist or is incorrect.

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "CHK0041",

5

 "message": "Invalid item index",

6

 "exception": null

7

 },

8

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

9

}

`

### 404 - Not Found

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

`1

<body>

2

 <h1>404 Not Found</h1>

3

 <p>The requested URL was not found on this server.</p>

4

</body>

`

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-to-the-cart/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F106821144%3Fv%3D4%26w=64%26q=75)](https://github.com/GeorgeLimaDev)

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

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/cart-attachments-section-quick-start-guides/add-shipping-address-and-delivery-option-to-the-cart.md)

[Adding customer profile information to the cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart//docs/guides/add-customer-profile-information-to-the-cart)[Adding customer preferences to the cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart//docs/guides/add-customer-preferences-to-the-cart)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-to-the-cart/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F106821144%3Fv%3D4%26w=64%26q=75)](https://github.com/GeorgeLimaDev)

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

ON THIS PAGE

[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart%23getting-shopping-cart-information)

[Adding a shipping address to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart%23adding-a-shipping-address-to-the-shopping-cart)

[Adding a delivery option to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart%23adding-a-delivery-option-to-the-shopping-cart)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart%23error-codes)

[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-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/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart%23getting-shopping-cart-information)

[Adding a shipping address to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart%23adding-a-shipping-address-to-the-shopping-cart)

[Adding a delivery option to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart%23adding-a-delivery-option-to-the-shopping-cart)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart%23error-codes)

[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-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] How do I use the VTEX connector paypal commerce platform 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.connector-paypal-commerce-platform/docs/guides)

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

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

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

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/advanced-components)

[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.availability-notify)

[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.category-menu)

[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtexbr.kitlook)

[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-icons/iconpack)

[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.iframe)

[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtexventures.livestreaming)

[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.connector-paypal-commerce-platform)

[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtexventures.personal-shopper-free)

[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.product-availability)

[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.product-comparison)

[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.product-gifts)

[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtexarg.product-highlight-by-vtex-segment)

[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.product-specification-badges)

[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtexarg.quantity-on-cart)

[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.reviews-and-ratings)

[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.safedata)

[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.seller-selector)

[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.similar-products-variants)

[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-drawer)

[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-locator)

[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-form)

[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-link)

[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-media)

[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-newsletter)

[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-video)

[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.sandbox)

[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.shipping-option-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/storefront-development)

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/advanced-components)

[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.availability-notify)

[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.category-menu)

[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtexbr.kitlook)

[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-icons/iconpack)

[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.iframe)

[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtexventures.livestreaming)

[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.connector-paypal-commerce-platform)

[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtexventures.personal-shopper-free)

[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.product-availability)

[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.product-comparison)

[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.product-gifts)

[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtexarg.product-highlight-by-vtex-segment)

[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.product-specification-badges)

[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtexarg.quantity-on-cart)

[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.reviews-and-ratings)

[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.safedata)

[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.seller-selector)

[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.similar-products-variants)

[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-drawer)

[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-locator)

[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-form)

[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-link)

[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-media)

[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-newsletter)

[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.store-video)

[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.sandbox)

[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.shipping-option-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/vtex-io-deprecated-apps)

---

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

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/guides/advanced-components)

PayPal Checkout with Smart Payment Buttons

Official extension

Version: 0.17.2

Latest version: 0.17.2

[![{"base64":"  ","img":{"width":110,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)

An app integrating PayPal Checkout with Smart Payment Buttons with a VTEX IO store. This allows a store to place PayPal's Smart Buttons in the VTEX cart, offering a quick checkout via the familiar PayPal experience. The app also makes PayPal available within VTEX's native checkout. This app utilizes VTEX's Payment Provider Framework SDK.

> _Because they allow a user to skip the normal VTEX checkout, the Smart Buttons cannot be used in combination with gift cards or other split payment methods._

> _Please reference [PayPal's documentation in regard to supported currencies](https://read.calvincode.net/reader?url=https://developer.paypal.com/reference/currency-codes/)._

> _For best results, we recommend [configuring your PayPal account to obtain the buyer's phone number during checkout](https://read.calvincode.net/reader?url=https://developer.paypal.com/api/nvp-soap/paypal-payments-standard/admin/checkout-settings/%23get-contact-telephone-numbers)._

## Features

* Adds PayPal's [Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developer.paypal.com/docs/checkout/) to your store's cart page, allowing users to place orders using PayPal's checkout experience instead of the standard VTEX checkout
* Also allows the user to use PayPal as a payment method in the standard VTEX checkout
* Allows the VTEX Payment Gateway's auto-settle behavior to be configured or disabled
* Allows PayPal Credit ("Pay Later") messaging to be displayed on the PDP and in product shelves

## Configuration

### Installation & Onboarding

> _Only users with access to the **Payments** section in the VTEX admin (or assigned the **PCI Gateway** role in License Manager) will be able to configure the app._

1. Install this app from the [VTEX App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-connector-paypal-commerce-platform/p) by clicking `Get App`.
2. In your VTEX admin dashboard, go to `Payments > PayPal`.
3. Confirm your PayPal account email address. If you don't already have a PayPal account, you will be walked through the steps to create one. If you want to use an email other than your VTEX account's email address, click the `Change` button. Clicking `Change` will also allow you to toggle into `Sandbox Mode` for testing purposes. (Note: If you onboard in Sandbox Mode, you will eventually need to disconnect your sandbox account and perform the onboarding again with a production PayPal account when you are ready to accept live payments.)
4. Click `Connect` and follow PayPal's prompts to complete the onboarding. This process will grant VTEX permission to process PayPal transactions on your behalf.
5. When onboarding is complete, you should be returned to the VTEX admin dashboard, where you will see a PayPal Account Status page. You can also return to this page by going to `Payments > PayPal` from the VTEX admin sidebar. On this page, if you see the message `You are ready to accept PayPal payments in checkout!`, you may proceed to the next step. If not, the page will list the necessary actions to be completed before you are able to accept payments.

### Payment Gateway Configuration

1. In your VTEX admin dashboard, go to `Payments > Settings`.
2. Click the `Gateway Affiliations` tab at the top of the screen, and then the green + button in the upper right corner to create a new Gateway Affiliation.
   * Choose `PayPalCP` from the list of connectors.
   * Enter a name of your choice for the affiliation.
   * If the Test/Live toggle is set to Test mode, a `workspace` input field will appear, allowing you to test the PayPal app in a workspace other than `master`. Note that you may need to save the affiliation and then edit it again before the field will appear. After testing is complete, make sure to set this back to `master`. Do not erase the contents of this field.
   * `Application Key` and `Application Token` should be left blank.
   * The `Payment Capture` dropdown allows you to control (or disable) VTEX's auto-settle behavior. If you choose the default `Use Behavior Recommended By The Payment Processor` option, payments will be automatically settled 24 hours after authorization.
   * If the `Deactivated: Not Automatically Captured` option is chosen, the payment will be captured at the moment the Order associated with that payment is `invoiced`.
   * After configuring the above options, click `Save`.
3. ⚠ **Important note**: Completing the next step (step 10) will cause a new payment option to appear in your store's checkout. Do not complete this step until you are ready to begin accepting PayPal orders. Alternatively, consider making the Payment Condition active only for an employees-only sales channel so that the payment method can be tested prior to going live.
4. Return to `Payments > Settings` and click the `Payment Conditions` tab at the top of the screen, and then the green + button in the upper right corner to create a new Payment Condition. Choose `PayPalCP` from the list of payment methods. Verify that the condition is set to process with the affiliation that you named in step 8 and that the toggle is set to `Active`. Click `Save`.

### PayPal Smart Payment Buttons Configuration

1. Run the following command in the VTEX CLI: `vtex install vtex.paypalcp-checkout-ui-settings`
   * This step is optional if you do not wish to display the Smart Payment Buttons on the VTEX checkout's shopping cart page.
   * This will install a secondary app that will inject the necessary scripts into the VTEX checkout environment. Note that the buttons will not yet appear in checkout until the following steps are completed.
2. In your VTEX admin dashboard, return to `Payments > PayPal`.
3. In the PayPal Settings section, adjust the Smart Payment Buttons layout and appearance settings as desired.
   * You may also disable the PayPal Credit "Pay Later" button here, if desired. If you are not in a region where PayPal Credit is available, this setting will have no effect.
   * Similarly, you may disable the "Debit or Credit Card" smart button here, if desired. This button is related to PayPal's Guest Checkout feature.
   * If an ERP or other external system is directly integrated with PayPal to perform settlements and refunds, the "Disable Settlement and Refund" toggle can be activated which will cause the connector to ignore settlement and refund requests coming from the VTEX Payment Gateway.
   * You may also enable Immediate Capture here, if desired. If enabled, PayPal payments will be captured immediately at time of checkout. Behind the scenes, the PayPal order is created using `intent: 'CAPTURE'` rather than `intent: 'AUTHORIZE'`. This setting must be enabled if you are a merchant located in Brazil or Mexico and wish to offer PayPal payments in installments.
4. If you are ready to enable the Smart Payment Buttons for your store users, activate the `Show PayPal Buttons` toggle and click `Save`.
5. The PayPal Smart Payment Buttons will now appear on the Cart page within checkout, directly below the standard `Checkout` button (and, if using [Customization](#customization), wherever the block has been placed).

### PayPal Additional App Configurations

* **Enable Pickup in Store via Smart Buttons** \- Choose whether to allow shoppers to select from your store pickup options when checking out via the Smart Buttons. Note that only the pickup point's name will be displayed in PayPal's UI, so make sure that your pickup points have descriptive names in VTEX before enabling. Shoppers will be able to see the full pickup address after placing the order.
* **Invoice ID** \- Choose which value to use as the `invoice_id` in PayPal orders. Default is set to VTEX order sequence (reference) number.
* **Custom ID** \- Choose which value to use as the `custom_id` in PayPal orders. Default is set to VTEX order ID.

### PayPal Credit Promotional Messaging

To display [PayPal Credit promotional messaging](https://read.calvincode.net/reader?url=https://www.paypal.com/merchantapps/appcenter/accelerategrowth/paylatermessaging?locale.x=en%5FUS) on your PDP and/or product shelves, simply modify your store-theme to place the `product-installments` block in the desired location. This block is provided by the core [Product Price](https://read.calvincode.net/reader?url=https://vtex.io/docs/app/vtex.product-price) app, so no change to your store-theme's dependencies should be needed. When the PayPal app is installed in the same account, it will automatically fill the `product-installments` block with PayPal's messaging.

> Note that promotional messaging will not be displayed if you have chosen to disable the PayPal Credit Smart Payment Button, or if the `product-installments` block is not present in your store-theme.

## Customization

If you wish to display the PayPal Smart Payment Buttons in another place in addition to the cart page, such as within the minicart, you may follow these instructions:

1. Install this app in your account (see step 1 of [Installation & Onboarding](#configuration) above).
2. Modify your store-theme's `manifest.json` file to add this app to its `peerDependencies` like so:

`1

"peerDependencies": {

2

 "vtex.connector-paypal-commerce-platform": "0.x"

3

 },

`

1. Modify the JSON within your store-theme's `store` folder to place the block `"one-click-buy.paypal-checkout-button"` in the desired location. The block accepts no props.
2. Continue following the [Installation & Onboarding](#configuration) instructions from step 3.

In order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).

| CSS Handles                    |
| ------------------------------ |
| payPalButtonContainer          |
| payPalErrorModal               |
| payPalProcessingModal          |
| payPalPayLaterMessageContainer |

[Live Shopping« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtexventures.livestreaming)[Personal ShopperNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtexventures.personal-shopper-free)

See also

[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.connector-paypal-commerce-platform%23features)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.connector-paypal-commerce-platform%23configuration)

[Installation & Onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.connector-paypal-commerce-platform%23installation--onboarding)[Payment Gateway Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.connector-paypal-commerce-platform%23payment-gateway-configuration)[PayPal Smart Payment Buttons Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.connector-paypal-commerce-platform%23paypal-smart-payment-buttons-configuration)[PayPal Additional App Configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.connector-paypal-commerce-platform%23paypal-additional-app-configurations)[PayPal Credit Promotional Messaging](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.connector-paypal-commerce-platform%23paypal-credit-promotional-messaging)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.connector-paypal-commerce-platform/docs/apps/vtex.connector-paypal-commerce-platform%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 vtex io documentation 4 configuringyourappsettings 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/vtex-io-documentation-4-configuringyourappsettings/docs/guides)

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

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

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

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/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/vtex-io-documentation-4-configuringyourappsettings/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/vtex-io-documentation-4-configuringyourappsettings/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/vtex-io-documentation-4-configuringyourappsettings/docs/guides/code-samples)

---

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

[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)

[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)

[What is a Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-pixel-app)

[1\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)

[2\. Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)

[3\. Configuring your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-4-configuringyourappsettings)

[4\. Writing the head and body scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts)

[5\. Listening to store events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-6-listeningtostoreevents)

[6\. Structuring the documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-7-structuringthedocumentation)

[7\. Making your Pixel app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)

[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/create-master-data-crud-app)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/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/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/app-development-guides)

---

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

---

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

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/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/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/managing-edition-apps)

---

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

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides)

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

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

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

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/troubleshooting)

---

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

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/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/vtex-io-documentation-4-configuringyourappsettings/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/vtex-io-documentation-4-configuringyourappsettings/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/vtex-io-documentation-4-configuringyourappsettings/docs/guides/code-samples)

---

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

[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)

[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)

[What is a Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-pixel-app)

[1\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)

[2\. Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)

[3\. Configuring your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-4-configuringyourappsettings)

[4\. Writing the head and body scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts)

[5\. Listening to store events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-6-listeningtostoreevents)

[6\. Structuring the documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-7-structuringthedocumentation)

[7\. Making your Pixel app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)

[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/create-master-data-crud-app)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/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/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/app-development-guides)

---

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

---

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

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/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/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/managing-edition-apps)

---

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

---

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

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

[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)

[3\. Configuring your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-4-configuringyourappsettings)

3\. Configuring your app settings

When developing a Pixel app, you must define a way to identify if a VTEX account has the necessary permissions to communicate with the third-party solution in question. Otherwise, sharing data between the store and the solution will not be possible.

This verification is generally performed via a user identification issued by the third-party solution. The user identification is an individual and nontransferable value that identifies if you have the required permissions to use that solution. Think of the Google Tag Manager Pixel app — you must provide a previously issued user identification, in order to use it.

In the following steps, you will learn how to make your Pixel app read the user identification and determine if a user is allowed.

## Instructions

1. Open the `manifest.json` file.
2. Change the `vendor` field value (`vtex`) to the name of the VTEX account in which you are working.
3. Change the `name` and `title` field values with the name you want to give your app. Please see our [app naming guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-filling-the-application-form-for-development/%23guidelines).
4. Declare the `settingsSchema` field. This field will be used to receive the user identification information.
5. Inside the `settingsSchema` object, declare a JSON Schema containing the following fields:
* `title` \- Pixel app name.
* `type` \- JSON Schema type (this must always be completed as `object`).
* `description` _(Optional)_ \- Description of the `settingsSchema` field.
* `properties` \- Key-value pairs that define the user identification. Possible keys for `properties` are: `title` (user identification title), `description` (user identification description), and `type` (property type to define how users should input their identification). Note that these keys will be displayed to the app users.

`1

"settingsSchema": {

2

 "title": "YOUR APP NAME",

3

 "type": "object",

4

 "properties": {

5

 "gtmId": {

6

 "title": "SAMPLE FIELD",

7

 "description": "Enter your Google Tag Manager ID (GTM-XXXX)",

8

 "type": "string"

9

 }

10

 }

11

},

`

If necessary, you can also use the `properties` object to read the user preferences. Check the following example:

`1

"settingsSchema": {

2

 "title": "YOUR APP NAME",

3

 "type": "object",

4

 "properties": {

5

 "gtmId": {

6

 "title": "SAMPLE FIELD",

7

 "description": "Enter your Google Tag Manager ID (GTM-XXXX)",

8

 "type": "string"

9

 },

10

 "allowCustomHtmlTags": {

11

 "title": "Allow custom HTML tags",

12

 "description": "Keep in mind that using custom HTML tags can drastically impact store performance",

13

 "type": "boolean"

14

 }

15

 }

16

},

`

> Please read the [JSON Schema documentation](https://read.calvincode.net/reader?url=http://json-schema.org/understanding-json-schema/) while building the `settingSchema` field of your app.

Contributors

1

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

[2\. Cloning the boilerplate repository« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings//docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)[4\. Writing the head and body scriptsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings//docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts)

See also

[4\. Writing the head and body scriptsApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts)

Contributors

1

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

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-4-configuringyourappsettings%23instructions)

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/vtex-io-documentation-1-developnativeintegrationswithpixelapps/vtex-io-documentation-4-configuringyourappsettings.md)

Copy page

On this page

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings/docs/guides/vtex-io-documentation-4-configuringyourappsettings%23instructions)

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