Saltar al contenido principal

Descripción general

Accede a la información pública de tu tienda, incluyendo nombre, descripción, logo, banner y configuración de divisas.

Obtener detalles de la tienda

Recupera información completa sobre tu tienda.
const response = await komerza.getStore();

Retorna

Retorna ApiResponse<Store>:
interface Store {
  id: string; // Identificador de la tienda
  name: string; // Nombre de la tienda
  description: string; // Descripción de la tienda (soporta markdown)
  url: string; // Subdominio de la tienda
  customDomain?: string; // Dominio personalizado si está configurado
  currencyCode: string; // Código de divisa ISO 4217 (ej. "USD")
  domain: string; // Dominio completo
  rating: number; // Calificación promedio de la tienda
  maintenanceReason?: string; // Si la tienda está en modo mantenimiento
  branding?: {
    iconFileName?: string; // Nombre del archivo del logo
    bannerFileName?: string; // Nombre del archivo del banner
    accentColor?: string; // Color de acento de la tienda
    isAutomaticCurrencyConversionEnabled?: boolean;
  };
  products: ProductReference[]; // Lista de productos
  categories: Category[]; // Lista de categorías
  affiliateOptions?: {
    isEnabled: boolean;
    defaultReturnPercentage: number;
    defaultPercentageOff: number;
    canConvertAffiliateBalance: boolean;
    isPublicRegistrationEnabled: boolean;
    isLinkEditingEnabled: boolean;
  };
  dateCreated: string; // Marca de tiempo ISO 8601
}

interface Category {
  id: string;
  name: string;
  slug: string;
  visibility: number;
  order: number;
  storeId: string;
  productCount: number;
  products: string[]; // Lista de IDs de productos
  dateCreated: string;
}

Ejemplo

// Mostrar información de la tienda
async function mostrarInfoTienda() {
  const response = await komerza.getStore();

  if (response.success) {
    const store = response.data;

    document.getElementById("store-name").textContent = store.name;
    document.getElementById("store-description").textContent =
      store.description;
    document.getElementById("product-count").textContent =
      `${store.products.length} productos`;

    console.log(`La tienda usa divisa ${store.currencyCode}`);
  }
}

Obtener logo de la tienda

Obtén la URL de la imagen del logo de tu tienda.
const logoUrl = await komerza.getStoreLogoUrl();

Retorna

Retorna una cadena que contiene la URL completa de la imagen del logo.

Ejemplo

// Mostrar logo de la tienda
async function mostrarLogo() {
  const logoUrl = await komerza.getStoreLogoUrl();

  const img = document.createElement("img");
  img.src = logoUrl;
  img.alt = "Logo de la tienda";
  document.getElementById("logo-container").appendChild(img);
}

Obtener banner de la tienda

Obtén la URL de la imagen del banner de tu tienda.
const bannerUrl = await komerza.getStoreBannerUrl();