[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 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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/b2bquotes-graphql-api/docs/guides)

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

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

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/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/b2bquotes-graphql-api/docs/vtex-io-apps)

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

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api%23schema-overview)

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

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

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

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

[QuotesManagedBy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-quotes-graphql/b2bquotes-graphql-api/docs/apps/vtex.b2b-quotes-graphql/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] How do I use the VTEX store components 3.178.5 InfoCard app? Provide documentation and configuration details.

[Assistant]
Documentation

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

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/InfoCard/docs/guides)

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

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

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

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

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/InfoCard/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/InfoCard/updates/release-notes)

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

Info Card

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

Version: 3.178.5

Latest version: 3.178.5

The `info-card` component groups information on a single topic. It often includes text, an image, and a call-to-action button.

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

## Configuration

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

`1

 "dependencies": {

2

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

3

 }

`

1. Add the `info-card` block to the desired page template.
2. Add the `info-card` block to the same template file using the props stated in the [Props](#props) table. For example:

`1

 "info-card": {

2

 "props": {

3

 "id": "info-card-example",

4

 "isFullModeStyle": false,

5

 "textPosition": "left",

6

 "imageUrl": "https://storecomponents.vteximg.com.br/arquivos/banner-infocard2.png",

7

 "headline": "Clearance Sale",

8

 "callToActionText": "DISCOVER",

9

 "callToActionUrl": "/sale/d",

10

 "blockClass": "info-card-example",

11

 "textAlignment": "center",

12

 "fetchpriority": "auto",

13

 "preload": true

14

 }

15

 },

`

### Props

| Prop name              | Type              | Description                                                                                | Default value |
| ---------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------- |
| blockClass             | String            | Extra class name for custom styling.                                                                                | null          |
| callToActionLinkTarget | LinkTargetEnum    | Where to display the call-to-action component's linked URL, as the name for a browsing context (a tab, window, or iframe). | "\_self"      |
| callToActionMode       | CallToActionEnum  | Mode of the call-to-action component.                                                                                | "button"      |
| callToActionText       | string            | Text displayed inside the call-to-action component.                                                                        | ""            |
| callToActionUrl        | string            | URL of the call-to-action component.                                                                                | ""            |
| headline               | string            | Headline of the Info Card.                                                                                | null          |
| htmlId                 | string            | ID of the container element.                                                                                | null          |
| imageUrl               | string            | Path to the image used on desktop devices.                                                                                | ""            |
| imageActionUrl         | string            | Redirect URL used when the image component is clicked.                                                                     | ""            |
| isFullModeStyle        | boolean           | Style of the Info Card component. If true, the image component is used as the background, and text is displayed over it.   | false         |
| linkTarget             | LinkTargetEnum    | Where to display the linked URL when the Info Card component is clicked.                                                   | "\_self"      |
| mobileImageUrl         | string            | Path to the image used on mobile devices. If empty, the desktop image is used.                                             | null          |
| subhead                | string            | Text to be displayed underneath the headline. If not provided, it will not be rendered.                                    | null          |
| bodyText               | string            | Text to be displayed underneath the subhead. If not provided, it will not be rendered.                                     | null          |
| textAlignment          | TextAlignmentEnum | Text alignment inside the component: left, center or right. This prop is ignored if isFullModeStyle is true.               | "left"        |
| textMode               | TextModeEnum      | Text mode used to process the text from headline and subhead props.                                                        | "html"        |
| textPosition           | TextPositionEnum  | Position of the text component: left, center or right.                                                                     | "left"        |
| fetchpriority          | string            | The fetch priority hint ('high', 'low' or 'auto').                                                                         |               |
| auto                   |                   |                                                                                |               |
| preload                | boolean           | Preloads the first image in a list, prioritizing the image display over other assets.                                      |               |
| false                  |                   |                                                                                |               |

#### `TextPositionEnum` possible values

| Enum name | Enum value | Description                                                                            |
| --------- | ---------- | -------------------------------------------------------------------------------------- |
| Left      | 'left'     | Text will be on the left. If isFullModeStyle is false, the image will be on the right. |
| Center    | 'center'   | Text will be in the center. Not applicable if isFullModeStyle is false.                |
| Right     | 'right'    | Text will be on the right. If isFullModeStyle is false, the image will be on the left. |

#### `CallToActionEnum` possible values

| Enum name | Enum value | Description                                                      |
| --------- | ---------- | ---------------------------------------------------------------- |
| None      | none       | Does not render any call-to-action components.                   |
| Button    | button     | Renders the call-to-action component as a button.                |
| Link      | link       | Renders the call-to-action component as a text in a link format. |

#### `LinkTargetEnum` possible values

These values are the same ones supported by HTML5 anchor tags. For more information, please read the [MDN](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) documentation.

| Enum name      | Enum value | Description                                                                                |
| -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Self (default) | \_self     | Opens the link in the current browsing context.                                                                                |
| Blank          | \_blank    | Opens the link in a new tab, but users can configure browsers to open a new window instead.                                                                   |
| Parent         | \_parent   | Opens the link in the parent browsing context of the current one. If there is no parent, it behaves as \_self.                                                |
| Top            | \_top      | Opens the link in the topmost browsing context (the "highest" context that is an ancestor of the current one). If there is no ancestor, it behaves as \_self. |

#### `TextModeEnum` possible values

| Enum name | Enum value | Description                                                                                |
| --------- | ---------- | -------------------------------------------------------------------------------------------------------------------- |
| HTML      | html       | Uses HTML text for headline and subhead props.                                                                       |
| Rich Text | rich-text  | Uses markdown text and the [rich-text block](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/rich-text) for headline and subhead props. |

## Customization

To apply CSS customizations to this and other blocks, please see the [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) guide.

| CSS Handles                 |
| --------------------------- |
| infoCardCallActionContainer |
| infoCardCallActionText      |
| infoCardContainer           |
| infoCardHeadline            |
| infoCardImage               |
| infoCardImageContainer      |
| infoCardImageLinkWrapper    |
| infoCardSubhead             |
| infoCardBodyText            |
| infoCardTextContainer       |

See also

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

ON THIS PAGE

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

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

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

Was this helpful?

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


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

[User] Provide a guide on guides setting up dkim for transactional emails 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/setting-up-dkim-for-transactional-emails/docs/guides)

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

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

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

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

[Setting up DKIM for transactional emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails)

[Setting up the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-the-spf)

[How to set up functions in the Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/how-to-set-up-functions-in-the-message-center-templates)

[Including order variables in the transactional email template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/including-order-variables-in-the-transactional-email-template)

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

[Setting up DKIM for transactional emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails)

[Setting up the SPF](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-the-spf)

[How to set up functions in the Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/how-to-set-up-functions-in-the-message-center-templates)

[Including order variables in the transactional email template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/including-order-variables-in-the-transactional-email-template)

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides)

Message Center

[Setting up DKIM for transactional emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails)

Setting up DKIM for transactional emails

To enhance security for outgoing email and improve deliverability, the [DKIM](https://read.calvincode.net/reader?url=http://www.dkim.org/) standard adds an encrypted signature to the header of all outgoing messages. Email servers that receive signed messages use DKIM to decrypt the message header and verify the message was not changed after it was sent.

This guide explains how to use the [Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api?endpoint=post-/api/mail-service/pvt/providers/-EmailProvider-/dkim) to generate DKIM keys that can be stored in your DNS provider so that all transactional emails sent by VTEX can be recognized as legitimate.

> These instructions only apply if the [sender](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP/42LVaxtFb2VHX9xTZU58qC) is set up using VTEX mail servers. If you use your own SMTP provider, you need to enable DKIM in your mail server.

## DKIM endpoint

It is necessary to use the `POST` [Generate DKIM keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api?endpoint=post-/api/mail-service/pvt/providers/-EmailProvider-/dkim) endpoint from Message Center API, as follows:

`POST https://{accountName}.{environment}.com.br/api/mail-service/pvt/providers/{EmailProvider}/dkim`

* `{accountName}` should be replaced with your store account name (e.g. `apiexamples`).
* `{environment}` should be replaced with the environment you are using (e.g. `vtexcommercestable`).
* `{EmailProvider}` should be replaced with the configured email address (e.g. `help@valdie.co`).

See the [Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api?endpoint=post-/api/mail-service/pvt/providers/-EmailProvider-/dkim) reference for more details.

## Generating a DKIM key for your domain

Follow the steps below to create a DKIM key for your domain:

1. Make a request to the `POST` [Generate DKIM keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api?endpoint=post-/api/mail-service/pvt/providers/-EmailProvider-/dkim) endpoint.
Before you have [set up a sender in Message Center](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP) using VTEX mail servers, this is the expected response from the DKIM endpoint:
`1
{
2
 "status": "emailNotFound",
3
 "dkimKeys": null
4
}
`
2. Follow [this guide](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP%23senders) to set up a sender on Message Center.
Once the sender has been set up, you should receive an email from Amazon Web Services requesting you to authorize the configured email address to use [Amazon SES](https://read.calvincode.net/reader?url=https://aws.amazon.com/ses/), as illustrated below:
![{"base64":"  ","img":{"width":944,"height":700,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":166824,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/setting-up-dkim-for-transactional-emails-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/setting-up-dkim-for-transactional-emails-0.png)
3. Click the confirmation link provided in the email body to verify you are the owner of the configured email address. This is required for the mail server to send mail on your behalf.
Until this is done, this is the expected response from the DKIM endpoint:
`1
{
2
 "status": "emailNotVerified",
3
 "dkimKeys": null
4
}
`
4. Once you have clicked the confirmation link, test your SMTP configuration on VTEX Admin at **Email Templates > Senders** by clicking the ✅**Test** button, as shown in the image below:
![{"base64":"  ","img":{"width":476,"height":402,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":29460,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/setting-up-dkim-for-transactional-emails-1.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/setting-up-dkim-for-transactional-emails-1.png)
You should receive an email from the VTEX mail server using the sender you selected. The email message sent follows the Message Center template `messageservice_teste_email`, which you can customize as in the image below by following the [How to create and edit transactional email templates](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP/335JZKUYgvYlGOJgvJYxRO) guide.
![{"base64":"  ","img":{"width":1598,"height":886,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":136737,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/setting-up-dkim-for-transactional-emails-2.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/setting-up-dkim-for-transactional-emails-2.png)
> If you do not receive any messages, review your sender configuration and try again.
5. Once you have correctly set up a sender in Message Center using VTEX mail servers, make a request to `POST` [Generate DKIM keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api?endpoint=post-/api/mail-service/pvt/providers/-EmailProvider-/dkim) endpoint again.
The response should be similar to the one below:
`1
{
2
 "status": "created",
3
 "dkimKeys": [
4
 "'n4zbltwizctxpgcmqrars4bmfdd3zlyo._domainkey.valdie.co','CNAME','n4zbltwizctxpgcmqrars4bmfdd3zlyo.dkim.amazonses.com'",
5
 "'sq3iae4be52fhqq3wm44btttvndeecfv._domainkey.valdie.co','CNAME','sq3iae4be52fhqq3wm44btttvndeecfv.dkim.amazonses.com'",
6
 "'n4z5g2g7yfy4pnhjklfesxrrkt4o2ha4._domainkey.valdie.co','CNAME','n4z5g2g7yfy4pnhjklfesxrrkt4o2ha4.dkim.amazonses.com'"
7
 ]
8
}
`

## Adding the public key to your DNS records

Now that you have generated a DKIM key for your domain, you need to add the values listed in dkimKeys in your DNS records. Read the documentation for your [domain name](https://read.calvincode.net/reader?url=https://support.google.com/a/answer/48323) for specific instructions on how to do that, but this is the general flow:

1. Sign in to the management console for your domain host.
2. Locate the page where you update DNS records.
3. Add a CNAME record for each corresponding DKIM key.
4. Save changes.

In up to 72 hours, all settings will be applied automatically, and our servers will start adding a DKIM signature to all outgoing messages.

Contributors

5

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F2023083%3Fv%3D4%26w=64%26q=75)](https://github.com/mateussaggin)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F106821144%3Fv%3D4%26w=64%26q=75)](https://github.com/GeorgeLimaDev)

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

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/Integration-Guides/api-guides/setting-up-dkim-for-transactional-emails.md)

[vtex.js for Catalog« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails//docs/guides/vtexjs-for-catalog)[Setting up the SPFNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails//docs/guides/setting-up-the-spf)

Contributors

5

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F2023083%3Fv%3D4%26w=64%26q=75)](https://github.com/mateussaggin)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F106821144%3Fv%3D4%26w=64%26q=75)](https://github.com/GeorgeLimaDev)

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

ON THIS PAGE

[DKIM endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails%23dkim-endpoint)

[Generating a DKIM key for your domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails%23generating-a-dkim-key-for-your-domain)

[Adding the public key to your DNS records](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails%23adding-the-public-key-to-your-dns-records)

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/Integration-Guides/api-guides/setting-up-dkim-for-transactional-emails.md)

Copy page

On this page

ON THIS PAGE

[DKIM endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails%23dkim-endpoint)

[Generating a DKIM key for your domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails%23generating-a-dkim-key-for-your-domain)

[Adding the public key to your DNS records](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails/docs/guides/setting-up-dkim-for-transactional-emails%23adding-the-public-key-to-your-dns-records)

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