API archive entry · source-reported
Marketplace Protocol
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 Here you will find the endpoints involved in the integration between a VTEX marketplace and an external seller. Note that some of these requests are typically sent by the seller while others are received. | **Request** | **From** | **To** | |-|-|-| | Fulfillment simulation | Marketplace | Seller | | Order placement | Marketplace | Seller | | Authorize fulfillment | Marketplace | Seller | | Marketplace order cancellation | Marketplace | Seller | | Send invoice | Seller | Marketplace | | Send tracking information | Seller | Marketplace | | Update tracking status | Seller | Marketplace | | Cancel order in marketplace | Seller | Marketplace | For a detailed explanation of the steps required to develop a custom connector to sell products from an external seller in your storefront, check out our complete External Seller Integration Guide. ## External Marketplace In this section, you will find the endpoints involved in the VTEX integration between an external marketplace and a VTEX seller.
Plan the first integration safely
The access fields below come from the connected directory. Their likely implementation impact is explained without assuming provider-specific behavior.
Authentication
OAuth is reported. Confirm flows, scopes, consent, token lifetime, and refresh rules.
Transport
HTTPS is not confirmed. Do not send credentials or production data until secure transport is verified.
Browser access
CORS is unknown. Treat direct browser access as unconfirmed and test before choosing a client-only architecture.
First-request sequence
- Identify the current base URL, version, and endpoint for the use case.
- Confirm how credentials are issued and where they may be stored.
- Test success, invalid input, throttling, unavailable data, and timeouts.
- Record response fields, pagination, caching, and error shapes.
- Add monitoring, retries with backoff, and an appropriate fallback.
Questions to resolve before production
Pricing and quotas
Confirm current plans, free-tier limits, overages, and request ceilings.
Endpoint coverage
Check that the operations and response fields match the intended workload.
Reliability
Look for uptime history, a status page, support routes, and service commitments.
Data and privacy
Review retention, licensing, regional processing, and compliance requirements.
Versioning
Confirm the active version, change policy, deprecation window, and migration guidance.
Developer experience
Validate SDKs, examples, error formats, pagination, and test environments.
Source reference
This page separates source-reported facts from questions that need live provider verification.