Saltar al contenido
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

ArgumentoTipoPredeterminadoRegla
searchString—Busca en nombre, slug, descripción y tipo. Hasta 200 caracteres.
sortNavigationSearchSortNombre ascendenteVer la tabla siguiente.
limitIntTodasDe 1 a 100. Un valor fuera de rango se ajusta al extremo más cercano.
ValorOrden
DEFAULT, NAME_ASC, ORDER_ASC, ORDER_DESCNombre de la A a la Z.
NAME_DESCNombre de la Z a la A.
NEWESTMás recientes primero; a igualdad, por nombre.
UPDATED_DESCActualizadas hace menos primero; a igualdad, por nombre.

CollectionItem

CampoTipoDescripción
idString!ID de la colección.
slugString!Slug de la URL de la colección.
nameString!Nombre.
descriptionStringDescripción, o null si está vacía.
imageUrlStringURL de la imagen, o null.
typeString!Tipo de colección, por ejemplo Manual.
productCountInt!Productos publicados en la colección.
templateStringPlantilla asignada en el tema.
products[ProductSummary!]!Primeros productos. Ver Productos de cada colección.

Ejemplo

Collections.graphql
query Collections($search: String, $sort: NavigationSearchSort) {
  collections(search: $search, sort: $sort) {
    id
    slug
    name
    description
    imageUrl
    type
    productCount
  }
}
Terminal
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" }
  }'
Respuesta
{
  "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!]!
ArgumentoTipoPredeterminadoRegla
limitInt8De 1 a 24. Un valor fuera de rango se ajusta al extremo más cercano.
sortProductSearchSortOrden de la colecciónSin 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 }).

CollectionsWithProducts.graphql
query CollectionsWithProducts($limit: Int, $productLimit: Int) {
  collections(limit: $limit) {
    id
    slug
    name
    products(limit: $productLimit) {
      id
      name
      slug
      imageUrl
      price
      compareAtPrice
    }
  }
}
Variables
{
  "limit": 4,
  "productLimit": 8
}
Respuesta
{
  "data": {
    "collections": [
      {
        "id": "7204558912004325401",
        "slug": "verano",
        "name": "Verano",
        "products": [
          {
            "id": "456",
            "name": "Taza",
            "slug": "taza",
            "imageUrl": "/taza.jpg",
            "price": 10,
            "compareAtPrice": null
          }
        ]
      }
    ]
  }
}

Errores

CódigoCausa
BAD_USER_INPUTsearch tiene más de 200 caracteres.
STORE_CONTEXT_REQUIREDx-Store-Domain falta o no corresponde a una tienda.

Equivalente REST

GET /v1/collections devuelve la misma lista, sin limit ni products.

Última actualización:

En esta página