-
Notifications
You must be signed in to change notification settings - Fork 100
EDU-10181 | Update marketplace integration overview #2708
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
5bf7890
5a662dd
00d49b9
a00bb45
12f803c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [markdownlint] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [markdownlint] reported by reviewdog 🐶 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,10 +3,14 @@ title: "Marketplace" | |
| slug: "marketplace-overview" | ||
| hidden: false | ||
| createdAt: "2023-07-19T17:08:52.219Z" | ||
| updatedAt: "2023-07-19T17:08:52.219Z" | ||
| updatedAt: "2026-05-29T00:00:00.000Z" | ||
| excerpt: "Integration guide for VTEX or external Marketplaces and Sellers" | ||
| hidePaginationPrevious: false | ||
| hidePaginationNext: false | ||
| seeAlso: | ||
| - "/docs/guides/getting-started-with-storefront-solutions" | ||
| - "/docs/guides/multilevel-omnichannel-inventory" | ||
| - "/docs/guides/orders-overview" | ||
| --- | ||
|
|
||
| >ℹ️ Help us improve our documentation! Tell us about your experience with this article by filling out [this form](https://forms.gle/fQoELRA1yfKDqmAb8). | ||
|
|
@@ -32,16 +36,89 @@ The actions that can be performed via API are the following: | |
|
|
||
| - [Adding seller](#1-marketplace-adding-sellers) | ||
| - [Configuring seller selection at checkout](https://developers.vtex.com/docs/guides/checkout-overview) | ||
| - [Configure storefront](https://developers.vtex.com/docs/guides/getting-started-3) | ||
| - [Customizing the marketplace storefront](#customizing-the-marketplace-storefront) | ||
| - [Configure payments](https://developers.vtex.com/docs/guides/payments-integration-guide) | ||
|
|
||
| ## Customizing the marketplace storefront | ||
|
anabaarbosa marked this conversation as resolved.
|
||
|
|
||
|
anabaarbosa marked this conversation as resolved.
|
||
| As a VTEX marketplace, your storefront is where approved seller offers are displayed and where shoppers complete checkout. After integrating sellers and cataloging offers, you can customize how products and seller information appear to customers. | ||
|
|
||
| The customization approach depends on your storefront technology. See [Getting started with storefront solutions](https://developers.vtex.com/docs/guides/getting-started-with-storefront-solutions) to compare FastStore, Store Framework, and CMS Portal (Legacy), including marketplace support for each option. | ||
|
|
||
| ### Store Framework | ||
|
|
||
|
anabaarbosa marked this conversation as resolved.
|
||
| With Store Framework, you customize the storefront by composing blocks exported by VTEX apps in your theme. For marketplace specific use cases, see [Displaying sellers and approved offers](#displaying-sellers-and-approved-offers). | ||
|
|
||
| - [Store Framework](https://developers.vtex.com/docs/guides/store-framework) | ||
| - [Seller Selector](https://developers.vtex.com/docs/guides/vtex-seller-selector) | ||
| - [Using CSS handles for store customizations](https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) | ||
| - [Working with Site Editor](https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor) | ||
|
|
||
| ### FastStore | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Aqui serve para qualquer versão da FastStore? Pergunto por que temos 4 versões, mas a mais atualizada, que está recebendo novas contas, é a FastStore v4. Então, checaria com o pessoal se essa customização serve para todas as versões da FastStore ou apenas para a mais recente, FastStore v4. cc.: @manuellacorreia Pontos que precisam de esclarecimentos aqui:
Algumas diferenças entre as versões podem ser encontradas nesta doc. |
||
|
|
||
|
anabaarbosa marked this conversation as resolved.
|
||
| FastStore does not provide a native seller selector component. To display seller information or offers in a custom way, you can override existing components or create a new section to build the storefront content your marketplace needs. | ||
|
|
||
| - [Overrides overview](https://developers.vtex.com/docs/guides/faststore/overrides-overview) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Documentação para Faststore v3. Se for possível fazer para v4, a nova documentação está sendo revisada pelo time e publicaremos ainda em junho. |
||
| - [Creating a new section](https://developers.vtex.com/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section) | ||
| - [Using themes overview](https://developers.vtex.com/docs/guides/faststore/using-themes-overview) | ||
|
|
||
| ### Common marketplace storefront customizations | ||
|
|
||
| Beyond the storefront technology guides above, there are marketplace-specific behaviors that affect what shoppers see, regardless of your storefront stack. These are driven by catalog and seller settings rather than by the theme alone, as described in the sections below. | ||
|
|
||
| #### Displaying sellers and approved offers | ||
|
|
||
| When more than one seller offers the same SKU, you can let shoppers compare offers and choose where to buy. In Store Framework, the [Seller Selector](https://developers.vtex.com/docs/guides/vtex-seller-selector) app renders the available sellers for a product, including price, shipping, and a buy button per seller. | ||
|
|
||
| To enable it, add the `link-seller` block to your product page (`store.product`) template. It displays a link with the number of sellers for the product and opens the Seller Selector page: | ||
|
|
||
| ```json | ||
| "flex-layout.col#right-col": { | ||
| "props": { | ||
| "preventVerticalStretch": true, | ||
| "rowGap": 0 | ||
| }, | ||
| "children": [ | ||
| "product-name", | ||
| "link-seller", | ||
| "product-price#product-details", | ||
| "flex-layout.row#buy-button" | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Não tenho certeza se seria o caso de abordar aqui, mas precisamos abordar o FastCheckout também? Acho que Karen pode ajudar. |
||
| Keep in mind that an approved offer is only displayed in the storefront if the seller is mapped to the [Sales channel](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV) used by that store. If an offer is approved but does not appear in the storefront, the trade policy mapping is the first thing to check. | ||
|
|
||
| #### Controlling price and availability before the shopper sets a location | ||
|
|
||
| During navigation stages where the store does not yet know the shopper's location (such as the home page, category pages, and shelves), the storefront cannot evaluate every seller's delivery area. In this context, VTEX shows price and availability based only on the main seller and on comprehensive sellers. | ||
|
|
||
| A seller is comprehensive when its `isBetterScope` property is set to `true`, which tells VTEX that its products can be shown in navigation contexts without a defined location. This behavior also applies in the cart until the shopper informs a delivery ZIP code. | ||
|
|
||
| Set a seller as comprehensive only when its delivery area is relevant to most of your customer base. If you set a seller with restricted coverage as comprehensive, shoppers may see price and availability that do not apply to their region, and they will only find out after entering the ZIP code, hurting the experience. | ||
|
|
||
| #### Seller selection at checkout | ||
|
|
||
| When multiple sellers offer the same SKU, the [white label seller selection algorithm](https://help.vtex.com/en/tutorial/white-label-sellers-selection-algorithm--3MemNQ4pKkWCpMdzI27AHa) determines which seller fulfills the item, considering criteria such as price and delivery conditions for the shopper's address. To configure how sellers are selected and displayed during checkout, see [Checkout overview](https://developers.vtex.com/docs/guides/checkout-overview). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [link-check] reported by reviewdog 🐶 👉 Please review this link before merging your Pull Request. |
||
|
|
||
| ## Integrating External Marketplaces or External Sellers | ||
|
|
||
| The Marketplace Protocol is a set of API requests and definitions to help you integrate external sellers into a VTEX marketplace, as well as external marketplaces into VTEX sellers. | ||
|
|
||
| - **External seller protocol:** If you are a VTEX marketplace and want to integrate offers from an external seller into your catalog, see our [External Seller Integration Guide](https://developers.vtex.com/docs/guides/external-seller-integration-guide). | ||
| - **External marketplace protocol:** If you are an external marketplace that wants to integrate with a VTEX seller, see [External Marketplace Integration Guide](https://developers.vtex.com/docs/guides/external-marketplace-integration-guide) to learn how to develop a custom connector to integrate with the architecture and catalog of VTEX sellers. | ||
|
|
||
| ### Phase overview | ||
|
|
||
|
anabaarbosa marked this conversation as resolved.
|
||
| After choosing the appropriate integration model, the marketplace workflow can be broken down into four main phases. | ||
|
|
||
| | Phase | Section | Main actors | | ||
| | --- | --- | --- | | ||
| | Seller onboarding | [1. Marketplace: Adding Sellers](#1-marketplace-adding-sellers) | Marketplace, Seller | | ||
| | Suggestions | [2. Sending and managing suggestions](#2-sending-and-managing-suggestions) | Seller | | ||
| | Cataloging | [3. Marketplace: Cataloging offers](#3-marketplace-cataloging-offers) | Marketplace | | ||
| | Ongoing sync | [4. Managing Catalog](#4-managing-catalog) | Seller, Marketplace | | ||
|
|
||
| ## 1. Marketplace: Adding Sellers | ||
|
|
||
| VTEX marketplaces that want to make products from sellers available in their store must go over some processes. The first step is to find out if the seller you want to connect to is a VTEX seller or an external seller. For *external sellers*, verify the [External Seller Integration Guide](https://developers.vtex.com/docs/guides/external-seller-integration-guide) and for *VTEX sellers*, follow the steps below. | ||
|
|
@@ -106,6 +183,24 @@ The query and management of applied commission rules will be performed through t | |
|
|
||
| When completing the steps listed above, the marketplace will have completed the integration of a seller into its store. | ||
|
|
||
| ## Multilevel Omnichannel Inventory (MOI) | ||
|
|
||
| [Multilevel Omnichannel Inventory (MOI)](https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory) is a VTEX setting that allows franchise accounts or white label sellers' inventory to be sold in marketplaces connected to the main seller account — without integrating each franchise individually with the marketplace. | ||
|
|
||
| In a three-level architecture, the marketplace (level 1) sells products fulfilled by franchise accounts or white label sellers (level 3) through a direct seller (level 2). Orders follow the [chain order flow](https://developers.vtex.com/docs/guides/orders-overview#chain-flow). | ||
|
|
||
| > ⚠️ MOI is available only for integrations between VTEX marketplaces and VTEX sellers. The feature has been [discontinued for external marketplaces](https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration). | ||
|
|
||
| ### Configuring MOI via API | ||
|
|
||
| When adding or updating a seller, configure MOI through the [Configure Seller Account](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/seller-register/pvt/sellers) endpoint by setting the `fulfillmentEndpoint` field. See [Setup for VTEX marketplaces](https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory#setup-for-vtex-marketplaces) for the required format and parameters. | ||
|
|
||
| For a complete integration guide, see: | ||
|
|
||
| - [Multilevel Omnichannel Inventory](https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory) | ||
| - [Multilevel Omnichannel Inventory API integration](https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration) | ||
| - [Integrating with the Multilevel Omnichannel Inventory](https://developers.vtex.com/docs/guides/orders-overview#integrating-with-the-multilevel-omnichannel-inventory) (Orders overview) | ||
|
|
||
| ## 2. Sending and managing suggestions | ||
|
|
||
| When the seller is integrated into a marketplace, it will begin to suggest products from its catalog to the marketplace. The APIs mentioned in this section refer to the [Received SKUs](https://help.vtex.com/en/tutorial/manual-sku-cataloging--tutorials_396) page of VTEX Admin. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[link-check] reported by reviewdog 🐶
🚨 Found a broken link in a Markdown Link (Error 404):
https://help.vtex.com/en/tutorial/offer-management--7MRb9S78aBdZjFGpbuffpE
dev-portal-content/docs/guides/Getting-Started/marketplace-overview.md
Line 277 in 12f803c