Passer au contenu principal

Aperçu

Accédez aux informations publiques de votre boutique, notamment le nom, la description, le logo, la bannière et les paramètres de devise.

Obtenir les détails de la boutique

Récupérez les informations complètes sur votre boutique.
const response = await komerza.getStore();

Retours

Retourne ApiResponse<Store> :
interface Store {
  id: string; // Identifiant de la boutique
  name: string; // Nom de la boutique
  description: string; // Description de la boutique (supporte le markdown)
  url: string; // Sous-domaine de la boutique
  customDomain?: string; // Domaine personnalisé si défini
  currencyCode: string; // Code devise ISO 4217 (ex. "USD")
  domain: string; // Domaine complet
  rating: number; // Note moyenne de la boutique
  maintenanceReason?: string; // Si la boutique est en mode maintenance
  branding?: {
    iconFileName?: string; // Nom du fichier logo
    bannerFileName?: string; // Nom du fichier bannière
    accentColor?: string; // Couleur d'accent de la boutique
    isAutomaticCurrencyConversionEnabled?: boolean;
  };
  products: ProductReference[]; // Liste des produits
  categories: Category[]; // Liste des catégories
  affiliateOptions?: {
    isEnabled: boolean;
    defaultReturnPercentage: number;
    defaultPercentageOff: number;
    canConvertAffiliateBalance: boolean;
    isPublicRegistrationEnabled: boolean;
    isLinkEditingEnabled: boolean;
  };
  dateCreated: string; // Horodatage ISO 8601
}

interface Category {
  id: string;
  name: string;
  slug: string;
  visibility: number;
  order: number;
  storeId: string;
  productCount: number;
  products: string[]; // Liste des IDs produits
  dateCreated: string;
}

Exemple

// Afficher les informations de la boutique
async function afficherInfosBoutique() {
  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} produits`;

    console.log(`La boutique utilise la devise ${store.currencyCode}`);
  }
}

Obtenir le logo de la boutique

Obtenez l’URL du logo de votre boutique.
const logoUrl = await komerza.getStoreLogoUrl();

Retours

Retourne une chaîne contenant l’URL complète vers l’image du logo.

Exemple

// Afficher le logo de la boutique
async function afficherLogo() {
  const logoUrl = await komerza.getStoreLogoUrl();

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

Obtenir la bannière de la boutique

Obtenez l’URL de la bannière de votre boutique.
const bannerUrl = await komerza.getStoreBannerUrl();