Referência completa da Storefront GraphQL API — todas as queries, mutations e objetos.
Todas as operações são enviadas via POST para:
/graphql
Inclua credentials: 'include' para enviar cookies de sessão automaticamente.
Operações de leitura para buscar dados da loja.
client Dados completos da loja: produtos, menus, seções, ferramentas.
shoppingCart Carrinho de compras do visitante atual.
order Detalhes de um pedido específico.
auth Estado de autenticação do visitante.
product / products Buscar um ou mais produtos pelo ID global Relay.
Operações de escrita. Todas seguem a convenção Relay com input object.
clientLogin Login com email e senha.
clientSignup Criar conta de cliente.
clientGoogleLogin Login via Google OAuth.
addShoppingCartItem Adicionar produto ao carrinho.
removeShoppingCartItem Remover item do carrinho.
checkCouponOnShoppingCart Verificar validade de cupom.
updateCouponOnShoppingCart Aplicar ou remover cupom.
calculateShipping Calcular frete por CEP.
updateShippingType Selecionar tipo de frete.
storeShoppingCartInfo Salvar dados do comprador.
updateUser Atualizar dados do perfil.
updateUserAddress Atualizar endereço.
createReview Criar avaliação de produto.
track Registrar evento de analytics.
lead Captura de leads.
saveDiscountModalUserData Salvar dados do modal de desconto.
Principais types retornados pela API.
Store Informações da loja.
Product Produto da loja.
ShoppingCart Carrinho de compras.
Order Pedido do cliente.
Image Imagem de produto ou loja.
Coupon Cupom de desconto.
ShippingOption Opção de frete disponível.
ReviewSummary Resumo de avaliações.
Section Seção customizável da homepage.
Menu Menu de navegação da loja.
Category Categoria de produtos.
PageInfo Informação de paginação Relay.
AdBar Barra de anúncios com mensagens rotativas.
Timer Temporizador de contagem regressiva.
Indicator Badges e indicadores de produtos.
CashDiscount Desconto para pagamento à vista (PIX).
DiscountModal Popup modal de desconto para leads.
SocialProofEvent Eventos de prova social.
Funnel Funil de upsell com ofertas.
PublicPaymentGateway Chave pública do gateway de pagamento.
PageElement Elemento customizável de páginas.
AutocompleteProduct Resultado de busca com autocompletar.
Conceitos fundamentais da API.
Autenticação Cookies httpOnly, sessão, credenciais e fluxos de login.
Paginação Paginação Relay cursor-based com connections.
Global IDs IDs globais Relay, nodes e edges.
Erros Códigos de erro, formato e estratégias de retry.
Rate Limits Sistema de token bucket por hostname com custos por operação.
Versionamento Evolução de schema, deprecation e header X-API-Version.
Modos de Integração Três formas de integrar: hospedagem na plataforma, proxy reverso, ou Bearer token.
POST /graphql
Content-Type: application/json
Cookie: (httpOnly automático)
{
"query": "query { ... }",
"variables": { "hostname": "minha-loja" }
}{
"data": { ... },
"errors": null
}{
"data": null,
"errors": [{
"message": "Product not found",
"path": ["client", "products"],
"extensions": {
"code": "NOT_FOUND"
}
}]
}