API Marketplace Protocol
Consulte Marketplace Protocol, do provedor vtex.local, versão 1.0: documentação, especificação OpenAPI 3.0.0 e referências para planejar a integração.
vtex.local · Versão 1.0
Conheça a plataforma
O que integrar com Marketplace Protocol
Descrição técnica preservada da especificação de origem. A versão do contrato ajuda a identificar a API; confirme a disponibilidade atual no fornecedor.
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. | Request | From | To | |-|-|-| | VTEX Mapper Registration | External marketplace | VTEX system | | Send Category Mapping to VTEX Mapper | External marketplace | VTEX system | | Authorize fulfillment | Marketplace | Seller | | Place fulfillment order | External marketplace | VTEX Seller | | Authorize dispatch for fulfillment order | External marketplace | VTEX Seller | For a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete External Marketplace Integration Guide.
Ficha técnica
Como funciona a integração
Versões, permissões, preços e limites podem mudar. Consulte a documentação da plataforma antes de implementar.
Do planejamento à produção
Checklist para integrar Marketplace Protocol
- Defina o fluxo. Identifique quais dados precisam circular, o sistema de origem e o resultado esperado.
- Leia os requisitos oficiais. Verifique acesso à API, plano necessário, versão e ambiente de testes.
- Configure o acesso com segurança. Guarde credenciais secretas no servidor e conceda apenas as permissões necessárias. Restrinja chaves públicas conforme a documentação do fornecedor.
- Teste a primeira requisição. Valide os campos, a paginação e o formato de resposta com dados de teste.
- Prepare o tratamento de falhas. Considere limites de requisição, retentativas com espera e prevenção de operações duplicadas.
- Acompanhe a integração. Registre erros sem expor dados sensíveis e monitore alterações na API.