Consultas
collections
Colecciones publicadas de la tienda, con búsqueda, orden y sus primeros productos.
collections devuelve las colecciones publicadas de la tienda, con su cantidad de productos y, si los pides, sus primeros productos.
collections(search: String, sort: NavigationSearchSort, limit: Int): [CollectionItem!]Argumentos
| Argumento | Tipo | Predeterminado | Regla |
|---|---|---|---|
search | String | — | Busca en nombre, slug, descripción y tipo. Hasta 200 caracteres. |
sort | NavigationSearchSort | Nombre ascendente | Ver la tabla siguiente. |
limit | Int | Todas | De 1 a 100. Un valor fuera de rango se ajusta al extremo más cercano. |
NavigationSearchSort
| Valor | Orden |
|---|---|
DEFAULT, NAME_ASC, ORDER_ASC, ORDER_DESC | Nombre de la A a la Z. |
NAME_DESC | Nombre de la Z a la A. |
NEWEST | Más recientes primero; a igualdad, por nombre. |
UPDATED_DESC | Actualizadas hace menos primero; a igualdad, por nombre. |
CollectionItem
| Campo | Tipo | Descripción |
|---|---|---|
id | String! | ID de la colección. |
slug | String! | Slug de la URL de la colección. |
name | String! | Nombre. |
description | String | Descripción, o null si está vacía. |
imageUrl | String | URL de la imagen, o null. |
type | String! | Tipo de colección, por ejemplo Manual. |
productCount | Int! | Productos publicados en la colección. |
template | String | Plantilla asignada en el tema. |
products | [ProductSummary!]! | Primeros productos. Ver Productos de cada colección. |
Ejemplo
query Collections($search: String, $sort: NavigationSearchSort) {
collections(search: $search, sort: $sort) {
id
slug
name
description
imageUrl
type
productCount
}
}curl --request POST "https://storefront.ecomiq.pe/graphql" \
--header "Content-Type: application/json" \
--header "x-Store-Domain: mi-tienda" \
--data-binary '{
"query": "query Collections($search: String, $sort: NavigationSearchSort) { collections(search: $search, sort: $sort) { id slug name description imageUrl type productCount } }",
"variables": { "search": "verano", "sort": "NAME_ASC" }
}'{
"data": {
"collections": [
{
"id": "7204558912004325401",
"slug": "verano",
"name": "Verano",
"description": null,
"imageUrl": null,
"type": "Manual",
"productCount": 2
}
]
}
}Sin coincidencias, collections llega como [].
Productos de cada colección
products devuelve los primeros productos de cada colección, sin paginación ni facetas.
products(limit: Int, sort: ProductSearchSort): [ProductSummary!]!| Argumento | Tipo | Predeterminado | Regla |
|---|---|---|---|
limit | Int | 8 | De 1 a 24. Un valor fuera de rango se ajusta al extremo más cercano. |
sort | ProductSearchSort | Orden de la colección | Sin valor o con DEFAULT, respeta el orden de la colección, incluido el manual. Los valores están en Schema y tipos. |
El resultado es igual a la primera página de products con collectionId igual al id de la colección y pageSize igual a limit. Para paginar o filtrar, usa products(input: { collectionId }).
query CollectionsWithProducts($limit: Int, $productLimit: Int) {
collections(limit: $limit) {
id
slug
name
products(limit: $productLimit) {
id
name
slug
imageUrl
price
compareAtPrice
}
}
}{
"limit": 4,
"productLimit": 8
}{
"data": {
"collections": [
{
"id": "7204558912004325401",
"slug": "verano",
"name": "Verano",
"products": [
{
"id": "456",
"name": "Taza",
"slug": "taza",
"imageUrl": "/taza.jpg",
"price": 10,
"compareAtPrice": null
}
]
}
]
}
}Errores
| Código | Causa |
|---|---|
BAD_USER_INPUT | search tiene más de 200 caracteres. |
STORE_CONTEXT_REQUIRED | x-Store-Domain falta o no corresponde a una tienda. |
Equivalente REST
GET / devuelve la misma lista, sin limit ni products.
Última actualización: