API Marketplace API
Consulte Marketplace API, 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 API
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 API enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. >⚠️ The marketplace must create an appKey and appToken for each non-VTEX seller that will use this API. Index Notification Endpoints used by sellers to notify marketplaces that the price or inventory language has changed for one of their SKUs. POST Notify marketplace of price update POST Notify marketplace of inventory update Suggestions Get Suggestions Search and filter all suggestions using specific criteria. GET Get all SKU Suggestions GET Get SKU Suggestion by ID Manage Suggestions Send or delete SKU suggestions from the seller to marketplace. PUT Send SKU Suggestion DELETE Delete SKU Suggestion Get Versions Search and filter all versions of suggestions, using specific criteria. GET Get all versions GET Get version by ID Match Received SKUs Match SKU suggestions received in the marketplace. PUT Match Received SKUs individually PUT Match Multiple Received SKUs SKU Approval Settings Allows marketplaces to configure rules for automatically and manually approving SKUs received from sellers. GETGet autoApprove Status in Account Settings PUTActivate autoApprove in Marketplace's Account GETGet Account's Approval Settings PUTSave Account's Approval Settings GETGet Seller's Approval Settings PUTSave Seller's Approval Settings PUTActivate autoApprove Setting for a Seller Matched Offers Offers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured. GETGet Matched Offers List GETGet Matched Offer's Data by SKU ID GETGet Matched Offer's Data by Product ID
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 API
- 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.