[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 external marketplace integration app graphql api 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/external-marketplace-integration-app-graphql-api/docs/guides)

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

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

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

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/vtex-platform-overview)

---

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

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/getting-started)

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/erp-integration-guide)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-guide)

[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-architecture)

[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-vtex-seller-setup)

[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-template)

[External Marketplace Integration app GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api)

[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-catalog)

[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-logs)

[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-product-load)

[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-new-products)

[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-product-updates)

[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-catalog-mapping)

[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-price-update)

[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-stock-update)

[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-orders)

[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-recommendations)

[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-collect-orders)

[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-update-order-status)

[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-delivery-validation)

[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-invoice-tracking)

[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-canceled-orders)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-seller-integration-guide)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/gift-card-integration-guide)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/punchout)

[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/sent-offers-integration-guide-connectors)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/payments-integration-guide)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/recaptcha)

---

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

---

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

---

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

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides)

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

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

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/vtex-platform-overview)

---

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

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/getting-started)

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/erp-integration-guide)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-guide)

[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-architecture)

[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-vtex-seller-setup)

[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-template)

[External Marketplace Integration app GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api)

[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-catalog)

[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-logs)

[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-product-load)

[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-new-products)

[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-product-updates)

[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-catalog-mapping)

[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-price-update)

[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-stock-update)

[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-orders)

[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-recommendations)

[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-collect-orders)

[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-update-order-status)

[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-delivery-validation)

[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-invoice-tracking)

[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-canceled-orders)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-seller-integration-guide)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/gift-card-integration-guide)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/punchout)

[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/sent-offers-integration-guide-connectors)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/payments-integration-guide)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/recaptcha)

---

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

---

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

---

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

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides)

Integration Guides

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-guide)

[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-template)

[External Marketplace Integration app GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api)

External Marketplace Integration app GraphQL API

GraphQL API reference for the External Marketplace integration app.

This document outlines the GraphQL API for managing external marketplace integrations within the VTEX ecosystem, provided via the [mkp-app-template](https://read.calvincode.net/reader?url=https://github.com/vtex/mkp-app-template) app template. The API enables querying and modifying integration settings, including sales channel configurations, affiliate mappings, and account details.

## Schema overview

### Query

getConfiguration

getSalesChannel

Configuration

accountName String

active Boolean

affiliateId String

salesChannel String

email String

allowFranchiseAccounts Boolean

SalesChannel

Id ID!

Name String

CountryCode String

CultureInfo String

TimeZone String

CurrencyCode String

Query

getConfiguration Configuration

getSalesChannel(salesChannelId String) : SalesChannel

| Field                | Argument                        | Type                                                                                | Description |
| -------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
| **getConfiguration** | [Configuration](#configuration) | Retrieves the current marketplace integration configuration, including account settings, affiliate details, and sales channel information. |             |
| **getSalesChannel**  | [SalesChannel](#saleschannel)   | Retrieves detailed properties of a specific sales channel using its unique ID.                                                             |             |
| salesChannelId       | String                          | Sales channel ID.                                                                                |             |

### Mutation

Mutation

saveConfiguration(config ConfigurationInput) : String

createSalesChannel(salesChannelData SalesChannelInput) : String

| Field                  | Argument                                  | Type                                                                                | Description |
| ---------------------- | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **saveConfiguration**  | String                                    | Updates the integration configuration with the provided settings. Returns a success message or error if the operation fails. |             |
| config                 | [ConfigurationInput](#configurationinput) | Properties of the configuration to be saved.                                                                                |             |
| **createSalesChannel** | String                                    | Creates or updates a sales channel with the provided information. Returns a success message or error if the operation fails. |             |
| salesChannelData       | [SalesChannelInput](#saleschannelinput)   | Sales channel properties to be created or modified.                                                                          |             |

## Schema description

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

### Configuration

| Field                      | Type    | Description                                                                                |
| -------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| **accountName**            | String  | Account name where the integration is installed.                                                                                |
| **active**                 | Boolean | Indicates whether the integration is active. If true, the integration is active. If false, the integration is inactive.                             |
| **affiliateId**            | String  | ID (3 consonants) that represents the connection with the external marketplace. The ID needs to be unique in the VTEX seller account. Example: LVL. |
| **salesChannel**           | String  | Sales channel ID, which defines the catalog that will be sent to the marketplace. Example: 1.                                                       |
| **email**                  | String  | Email that will receive VTEX notifications related to the affiliate.                                                                                |
| **allowFranchiseAccounts** | Boolean | Indicates whether the integration allows franchise accounts. If true, the integration allows them. If false, the integration doesn't allow them.    |

[Query](#query) 🔼

### SalesChannel

| Field            | Type   | Description                                                                                |
| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Id**           | ID!    | Sales channel ID. Example: 1.                                                                                |
| **Name**         | String | Sales channel name. Example: "Marketplace channel".                                                                                |
| **CountryCode**  | String | Sales channel country code in [ISO 3166-1 alpha-2 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F3166-1%5Falpha-2%23Officially%5Fassigned%5Fcode%5Felements) for the external marketplace. Example: "US".                                                                                |
| **CultureInfo**  | String | Sales channel culture information for the external marketplace in [IETF BCP 47 format](https://read.calvincode.net/reader?url=https://www.rfc-editor.org/info/bcp47) and combining a language code in [ISO-639 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/List%5Fof%5FISO%5F639%5Flanguage%5Fcodes) and a region code in [ISO 3166-1 alpha-2 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F3166-1%5Falpha-2%23Officially%5Fassigned%5Fcode%5Felements). Example: "en-US". |
| **TimeZone**     | String | Sales channel [time zone name](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) for the external marketplace. Example: "Pacific Standard Time".                                                                                |
| **CurrencyCode** | String | Sales channel currency code in [ISO 4217 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F4217%23List%5Fof%5FISO%5F4217%5Fcurrency%5Fcodes) for the external marketplace. Example: "USD".                                                                                |

[Query](#query) 🔼

### ConfigurationInput

| Field                      | Type    | Description                                                                                |
| -------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **accountName**            | String  | Name of the account where the integration is installed.                                                                                |
| **active**                 | Boolean | Property that defines if the integration is active. If true, the integration is active. If false, the integration is inactive.                          |
| **affiliateId**            | String  | ID (3 consonants) that represents the connection with the external marketplace. The ID needs to be unique in the VTEX seller account. Example: LVL.     |
| **salesChannel**           | String  | Sales channel ID, which defines the catalog that will be sent to the marketplace. Example: 1.                                                           |
| **email**                  | String  | Email that will receive VTEX notifications related to the affiliate.                                                                                |
| **allowFranchiseAccounts** | Boolean | Property that defines if the integration allows franchise accounts. If true, the integration allows them. If false, the integration doesn't allow them. |

[Mutation](#mutation) 🔼

### SalesChannelInput

| Field            | Type   | Description                                                                                |
| ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Id**           | ID!    | Sales channel ID. Example: 1.                                                                                |
| **Name**         | String | Sales channel name. Example: "Marketplace channel".                                                                                |
| **CountryCode**  | String | Sales channel country code in [ISO 3166-1 alpha-2 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F3166-1%5Falpha-2%23Officially%5Fassigned%5Fcode%5Felements) for the external marketplace. Example: "US".                                                                                |
| **CultureInfo**  | String | Sales channel culture information for the external marketplace in [IETF BCP 47 format](https://read.calvincode.net/reader?url=https://www.rfc-editor.org/info/bcp47) and combining a language code in [ISO-639 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/List%5Fof%5FISO%5F639%5Flanguage%5Fcodes) and a region code in [ISO 3166-1 alpha-2 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F3166-1%5Falpha-2%23Officially%5Fassigned%5Fcode%5Felements). Example: "en-US". |
| **TimeZone**     | String | Sales channel [time zone name](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) for the external marketplace. Example: "Pacific Standard Time".                                                                                |
| **CurrencyCode** | String | Sales channel currency code in [ISO 4217 format](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/ISO%5F4217%23List%5Fof%5FISO%5F4217%5Fcurrency%5Fcodes) for the external marketplace. Example: "USD".                                                                                |

[🔼 Mutation](#mutation)

Contributors

2

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

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-app-graphql-api.md)

[Creating an integration app from a Template« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api//docs/guides/external-marketplace-integration-app-template)[Catalog IntegrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api//docs/guides/external-marketplace-integration-catalog)

Contributors

2

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

ON THIS PAGE

[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23schema-overview)

[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23mutation)

[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23schema-description)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23configuration)[SalesChannel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23saleschannel)[ConfigurationInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23configurationinput)[SalesChannelInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23saleschannelinput)

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/external-marketplace-integration-guide/external-marketplace-integration-app-graphql-api.md)

Copy page

On this page

ON THIS PAGE

[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23schema-overview)

[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23mutation)

[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23schema-description)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23configuration)[SalesChannel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23saleschannel)[ConfigurationInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23configurationinput)[SalesChannelInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-app-graphql-api/docs/guides/external-marketplace-integration-app-graphql-api%23saleschannelinput)

On this page

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


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

[User] Provide a guide on guides app development guides 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/app-development-guides/docs/guides)

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

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

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

App Development

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

---

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

---

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

---

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

---

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

---

Project structure

---

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

---

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

---

Managing apps

---

Development guides

---

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

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

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

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

Handling events

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

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

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

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

App Development

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

---

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

---

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

---

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

---

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

---

Project structure

---

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

---

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

---

Managing apps

---

Development guides

---

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

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

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

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

Handling events

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

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

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

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

Custom app development guides

Step by step guides on how to solve real-world issues when developing custom VTEX IO apps and backend integrations.

## Setting up your workspace

Set up your local environment: start new projects, sync your local files to the cloud, and manage development logs.

* [Creating a development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace)
* [Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app)
* [Linking an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app)

## Service development

Develop new functionalities by building service apps and integrating clients.

* [Using and creating clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-use-and-create-clients-on-vtex-io)
* [Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps)
* [Connecting to VTEX core commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io)
* [Receiving order notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io)
* [Managing application logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-application-logs)

## App deployment

Make your new VTEX IO app or storefront customizations available to end users.

* [Releasing a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version)
* [Publishing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app)
* [Deploying the app's stable version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deploying-the-app-stable-version)
* [Promoting a workspace to master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master)

## Edition Apps

Become a Sponsor Account and manage the Edition Apps of your child accounts.

* [Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)
* [Configuring an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-an-edition-app)
* [Updating Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-updating-edition-apps)

Contributors

1

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

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/app-development-guides.md)

[Creating an interface for your app settings« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides//docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings)[ServicesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides//docs/guides/vtex-io-documentation-service)

Contributors

1

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

ON THIS PAGE

[Setting up your workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/app-development-guides%23setting-up-your-workspace)

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

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

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/app-development-guides%23edition-apps)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/app-development-guides.md)

Copy page

On this page

ON THIS PAGE

[Setting up your workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/app-development-guides%23setting-up-your-workspace)

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

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

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-development-guides/docs/guides/app-development-guides%23edition-apps)

On this page

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


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

[User] How do I use the VTEX apps vtexarg.product highlight by vtex segment 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/vtexarg.product-highlight-by-vtex-segment/docs/guides)

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

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

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

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/advanced-components)

[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.availability-notify)

[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.category-menu)

[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexbr.kitlook)

[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-icons/iconpack)

[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.iframe)

[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexventures.livestreaming)

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

[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexventures.personal-shopper-free)

[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-availability)

[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-comparison)

[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-gifts)

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

[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-specification-badges)

[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.quantity-on-cart)

[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.reviews-and-ratings)

[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.safedata)

[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.seller-selector)

[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.similar-products-variants)

[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-drawer)

[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-locator)

[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-form)

[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-link)

[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-media)

[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-newsletter)

[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-video)

[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.sandbox)

[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.shipping-option-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/functional-apps)

---

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

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/advanced-components)

[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.availability-notify)

[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.category-menu)

[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexbr.kitlook)

[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-icons/iconpack)

[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.iframe)

[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexventures.livestreaming)

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

[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexventures.personal-shopper-free)

[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-availability)

[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-comparison)

[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-gifts)

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

[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-specification-badges)

[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.quantity-on-cart)

[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.reviews-and-ratings)

[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.safedata)

[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.seller-selector)

[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.similar-products-variants)

[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-drawer)

[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-locator)

[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-form)

[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-link)

[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-media)

[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-newsletter)

[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.store-video)

[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.sandbox)

[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.shipping-option-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/functional-apps)

---

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

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/vtex-io-deprecated-apps)

---

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/vtex-io-apps)

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/guides/advanced-components)

Product Highlight by VTEX Segment

Official extension

Version: 0.3.2

Latest version: 0.3.2

[![{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAABCAIAAAB2XpiaAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAFUlEQVR4nGPg4+Mz1Nfjl5T7f2c+AAzxA3lptuDWAAAAAElFTkSuQmCC","img":{"src":"https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square","width":110,"height":20,"type":"svg"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)

The **Product Highlight by VTEX Segment** app allows shoppers to select a Whitelabel Seller available in their region, and it filters the product listing results accordingly. The app also uses a badge to highlight products of Whitelabel Sellers that are available in the shopper's region.

![{"base64":"  ","img":{"width":700,"height":384,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":1677098,"url":"https://user-images.githubusercontent.com/55905671/143295939-7d1b5625-5c57-46ad-a197-ef959db268de.gif"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/55905671/143295939-7d1b5625-5c57-46ad-a197-ef959db268de.gif)

---

## Before you start

Before configuring the **Product Highlight by VTEX Segment** app, make sure to create a collection for each Whitelabel Seller of your store (_See [Creating Collections Beta](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-collections-beta) for more information)._ When naming your collection, make sure to use the following naming structure: `{sellerId}-{defaultCollectionName}`, where the `{sellerId}` is the `sellerId` of the Whitelabel Seller and `{defaultCollectionName}` is the name of the Collection.

![{"base64":"  ","img":{"width":2880,"height":1580,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":383687,"url":"https://user-images.githubusercontent.com/55905671/143301880-ee440d48-eced-4750-9cd2-ae3f3588a8e4.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/55905671/143301880-ee440d48-eced-4750-9cd2-ae3f3588a8e4.png)

---

## Configuration

To configure the **Product Highlight by VTEX Segment** app, you'll need to:

1. Set up the default configurations of the **Product Highlight by VTEX Segment** app via the VTEX Admin.
2. Add the **Product Highlight by VTEX Segment** to the store theme.

By the end of these steps, you'll have your store products highlighted according to the Whitelabel Seller selected.

## Setting up the Product Highlights app

1. Open the terminal and log in to the desired VTEX account using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).
2. Install the `vtexarg.product-highlight-by-vtex-segment` app on your account.
`1
vtex install vtexarg.product-highlight-by-vtex-segment
`
3. Open the VTEX Admin.
4. Go to **Account Settings > Apps > My apps**.
5. Look for the **Product Highlight by VTEX Segment** app and click on **Settings**.
![{"base64":"  ","img":{"width":1932,"height":1374,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":193466,"url":"https://user-images.githubusercontent.com/55905671/143299640-21b00a57-64bc-467c-917b-34a16d44bc51.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/55905671/143299640-21b00a57-64bc-467c-917b-34a16d44bc51.png)
6. Fill in the presented fields as in the following:
   * **Default Seller Id** \- Enter the default seller ID to use in cases the shopper's region is not detected (e.g., `jumboargentinav692lanus692`).
   * **Default Collection Name** \- Enter the name of the collection corresponding to the default seller ID (e.g., `leyDeGondolas`). This is the `{defaultCollectionName}` part of the **Collection Name** (_See [Before you start](#before-you-start) for more information_).
   * **Image Url of Highlight** \- Enter the URL of the ximage badge that will highlight the products. For example:
   ![{"base64":"  ","img":{"width":80,"height":80,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":1764,"url":"https://user-images.githubusercontent.com/60782333/152064990-8990c5a7-3549-49c9-91b0-3bc3ad7604fb.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/60782333/152064990-8990c5a7-3549-49c9-91b0-3bc3ad7604fb.png)
7. Click on **Save**.

### Adding the Product Highlights component to your store theme

1. Open your store theme in any code editor of your choice.
2. Open the `manifest.json` file and add the `vtexarg.product-highlight-by-vtex-segment` app as a peer dependency of your theme:
`1
"peerDependencies": {
2
 ...
3
+ "vtexarg.product-highlight-by-vtex-segment": "0.x"
4
 ...
5
}
`
3. Add the `product-highlight-by-vtex-segment` block to any child of the `store.product` template (Product Details Page template). For example:
`1
"store.product": {
2
 "children": [
3
 "flex-layout.row#product-main",
4
 ]
5
},
6
"flex-layout.row#product-main": {
7
 "children": [
8
 "flex-layout.col#right-col"
9
 ]
10
},
11
"flex-layout.col#right-col": {
12
 "children": [
13
+ "product-highlight-by-vtex-segment"
14
 ]
15
}
`

Now, see the [Customization](#customization) section to add custom styles to your component.

After [linking your store theme app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-linking-an-app) in a development workspace, you'll be able to select a Whitelabel Seller available in your region from a dropdown menu list.

![{"base64":"  ","img":{"width":2880,"height":1592,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":350291,"url":"https://user-images.githubusercontent.com/55905671/143302341-6ba9d940-185f-4c9a-98c5-cb158f285d03.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/55905671/143302341-6ba9d940-185f-4c9a-98c5-cb158f285d03.png)

You'll then be able to see the chosen badge in the product cards of the selected Whitelabel Seller's collection.

![{"base64":"  ","img":{"width":2880,"height":1584,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":518673,"url":"https://user-images.githubusercontent.com/55905671/143302850-e8d39857-ffb6-49fc-b1cf-a7496733ac4c.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/55905671/143302850-e8d39857-ffb6-49fc-b1cf-a7496733ac4c.png)

## Customization

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

| CSS Handles                            |
| -------------------------------------- |
| productHighlightByVtexSegmentContainer |
| imageOfHighlight                       |

---

[Product Gifts« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-gifts)[Product Specification BadgesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtex.product-specification-badges)

See also

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

ON THIS PAGE

[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.product-highlight-by-vtex-segment%23before-you-start)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.product-highlight-by-vtex-segment%23configuration)

[Setting up the Product Highlights app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.product-highlight-by-vtex-segment%23setting-up-the-product-highlights-app)

[Adding the Product Highlights component to your store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.product-highlight-by-vtex-segment%23adding-the-product-highlights-component-to-your-store-theme)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.product-highlight-by-vtex-segment/docs/apps/vtexarg.product-highlight-by-vtex-segment%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=)