Quick Reference
magento-2Link para a lista completa e oficial de todos os endpoints REST, por módulo.
/rest/V1/schema?services=all
Schema OpenAPI/Swagger + Quick Reference oficial
Quick Reference oficial
Para a lista exaustiva de TODOS os endpoints REST (incluindo os raramente documentados), consulte sempre a Quick Reference oficial mantida pela Adobe:
Adobe Commerce REST API Quick Reference
Esta página lista todos os endpoints agrupados por módulo com:
- HTTP method
- URL pattern
- Service class (ACL) necessária
- Link para o código-fonte no GitHub
Gerar a referência a partir da sua instalação
A melhor fonte da verdade é sua própria instalação, pois extensões de terceiros adicionam endpoints. Existem duas formas:
1. Schema OpenAPI/Swagger
O Magento expõe um schema completo em:
https://<seu-host>/rest/<store-code>/schema?services=all
Isso retorna um JSON no formato OpenAPI 2.0 (Swagger) com todas as rotas, parâmetros e tipos. Use em ferramentas como Postman, Insomnia ou Swagger UI.
2. Endpoint específico por serviço
https://<seu-host>/rest/<store-code>/schema?services=catalogProductRepositoryV1,salesOrderRepositoryV1
Dicas (PT-BR)
- Extensões (Stripe, Mercado Pago, etc.) adicionam endpoints em
/V1/...mas raramente na documentação oficial — sempre consulte o schema da sua instalação. - Rotas com
/asynce/async/bulkexistem automaticamente para quase todos os endpoints POST/PUT/DELETE. - A versão de API (
V1) é estável desde o Magento 2.0 — use com segurança.