GraphQL
Compón lecturas de tienda, productos, colecciones, vendedores y reseñas mediante POST /graphql.
Última actualización:
GraphQL es un método adicional para consumir lecturas seleccionadas de Storefront API. REST conserva el contrato completo y sigue siendo la interfaz para todas las escrituras.
GraphQL y REST conviven
Usa GraphQL cuando una pantalla necesite combinar varias lecturas o seleccionar pocos campos. Usa REST para carritos, checkout, clientes, geografía, tracking, analítica y cualquier operación que modifique datos.
Inicio rápido
Envía un documento mediante POST y resuelve la tienda con x-Store-Domain:
curl --request POST "https://storefront.ecomiq.pe/graphql" \
--header "Content-Type: application/json" \
--header "x-Store-Domain: mi-tienda" \
--data-binary '{
"query": "query Store { store { id name currency language } }"
}'{
"data": {
"store": {
"id": "7204558912004325301",
"name": "Mi tienda",
"currency": "PEN",
"language": "es"
}
}
}Los IDs son strings opacos. Guárdalos y reenvíalos sin interpretar su formato.
Consultas disponibles
Estas son todas las lecturas publicadas actualmente en la raíz Query:
store
Identidad, branding básico, tipo, moneda e idioma de la tienda.
products
Búsqueda paginada con filtros, facetas y orden.
product
Detalle completo de un producto por slug.
relatedProducts
Productos relacionados a partir de un ID.
collections
Colecciones visibles con búsqueda y orden.
collection
Una colección publicada por slug.
sellers
Vendedores visibles y su reputación pública.
seller
Perfil público y políticas de un vendedor.
productReviews
Reseñas con cursor, búsqueda, rating y orden.
Elegir GraphQL o REST
| Necesidad | Interfaz recomendada |
|---|---|
| Combinar tienda, seller y productos en una respuesta | GraphQL |
| Pedir solo algunos campos de un recurso | GraphQL |
| Buscar productos con filtros equivalentes al catálogo REST | GraphQL o REST |
| Crear o actualizar carrito, checkout o cliente | REST |
| Consultar geografía, tracking o analítica | REST |
| Consumir un contrato OpenAPI o una colección Postman | REST |
El schema actual expone Query y no expone Mutation. La referencia REST documenta el resto de Storefront API.
Explora por tarea
Primeros pasos
Ejecuta tu primera consulta con cURL, fetch y @ecomiq/storefront.
Ejemplos y recetas
Construye una PLP, una PDP, un catálogo de seller y paginación de reseñas.
Schema y tipos
Consulta campos raíz, inputs, enums, objetos y límites.
Errores
Maneja data, errors, códigos públicos y GraphQLResponseError.