Saltar al contenido
Consultas

route

Qué hay publicado en una ruta de la tienda: producto, categoría, marca, colección o redirección.

route dice qué hay publicado en una ruta de la tienda y lo devuelve completo. Úsala en la ruta comodín de tu frontend.

route(path: String!, previewKey: String): UrlResolution

Argumentos

ArgumentoTipoRegla
pathString!La ruta, sin dominio ni query. Vacía responde BAD_USER_INPUT.
previewKeyStringLa clave del enlace de vista previa del admin. Con una clave válida, también llega un producto sin publicar.

Si nada coincide, route llega como null.

UrlResolution

CampoTipoDescripción
kindString!product, category, brand, collection o redirect.
urlString!La URL vigente del recurso.
handleStringEl slug del recurso. null con redirect.
productProductDetailLa ficha, con kind: "product". Ver product.
categoryCategoryDetailLa categoría, con kind: "category".
brandBrandDetailLa marca, con kind: "brand". Ver brand.
collectionCollectionItemLa colección, con kind: "collection". Ver collections.
  • Con redirect, redirige con 301 a url. Pasa con URLs viejas, en mayúsculas o con / al final.
  • Un producto sin publicar que llega con previewKey trae isPreview: true: no lo guardes en caché ni lo indexes.

CategoryDetail

CampoTipoDescripción
idString!ID de la categoría.
nameString!Nombre.
slugString!Slug.
urlString!Ruta pública de la categoría.
descriptionStringDescripción.
imageUrlStringImagen.
metaTitleStringTítulo para buscadores.
metaDescriptionStringDescripción para buscadores.
parentIdStringID de la categoría padre.
productCountInt!Cantidad de productos.
ancestors[CategoryLink!]!De la raíz al padre, para las migas.
children[CategoryItem!]!Subcategorías.
products(input: StorefrontProductsInput)SearchResult!Productos de la categoría y de sus subcategorías.

products acepta el mismo input que products e ignora categories.

TipoCampos
CategoryLinkid: String!, name: String!, url: String!
CategoryItemid: String!, name: String!, slug: String!, url: String!, imageUrl: String, parentId: String, path: String!, order: Int!, productCount: Int!

Ejemplo

Route.graphql
query Route($path: String!) {
  route(path: $path) {
    kind
    url
    product { id name price }
    category {
      id
      name
      ancestors { name url }
      products(input: { pageSize: 24, includeFilters: false }) {
        totalPages
        products { id name url imageUrl price }
      }
    }
    brand { id name }
    collection { id name }
  }
}
Terminal
curl --request POST "https://storefront.ecomiq.pe/graphql" \
  --header "Content-Type: application/json" \
  --header "x-Store-Domain: mi-tienda" \
  --data-binary '{
    "query": "query Route($path: String!) { route(path: $path) { kind url product { id name price } category { id name ancestors { name url } products(input: { pageSize: 24, includeFilters: false }) { totalPages products { id name url imageUrl price } } } brand { id name } collection { id name } } }",
    "variables": { "path": "/categories/polos" }
  }'
Respuesta
{
  "data": {
    "route": {
      "kind": "category",
      "url": "/categories/polos",
      "product": null,
      "category": {
        "id": "7204558912004327982",
        "name": "Polos",
        "ancestors": [{ "name": "Hombre", "url": "/categories/hombre" }],
        "products": {
          "totalPages": 1,
          "products": [
            {
              "id": "7204558912004322039",
              "name": "Polo de algodón pima",
              "url": "/products/polo-de-algodon-pima",
              "imageUrl": "https://…/polo.webp",
              "price": 59.9
            }
          ]
        }
      },
      "brand": null,
      "collection": null
    }
  }
}

Errores

CódigoCausa
BAD_USER_INPUTpath vacío.
STORE_CONTEXT_REQUIREDx-Store-Domain falta o no corresponde a una tienda.

Equivalente REST

GET /v1/urls/resolve devuelve lo mismo, sin los campos que solo tiene GraphQL, como products o related. Si nada coincide, responde 404 Url.NotFound.

Última actualización:

En esta página