Saltar al contenido

Primeros pasos

Envía tu primera consulta GraphQL con variables desde cURL, JavaScript, Python o @ecomiq/core.

Esta guía pide la tienda y el perfil del vendedor acme en una sola consulta, con el slug como variable.

Requisitos

  • El slug de la tienda o uno de sus dominios. Va en el header x-Store-Domain de cada petición.
  • Para el ejemplo, una tienda de tipo marketplace con un vendedor acme.
ElementoValor
URLPOST https://storefront.ecomiq.pe/graphql
HeadersContent-Type: application/json y x-Store-Domain: <slug-o-dominio>
Body{ "query": "...", "variables": { ... } }

Escribe la consulta

SellerPage.graphql
query SellerPage($slug: String!) {
  store {
    id
    name
    currency
  }
  seller(slug: $slug) {
    id
    name
    slug
  }
}

$slug es String!, así que la petición debe incluirlo en variables:

Variables
{
  "slug": "acme"
}

Pasa los valores dinámicos, como el texto que escribe el comprador, siempre en variables.

Envía la consulta

Terminal
curl --request POST "https://storefront.ecomiq.pe/graphql" \
  --header "Content-Type: application/json" \
  --header "x-Store-Domain: mi-tienda" \
  --data-binary '{
    "query": "query SellerPage($slug: String!) { store { id name currency } seller(slug: $slug) { id name slug } }",
    "variables": { "slug": "acme" }
  }'

La respuesta trae exactamente los campos que seleccionaste, dentro de data:

Respuesta
{
  "data": {
    "store": {
      "id": "7204558912004325301",
      "name": "Mi tienda",
      "currency": "PEN"
    },
    "seller": {
      "id": "7204558912004325310",
      "name": "Acme",
      "slug": "acme"
    }
  }
}

Usa @ecomiq/core

createClient({ domain }) envía x-Store-Domain por ti. En un tema, store(context) de @ecomiq/storefront ya te devuelve ese cliente. graphql() recibe el documento, un schema de Zod para validar data y las variables:

seller-page.ts
import { createClient } from "@ecomiq/core";
import { z } from "zod";

const SellerPageData = z.object({
  store: z.object({
    id: z.string(),
    name: z.string(),
    currency: z.string(),
  }),
  seller: z.object({
    id: z.string(),
    name: z.string(),
    slug: z.string(),
  }),
});

const api = createClient({ domain: "mi-tienda" });

const data = await api.graphql(
  `
    query SellerPage($slug: String!) {
      store { id name currency }
      seller(slug: $slug) { id name slug }
    }
  `,
  SellerPageData,
  { slug: "acme" },
);

console.log(data.store, data.seller);

Si la respuesta trae errors o data no cumple el schema, graphql() lanza GraphQLResponseError.

Errores

Una respuesta con HTTP 200 puede traer errors. Revisa errors antes de leer data:

CódigoCausa
BAD_USER_INPUTUn argumento no es válido; por ejemplo, slug vacío o de más de 100 caracteres.
NOT_FOUNDEl vendedor no existe en la tienda.
STORE_CONTEXT_REQUIREDx-Store-Domain falta o no corresponde a una tienda.

Siguientes pasos

Última actualización:

En esta página