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

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

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

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

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/basic-components)

---

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

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.b2b-suite)

---

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

---

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

[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.condition-layout)

[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.disclosure-layout)

[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.flex-layout)

[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout)

[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.overlay-layout)

[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.responsive-layout)

[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.slider-layout)

[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.stack-layout)

[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.sticky-layout)

[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.tab-layout)

---

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

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.my-account)

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/basic-components)

---

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

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.b2b-suite)

---

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

---

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

[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.condition-layout)

[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.disclosure-layout)

[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.flex-layout)

[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout)

[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.overlay-layout)

[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.responsive-layout)

[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.slider-layout)

[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.stack-layout)

[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.sticky-layout)

[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.tab-layout)

---

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

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.my-account)

---

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

---

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

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

Modal Layout

Official extension

Version: 0.14.2

Latest version: 0.14.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-3-orange.svg?style=flat-square"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)

The Modal Layout app provides blocks to help you create modals in your store.

![{"base64":"  ","img":{"width":2880,"height":1586,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":1310565,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-modal-layout-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-modal-layout-0.png)

## Configuration

1. Add the Modal Layout app to your theme dependencies in the `manifest.json`:

`1

 "dependencies": {

2

+ "vtex.modal-layout": "0.x"

3

 }

`

Now, you can use all blocks exported by the `modal-layout` app. See the full list below:

| Block name          | Description                                                                                |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| modal-trigger       | ![{"base64":"  ","img":{"width":69,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/-Mandatory-red"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/-Mandatory-red) Defines how the modal content will be triggered through its children blocks.                                                                                |
| modal-layout        | ![{"base64":"  ","img":{"width":69,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/-Mandatory-red"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/-Mandatory-red) Defines how the modal content will be rendered through its children blocks. You can declare the modal-header and modal-content blocks, described below, as children to create a modal with a header and footer. |
| modal-header        | Renders a close button and the blocks listed as its children, building a modal header. Note that it does not automatically render a header for your modal. Instead, you should create the modal header as you desire using the children list of this block.                                                                                |
| modal-content       | Defines how the modal content will be rendered through its children blocks. Preferably, this block should be used along with the modal-header block in order to create a modal with a header and a footer.                                                                                |
| modal-actions       | Logical block that only renders its child blocks that, in turn, render call-to-action buttons inside the modal, such as a confirmation button.                                                                                |
| modal-actions.close | Button that closes the modal when clicked. It is extremely useful when your modal only has a form or a disclaimer box providing information to the users.                                                                                |

1. Add the `modal-trigger` block in any store template you choose. In the example below, it will be added to the homepage:

`1

{

2

 "store.home": {

3

 "children": [

4

 "modal-trigger#example"

5

 ]

6

 },

`

1. Declare the `modal-trigger` block using its prop and configure the children blocks. The first child block of `modal-trigger` must be a block you choose to trigger the modal content. Then, a sibling block called `modal-layout` will be needed to effectively define the modal content through its child block list. For example:

`1

{

2

 "store.home": {

3

 "children": ["modal-trigger#example"]

4

 },

5

 "modal-trigger#example": {

6

 "children": ["rich-text#example", "modal-layout#example"]

7

 },

8

 "rich-text#example": {

9

 "props": {

10

 "text": "Click me"

11

 }

12

 },

13

 "modal-layout#example": {

14

 "children": ["rich-text#modal-content"]

15

 },

16

 "rich-text#modal-content": {

17

 "props": {

18

 "text": "Hello"

19

 }

20

 }

21

}

`

In the example above, the [Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text/) block renders the `Click me` text that will trigger the modal content when clicked. The modal content, in turn, is defined by the `modal-layout` block. Based on the example above, the modal content triggered by the `Click me` Rich Text would be a `Hello` text.

### `modal-trigger` props

| Prop name            | Type   | Description                                                                                | Default value |
| -------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| trigger              | enum   | Defines whether the modal content should be triggered by user click (click), when the page is fully loaded (load), or when the page is fully loaded, but the modal will appear just once per session (load-session).                                                                                | click         |
| customPixelEventId   | string | Store event ID that triggers the modal-trigger block (hence triggering the opening of modal-layout blocks on the interface as well).                                                                                | undefined     |
| customPixelEventName | string | Store event name that triggers the modal-trigger block (hence triggering the opening of modal-layout blocks on the interface as well). Some event examples are 'addToCart' and 'removeFromCart'. Note that using this prop will make the associated modal-layout open in **every** event with the specified name if no customPixelEventId is set. | undefined     |

### `modal-layout` props

| Prop name            | Type    | Description                                                                                | Default value |
| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| scroll               | enum    | Defines how users should scroll the modal. Possible values are: body (users can scroll the whole modal by normally scrolling the page) and content (users can scroll the modal _content_ when hovering over it).                                                                                | content       |
| blockClass           | string  | Unique block ID to be used in [CSS customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).                                                                                | undefined     |
| disableEscapeKeyDown | boolean | Defines whether the modal should be closed when pressing the Esc key (true) or not (false).                                                                                | false         |
| fullScreen           | boolean | Defines whether the modal should fill the whole screen (true) or not (false). This prop is responsive, i.e., it adapts to the device breakpoints.                                                                                | false         |
| backdrop             | enum    | Defines whether the modal will have a clickable backdrop (clickable) or no backdrop at all (none). This prop is responsive, i.e., it adapts to the device breakpoints.                                                                                | clickable     |
| customPixelEventId   | string  | Store event ID that triggers the modal-layout block (hence triggering the closing of modal-layout blocks on the interface as well).                                                                                | undefined     |
| customPixelEventName | string  | Store event name that triggers the modal-layout block (hence triggering the closing of modal-layout blocks on the interface as well). Some event examples are 'addToCart' and 'removeFromCart'. Note that using this prop will make the associated modal-layout close in **every** event with the specified name if no customPixelEventId is set. | undefined     |

### `modal-header` props

| Prop name       | Type    | Description                                                                                | Default value |
| --------------- | ------- | --------------------------------------------------------------------------------------------------- | ------------- |
| showCloseButton | boolean | Defines whether the close icon button should be rendered in the modal header (true) or not (false). | true          |
| iconCloseSize   | number  | Size (in pixels) of the close icon button in the modal header.                                      | 32            |

### `modal-actions.close` props

| Prop name | Type   | Description                                                                                | Default value                                                                                |
| --------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| label     | string | Defines the text to be rendered in the close button. The default value of this prop depends on the store's default language, which is set according to the website [binding](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-is-binding--4NcN3NJd0IeYccgWCI8O2W?locale=en). | Cancel, Cancelar, or Cancelar for stores whose default language is, respectively, English, Spanish, or Portuguese. |

## Customization

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://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).

| CSS handles          |
| -------------------- |
| modal                |
| backdropContainer    |
| backdrop             |
| closeButtonContainer |
| closeButton          |
| container            |
| contentContainer     |
| headerContainer      |
| headerContent        |
| paper                |
| topRow               |
| triggerContainer     |

[Flex Layout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.flex-layout)[Overlay LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.overlay-layout)

See also

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

ON THIS PAGE

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout%23configuration)

[modal-trigger props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout%23modal-trigger-props)[modal-layout props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout%23modal-layout-props)[modal-header props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout%23modal-header-props)[modal-actions.close props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout%23modal-actionsclose-props)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout/docs/apps/vtex.modal-layout%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] Explain the VTEX api reference headless cms api API and how to use it.

[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/api-reference/headless-cms-api/docs/guides)

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

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/vtex-io-apps)

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

API Reference

Filter By

Post

Get

Put

Delete

Patch

[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/antifraud-provider-protocol/)

---

[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/audience-api/)

---

[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/buyer-organizations/)

---

[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/budgets-api/)

---

[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/legacy-cms-portal-api/)

---

[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/card-token-vault-api/)

---

[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/catalog-api-seller-portal/)

---

[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/catalog-api/)

---

[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/checkout-api/)

---

[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/customer-credit-api/)

---

[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/delivery-promise-notification-api/)

---

[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/giftcard-api/)

---

[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/giftcard-provider-protocol/)

---

[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/giftcard-hub-api/)

---

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/headless-cms-api/)

Pages

---

[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/intelligent-search-api/)

---

[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/intelligent-search-events-api-headless/)

---

[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/license-manager-api/)

---

[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/logistics-api/)

---

[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/marketplace-apis/)

---

[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/marketplace-protocol/)

---

[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/master-data-api-v2/)

---

[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/masterdata-api/)

---

[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/message-center-api/)

---

[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/mtls-api/)

---

[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/operational-capacity-api/)

---

[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/orders-api/)

---

[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/organization-units-api/)

---

[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/payment-provider-protocol/)

---

[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/payments-gateway-api/)

---

[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/pick-and-pack-api/)

---

[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/pick-and-pack-protocol-api/)

---

[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/pick-and-pack-order-changes-api/)

---

[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/policies-system-api/)

---

[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/pricing-api/)

---

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/pricing-hub/)

---

[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/promotions-and-taxes-api/)

---

[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/promotions-and-taxes-api-v2/)

---

[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/punchout-api/)

---

[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/reviews-and-ratings-api/)

---

[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/recommendations-bff-api/)

---

[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/sku-bindings-api/)

---

[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/search-api/)

---

[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/session-manager-api/)

---

[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/ssl-certificates-api/)

---

[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/storefront-permissions-api/)

---

[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/subscriptions-api-v3/)

---

[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/vtex-ads-api/)

---

[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/vtex-shipping-network-api/)

---

[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/tracking/)

---

[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/vtex-do-api/)

---

[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/vtex-id-api/)

---

[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/profile-system/)

---

[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/orders-api-pii-version/)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/guides)

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

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

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

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/troubleshooting)

---

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

API Reference

Filter By

Post

Get

Put

Delete

Patch

[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/antifraud-provider-protocol/)

---

[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/audience-api/)

---

[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/buyer-organizations/)

---

[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/budgets-api/)

---

[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/legacy-cms-portal-api/)

---

[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/card-token-vault-api/)

---

[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/catalog-api-seller-portal/)

---

[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/catalog-api/)

---

[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/checkout-api/)

---

[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/customer-credit-api/)

---

[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/delivery-promise-notification-api/)

---

[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/giftcard-api/)

---

[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/giftcard-provider-protocol/)

---

[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/giftcard-hub-api/)

---

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/headless-cms-api/)

Pages

---

[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/intelligent-search-api/)

---

[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/intelligent-search-events-api-headless/)

---

[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/license-manager-api/)

---

[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/logistics-api/)

---

[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/marketplace-apis/)

---

[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/marketplace-protocol/)

---

[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/master-data-api-v2/)

---

[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/masterdata-api/)

---

[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/message-center-api/)

---

[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/mtls-api/)

---

[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/operational-capacity-api/)

---

[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/orders-api/)

---

[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/organization-units-api/)

---

[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/payment-provider-protocol/)

---

[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/payments-gateway-api/)

---

[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/pick-and-pack-api/)

---

[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/pick-and-pack-protocol-api/)

---

[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/pick-and-pack-order-changes-api/)

---

[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/policies-system-api/)

---

[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/pricing-api/)

---

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/pricing-hub/)

---

[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/promotions-and-taxes-api/)

---

[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/promotions-and-taxes-api-v2/)

---

[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/punchout-api/)

---

[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/reviews-and-ratings-api/)

---

[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/recommendations-bff-api/)

---

[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/sku-bindings-api/)

---

[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/search-api/)

---

[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/session-manager-api/)

---

[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/ssl-certificates-api/)

---

[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/storefront-permissions-api/)

---

[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/subscriptions-api-v3/)

---

[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/vtex-ads-api/)

---

[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/vtex-shipping-network-api/)

---

[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/tracking/)

---

[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/vtex-do-api/)

---

[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/vtex-id-api/)

---

[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/profile-system/)

---

[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/orders-api-pii-version/)

---

[GeList All GiftCard Transactions Settlements« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/giftcard-hub-api%23get-/api/giftcardproviders/-giftCardProviderId-/giftcards/-giftCardId-/transactions/-tId-/settlements)[GeGet all content typesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api/docs/api-reference/headless-cms-api%23get-/%5Fv/cms/api/-projectId-)

[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 b2b quotes graphql 4.0.1 b2bquotes graphql api 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.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/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.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/app-development)

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

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/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.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-suite)

[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.storefront-permissions)

[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.storefront-permissions-ui)

[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-organizations)

[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-checkout-settings)

[B2B Orders History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-orders-history)

[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes)

[B2B Quotes GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-suite)

[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.storefront-permissions)

[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.storefront-permissions-ui)

[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-organizations)

[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-checkout-settings)

[B2B Orders History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-orders-history)

[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes)

[B2B Quotes GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/vtex-io-deprecated-apps)

---

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/vtex-io-apps)

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-suite)

[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes)

B2B Quotes GraphQL API

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

Version: 4.0.1

Latest version: 4.0.1

This article provides a reference guide to the B2B Quotes GraphQL API, with details about the available queries and mutations for the [B2B Quotes app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes). The API supports quote management and related configurations in a B2B environment, enabling users to retrieve, create, and update quotes, as well as manage application settings and permissions.

## Schema overview

### Query

adminSetup

getAppSettings

updateHistory

items

getQuote

data

pagination

getQuotes

getChildrenQuotes

AdminSetup

cartLifeSpan Int

quotesManagedBy QuotesManagedBy!

AppSettings

adminSetup AdminSetup

QuoteUpdate

email String

role String

date String

status String

note String

QuoteItem

name String

skuName String

refId String

id String

productId String

imageUrl String

listPrice Float

price Float

quantity Int

sellingPrice Float

seller String

Quote

id String

referenceName String

creatorEmail String

creatorRole String

creationDate String

expirationDate String

lastUpdate String

updateHistory \[QuoteUpdate\]

items \[QuoteItem\]

subtotal Float

status String

organization String

organizationName String

costCenter String

costCenterName String

viewedBySales Boolean

viewedByCustomer Boolean

salesChannel String

seller String

parentQuote String

hasChildren Boolean

Pagination

page Int

pageSize Int

total Int

Quotes

data \[Quote\]

pagination Pagination

Query

getAppSettings AppSettings

getQuoteEnabledForUser(email String!) : Boolean

getQuote(id String) : Quote

getQuotes(organization \[String\], costCenter \[String\], status \[String\], search String, page Int, pageSize Int, sortOrder String, sortedBy String) : Quotes

getChildrenQuotes(id String, page Int, pageSize Int, sortOrder String, sortedBy String) : Quotes

| Field                      | Argument                    | Type                                                                        | Description |
| -------------------------- | --------------------------- | --------------------------------------------------------------------------- | ----------- |
| **getAppSettings**         | [AppSettings](#appsettings) | Retrieves the current configuration settings of the B2B Quotes app.         |             |
| **getQuoteEnabledForUser** | Boolean                     | Checks if the specified user has permission to use the quotes feature.      |             |
| email                      | String!                     | Email address of the user to check permissions for.                         |             |
| **getQuote**               | [Quote](#quote)             | Retrieves a specific quote by ID.                                           |             |
| id                         | String                      | Unique identifier of the quote to retrieve.                                 |             |
| **getQuotes**              | [Quotes](#quotes)           | Retrieves a paginated list of quotes and saved carts with optional filters. |             |
| organization               | \[String\]                  | Filters quotes and saved carts by organization IDs.                         |             |
| costCenter                 | \[String\]                  | Filters quotes and saved carts by cost center IDs.                          |             |
| status                     | \[String\]                  | Filters by status: READY, PENDING, REVISED, DECLINED, EXPIRED, or PLACED.   |             |
| search                     | String                      | Searches quotes and saved carts by reference name.                          |             |
| page                       | Int                         | Page number for pagination.                                                 |             |
| pageSize                   | Int                         | Number of quotes per page.                                                  |             |
| sortOrder                  | String                      | Specifies the sort direction (ASC or DESC).                                 |             |
| sortedBy                   | String                      | Field to sort the quotes by.                                                |             |
| **getChildrenQuotes**      | [Quotes](#quotes)           | Retrieves child quotes associated with a parent quote.                      |             |
| id                         | String                      | ID of the parent quote.                                                     |             |
| page                       | Int                         | Page number for pagination.                                                 |             |
| pageSize                   | Int                         | Number of child quotes per page.                                            |             |
| sortOrder                  | String                      | Specifies the sort direction (ASC or DESC).                                 |             |
| sortedBy                   | String                      | Field to sort the child quotes by.                                          |             |

### Mutation

adminSetup

saveAppSettings

AdminSetup

cartLifeSpan Int

quotesManagedBy QuotesManagedBy!

AppSettings

adminSetup AdminSetup

Mutation

createQuote(input QuoteInput!) : String

updateQuote(input QuoteUpdateInput!) : String

useQuote(id String, orderFormId String) : String

clearCart(orderFormId String) : String

saveAppSettings(input AppSettingsInput!) : AppSettings

| Field               | Argument                               | Type                                                                                | Description |
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------- |
| **createQuote**     | String                                 | Creates a new quote (PENDING status) or saved cart (READY status) from the current shopping cart.     |             |
| input               | [QuoteInput](#quoteinput)!             | Input data for creating a new quote.                                                                  |             |
| **updateQuote**     | String                                 | Updates an existing quote or saved cart, including price adjustments, quantities, and status changes. |             |
| input               | [QuoteUpdateInput](#quoteupdateinput)! | Input data for updating the quote.                                                                    |             |
| **useQuote**        | String                                 | Applies a quote or saved cart to the current shopping cart and redirects to checkout.                 |             |
| id                  | String                                 | ID of the quote to be applied.                                                                        |             |
| orderFormId         | String                                 | ID of the order form to apply the quote to.                                                           |             |
| **clearCart**       | String                                 | Removes all items from the current shopping cart before applying a quote.                             |             |
| orderFormId         | String                                 | ID of the order form to be cleared.                                                                   |             |
| **saveAppSettings** | [AppSettings](#appsettings)            | Updates the B2B Quotes app settings.                                                                  |             |
| input               | [AppSettingsInput](#appsettingsinput)! | New configuration to be saved.                                                                        |             |

## Schema description

> Arguments must be provided by the user. Required fields are marked with an exclamation mark (`!`).

### AppSettings

| Field          | Type                      | Description                                      |
| -------------- | ------------------------- | ------------------------------------------------ |
| **adminSetup** | [AdminSetup](#adminsetup) | Configuration settings for the B2B Quotes admin. |

[Query](#query) 🔼

[Mutation](#mutation) 🔼

### AppSettingsInput

| Field               | Type                                | Description                                                                               |
| ------------------- | ----------------------------------- | ----------------------------------------------------------------------------------------- |
| **cartLifeSpan**    | Int                                 | Default expiration period in days for quotes and saved carts. The minimum value is 1 day. |
| **quotesManagedBy** | [QuotesManagedBy](#quotesmanagedby) | Defines who has permission to manage quotes (marketplace admins or individual sellers).   |

[Mutation](#mutation) 🔼

### AdminSetup

| Field               | Type                                 | Description                                                                                |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------- |
| **cartLifeSpan**    | Int                                  | Default expiration period in days for quotes and saved carts. The minimum value is 1 day.       |
| **quotesManagedBy** | [QuotesManagedBy](#quotesmanagedby)! | Defines who has permission to manage quotes (marketplace administrators or individual sellers). |

[AppSettings](#appsettings) 🔼

### Quotes

| Field          | Type                      | Description                                    |
| -------------- | ------------------------- | ---------------------------------------------- |
| **data**       | \[[Quote](#quote)\]       | Array of quotes matching the query parameters. |
| **pagination** | [Pagination](#pagination) | Pagination details for the quotes list.        |

[Query](#query) 🔼

### Quote

| Field                | Type                            | Description                                                                                |
| -------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **id**               | String                          | Unique identifier for the quote.                                                                                |
| **referenceName**    | String                          | User-defined name to identify the quote or saved cart.                                                                                |
| **creatorEmail**     | String                          | Email address of the user who created the quote.                                                                                |
| **creatorRole**      | String                          | Role of the user who created the quote.                                                                                |
| **creationDate**     | String                          | Date and time when the quote was created.                                                                                |
| **expirationDate**   | String                          | Date and time when the quote will expire.                                                                                |
| **lastUpdate**       | String                          | Date of the last time when the quote or saved cart was updated.                                                                                |
| **updateHistory**    | \[[QuoteUpdate](#quoteupdate)\] | History of all events related to the quote, including creation, discounts, and notes.                                                                                |
| **items**            | \[[QuoteItem](#quoteitem)\]     | Products included in the quote.                                                                                |
| **subtotal**         | Float                           | Total price of all items, including any discounts offered by sales associates.                                                                                |
| **status**           | String                          | Current status of the quote. Possible values are:READY (ready to place the order)PENDING (waiting for review)REVISED (waiting for additional review)DECLINED (can't be used)EXPIRED (past expiration date)PLACED (already used) |
| **organization**     | String                          | ID of the organization the quote belongs to.                                                                                |
| **organizationName** | String                          | Name of the organization the quote belongs to.                                                                                |
| **costCenter**       | String                          | ID of the cost center associated with the quote.                                                                                |
| **costCenterName**   | String                          | Name of the cost center associated with the quote.                                                                                |
| **viewedBySales**    | Boolean                         | Indicates if a sales associate has viewed the quote or saved cart.                                                                                |
| **viewedByCustomer** | Boolean                         | Indicates if the customer has viewed the quote or saved cart.                                                                                |
| **salesChannel**     | String                          | Sales channel associated with the quote or saved cart.                                                                                |
| **seller**           | String                          | ID of the seller associated with the quote.                                                                                |
| **parentQuote**      | String                          | ID of the parent quote if this is a child quote.                                                                                |
| **hasChildren**      | Boolean                         | Indicates if this quote has associated child quotes.                                                                                |

[Query](#query) 🔼

[Quotes](#quotes) 🔼

### QuoteInput

| Field              | Type                                  | Description                                                                                |
| ------------------ | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| **referenceName**  | String                                | User-defined name to identify the quote.                                                                         |
| **items**          | \[[QuoteItemInput](#quoteiteminput)\] | List of products to include in the quote.                                                                        |
| **subtotal**       | Float                                 | Total price of all items, including any discounts offered by sales associates.                                   |
| **note**           | String                                | Optional note that will be visible in the quote's update history to salespeople and organization members.        |
| **sendToSalesRep** | Boolean                               | If true, creates a quote with PENDING status for sales review. If false, creates a saved cart with READY status. |

[Mutation](#mutation) 🔼

### QuoteUpdate

| Field      | Type   | Description                                                                           |
| ---------- | ------ | ------------------------------------------------------------------------------------- |
| **email**  | String | Email of the user who made the update.                                                |
| **role**   | String | Role of the user who made the update (such as sales associate or organization buyer). |
| **date**   | String | Date when the update was made.                                                        |
| **status** | String | Status change made in this update, if any.                                            |
| **note**   | String | Optional comment or instruction added during this update.                             |

[Quote](#quote) 🔼

### QuoteItem

| Field            | Type   | Description                                                        |
| ---------------- | ------ | ------------------------------------------------------------------ |
| **name**         | String | Product name.                                                      |
| **skuName**      | String | Name of the specific SKU variant.                                  |
| **refId**        | String | Reference ID of the product.                                       |
| **imageUrl**     | String | URL of the product image.                                          |
| **listPrice**    | Float  | Original price before any discounts.                               |
| **price**        | Float  | Original product price before any discounts.                       |
| **quantity**     | Int    | Number of items.                                                   |
| **sellingPrice** | Float  | Product price including any discounts offered by sales associates. |

[Quote](#quote) 🔼

### QuoteUpdateInput

| Field              | Type                                  | Description                                                                           |
| ------------------ | ------------------------------------- | ------------------------------------------------------------------------------------- |
| **id**             | String                                | Unique identifier of the quote to be updated.                                         |
| **items**          | \[[QuoteItemInput](#quoteiteminput)\] | Updated list of products with their quantities and prices.                            |
| **subtotal**       | Float                                 | Updated total price of all items.                                                     |
| **note**           | String                                | Optional comment or instruction that will be displayed in the quote's update history. |
| **decline**        | Boolean                               | When true, changes the quote status to DECLINED, preventing further use.              |
| **expirationDate** | String                                | New expiration date for the quote or saved cart.                                      |

[Mutation](#mutation) 🔼

### QuoteItemInput

| Field            | Type   | Description                                                        |
| ---------------- | ------ | ------------------------------------------------------------------ |
| **name**         | String | Product name.                                                      |
| **skuName**      | String | Name of the specific SKU variant.                                  |
| **refId**        | String | Reference ID of the product.                                       |
| **id**           | String | Unique identifier for the SKU.                                     |
| **productId**    | String | Unique identifier for the product.                                 |
| **imageUrl**     | String | URL of the product image.                                          |
| **listPrice**    | Float  | Original price before any discounts.                               |
| **price**        | Float  | Original product price before any discounts.                       |
| **quantity**     | Int    | Number of items.                                                   |
| **sellingPrice** | Float  | Product price including any discounts offered by sales associates. |
| **seller**       | String | ID of the seller offering this item.                               |

[QuoteUpdateInput](#quoteupdateinput) 🔼

### Pagination

| Field        | Type | Description                             |
| ------------ | ---- | --------------------------------------- |
| **page**     | Int  | Current page number.                    |
| **pageSize** | Int  | Number of items per page.               |
| **total**    | Int  | Total number of items across all pages. |

[Quotes](#quotes) 🔼

## Enums

### QuotesManagedBy

| Field           | Description                                   |
| --------------- | --------------------------------------------- |
| **MARKETPLACE** | Quotes are managed by the marketplace admins. |
| **SELLER**      | Quotes are managed by individual sellers.     |

[AppSettingsInput](#appsettingsinput) 🔼

[AdminSetup](#adminsetup) 🔼

[B2B Quotes & Carts« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes)[Functional AppsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/guides/functional-apps)

See also

[Vtex.b2b Quotes GraphqlVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23schema-overview)

[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23mutation)

[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23schema-description)

[AppSettings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23appsettings)[AppSettingsInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23appsettingsinput)[AdminSetup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23adminsetup)[Quotes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quotes)[Quote](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quote)[QuoteInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quoteinput)[QuoteUpdate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quoteupdate)[QuoteItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quoteitem)[QuoteUpdateInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quoteupdateinput)[QuoteItemInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quoteiteminput)[Pagination](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23pagination)

[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23enums)

[QuotesManagedBy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql@4.0.1/b2bquotes-graphql-api%23quotesmanagedby)

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 enable the region for skus in VTEX.

[Assistant]
Documentation

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

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

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

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

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

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

Enable the Region for SKUs

The Region feature is one of the features made available by the session system installation. It aims to regionalize user experience of the store. It allows, for example, for sellers to set their own prices and that the marketplaces display them according to the client’s region.

After you [set up delivery](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-price-and-availability-of-skus-by-region--12ne58BmvYsYuGsimmugoc%23setting-up-delivery-in-franchise-accountseller-white-label) of a SKU to a White Label Seller from your store, it is necessary for the session system to identify the zip code and country of the user browsing the store to show the custom price and availability by region.

This information about ZIP code and country can be stored in the cookie [vtex\_session](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-price-and-availability-of-skus-by-region--12ne58BmvYsYuGsimmugoc), due to a purchase made previously by the user, or can be entered via JavaScript in the session.

To enter the country and zip code in the session, you must perform a `POST` in the following route:`{{account-name}}.{{environment}}.com.br/api/sessions`

Below are examples of bodies to be sent to `POST`:

* Update session by postal code.

`1

{

2

 "public": {

3

 "country": {

4

 "value": "USA"

5

 },

6

 "postalCode": {

7

 "value": "32004"

8

 }

9

 }

10

}

`

* Update session by geo-coordinates.

`1

{

2

 "public": {

3

 "country": {

4

 "value": "USA"

5

 },

6

 "geoCoordinates": {

7

 "value": "22.123,-14.1"

8

 }

9

 }

10

}

`

* Update session by address.

`1

{

2

 "public": {

3

 "storeUserEmail": {

4

 "value": "<mailto:example@example.complexample.com>"

5

 },

6

 "addressId": {

7

 "value": "123456789"

8

 }

9

 }

10

}

`

To verify that the session has updated the country and zip code data, send a `GET` request on the route below and search for the `country` and `postalCode` fields:`{{account-name}}.{{environment}}.com.br/api/sessions?items={{namespace}}.{{value}},{{namespace}}.{{value2}}`

After refreshing the product page, the platform will update price and availability information according to the region specified in the country and zip code information.

Contributors

2

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

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

Was this helpful?

Yes

No

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

[Enable the Save user data opt-in« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus//docs/guides/enable-the-save-user-data-opt-in)[Configure the Global CheckoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enable-the-region-for-skus//docs/guides/configure-the-global-checkout)

Contributors

2

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

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

Was this helpful?

 Send feedback

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

Copy page

On this page

On this page

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