LogoLogo
Homepage
  • Documentations for PrestaShop 1.6
  • English documentation 1.6
    • Getting Started
      • What you need to get started
      • Installing PrestaShop
      • Installing PrestaShop on your computer
      • Installing PrestaShop using the command-line script
      • Updating and Uninstalling PrestaShop
      • Misc. information
    • Updating PrestaShop
      • Automatic update
      • Manual update
      • Making and restoring your own backup
      • In case of issues
    • User Guide
      • Training
      • Customizing your shop
      • Connecting to the PrestaShop back office
      • Discovering the Administration Area
      • Getting on board of PrestaShop
      • First steps with PrestaShop 1.6
      • Managing the Catalog
        • Managing Products
        • Managing Categories
        • Monitoring Your Catalog
        • Managing Product Attributes
        • Managing Product Features
        • Managing Manufacturers
        • Managing Suppliers
        • Building Image Maps
        • Managing Tags
        • Managing Attachments
      • Managing Orders
        • Orders
        • Invoices
        • Merchandise Returns
        • Delivery Slips
        • Credit Slips
        • Statuses
        • Order Messages
      • Managing Customers
        • Your customers
        • Customer addresses
        • Customer Groups
        • Shopping Carts
        • Customer Service
        • Your Contacts
        • Social Titles
        • Outstanding
      • Creating Price Rules and Vouchers
        • Cart Rules
        • Catalog price rules
        • Marketing modules
      • Managing Modules and Themes
        • Your Modules
        • Modules and Themes Catalog
        • Front office Positions
        • Payment Settings
      • Making the Native Modules Work
        • Administration modules
        • Advertising and Marketing modules
        • Analytics and Stats modules
        • Billing & Invoicing modules
        • Dashboard modules
        • Front Office Features modules
        • Mobile modules
        • Pricing and Promotions modules
        • SEO modules
        • Search and Filter modules
        • Shipping and Logistics modules
        • Site certification & Fraud prevention modules
        • Smart Shopping modules
        • Taxes & Invoicing modules
        • Translation modules
      • Managing Shipping
        • Managing Carriers
        • Shipping Preferences
      • Understanding Local Settings
        • Localization
        • Languages
        • Zones
        • Countries
        • States
        • Currencies
        • Taxes
        • Tax Rules
        • Translations
      • Understanding the Preferences
        • General Preferences
        • Orders Preferences
        • Products Preferences
        • Customers Preferences
        • Themes Preferences
        • SEO & URLs Preferences
        • CMS - Managing Static Content
        • Images Preferences
        • Store Contacts Preferences
        • Search Preferences
        • Maintenance Settings
        • Geolocation Preferences
      • Understanding the Advanced Parameters
        • Configuration Information
        • Performance Parameters
        • E-Mail Parameters
        • Multistore Parameters
        • CSV Import Parameters
        • DB Backup
        • SQL Manager
        • Logs Parameters
        • Webservice Parameters
      • Administering the back office
        • Administration Preferences
        • Quick Access Configuration
        • Employees Accounts Configuration
        • Employee Profiles
        • Profile permissions
        • Administration Menus Configuration
        • Merchant Expertise
      • Understanding Statistics
        • Statistics
        • Search Engines
        • Referrers
      • Advanced Stock Management
        • General Concepts
        • Presenting the Stock Management Interface
        • Stock Management Rules
      • Managing Multiple Shops
        • The multistore interface
        • Creating a new shop group
        • Creating a new shop
        • Setting a shop's URL
        • Sample Usages and Specifics
      • Complying with the GDPR
    • Developer Guide
      • Coding Standards
        • PHP Coding Standards
          • Pre-1.6.1.0 PHP Coding Standards
        • JavaScript Coding Standards
        • CSS, HTML, Smarty & Twig Coding Standards
        • Commits & Pull-requests Conventions
        • SQL Guidelines
      • Fundamentals of PrestaShop Development
      • Setting Up Your Local Development Environment
      • Diving into PrestaShop Core Development
        • Accessing the database
        • The Dispatcher
        • Controllers within PrestaShop
        • Views within PrestaShop
        • Managing Cookies
        • Managing Hooks
      • Creating a PrestaShop Module
        • What is a PrestaShop module?
        • Creating a first module
        • About the config.xml file
        • Adding a configuration page
        • Displaying content on the front office
        • Module translation
        • Enabling the Auto-Update
        • Development Troubleshooting
        • 1.6-specific Developer Documentation
          • Creating a Dashboard Module
          • Making your module work with Bootstrap
        • Miscellaneous developer documentation
          • Specifics of multistore module development
          • The Backward Compatibility Toolkit: Making your 1.5+ module compatible with PrestaS
          • Creating a payment module
          • Creating a carrier module
          • Tying your module to your Addons account
      • Developer tutorials
        • Best Practices of the Db Class
        • Developer tips and tricks
        • Handling special characters in links
        • Overriding default behaviors
        • PrestaShop's developer tools
        • Using jQuery and jQueryUI
        • Using the backward compatibility toolkit
        • Using the Context Object
        • Using the Helper classes
          • Using the HelperForm class
          • Using the HelperOptions class
          • Using the HelperList class
        • Using the PrestaShop Web Service
          • Web service one-page documentation
          • Web service tutorial
            • Chapter 1 - Creating an access to the back office
            • Chapter 2 - Discovery: Testing your access to the web service with the browser
            • Chapter 3 - First steps: Accessing the web service and listing customers
            • Chapter 4 - Data retrieval: Retrieving a customer
            • Chapter 5 - Data modification: Updating a customer
            • Chapter 6 - Data creation: Creating a remote online form
            • Chapter 7 - Data removal: Removing customer accounts from the database
            • Chapter 8 - Advanced use
            • Chapter 9 - Image management
            • Chapter 10 - Price management
            • Cheat-sheet: Concepts outlined in this tutorial
          • Web service reference
      • Contributing to PrestaShop
        • Contributing code to PrestaShop
        • How to use the Forge to contribute to PrestaShop
        • How to write a commit message
      • PrestaShop Cloud-specific development
    • Designer Guide
      • Theme development fundamentals
      • Organization of a Theme
      • Laying the Theme's Foundations
      • Theme templates and Smarty
      • Using jQuery and Ajax
      • Best practices
      • Bootstrap, Sass and Compass in PrestaShop 1.6
        • Using Bootstrap
        • Using Sass
        • Using Compass
      • Tying your theme to your Addons account
    • System Administrator Guide
      • Making your PrestaShop installation more secure
    • Merchant's Guide
      • Our e-commerce advices
      • Sample price rules
    • FAQ
      • Using PrestaShop 1.6 with WordPress
    • Troubleshooting
  • Documentation française 1.6
    • Guide de démarrage
      • Ce dont vous avez besoin
      • Installer PrestaShop
      • Installer PrestaShop sur votre propre ordinateur
      • Installer PrestaShop en ligne de commande
      • Mettre PrestaShop à jour
      • Informations diverses
    • Guide de mise à jour
      • Mise à jour automatique
      • Mise à jour manuelle
      • Faire une sauvegarde et la restaurer
      • En cas de problème
    • Guide de l'utilisateur
      • Formations
      • Personnaliser votre boutique
      • Se connecter au back-office de PrestaShop
      • Découvrir la zone d'administration
      • Premiers pas avec PrestaShop 1.6
      • Gérer le catalogue
        • Gérer les produits
        • Gérer les catégories
        • Faire le suivi de votre catalogue
        • Gérer les attributs de vos produits
        • Gérer les caractéristiques de vos produits
        • Gérer les fabricants
        • Gérer les fournisseurs
        • Construire des scènes
        • Gérer les mots-clés (tags)
        • Gérer les documents joints
      • Gérer les commandes
        • Commandes
        • Factures
        • Retours produits
        • Bons de livraison
        • Avoirs
        • États de commande
        • Messages prédéfinis
      • Gérer les clients
        • Vos clients
        • Adresses des clients
        • Groupes de clients
        • Paniers
        • Service Après-Vente
        • Vos contacts
        • Titres de civilité
        • Encours autorisés
      • Mettre en place des promotions
        • Règles paniers
        • Règles de prix catalogue
        • Modules marketing
      • Gérer les modules et les thèmes
        • Vos modules
        • Catalogue de modules et thèmes
        • Positions sur le front-office
        • Paramètres de paiement
      • Configurer les modules natifs
        • Modules Administration
        • Modules Drop-shipping
        • Modules Facturation
        • Modules Fonctionnalités front-office
        • Modules Guides d'achats
        • Modules Mobile
        • Modules Paiement
        • Modules Places de marché
        • Modules Prix & Promotion
        • Modules Publicité et marketing
        • Modules Recherche et filtres
        • Modules Référencement - SEO
        • Modules Sécurité des Paiements
        • Modules Statistiques et Analyses
        • Modules Transporteur et logistique
        • Modules Traduction
      • Gérer la livraison
        • Gérer les transporteurs
        • Préférences de livraison
      • Comprendre les réglages locaux
        • Localisation
        • Langues
        • Zones (fr)
        • Pays
        • États
        • Devises
        • Taxes (fr)
        • Règles de taxe
        • Traductions
      • Comprendre les préférences
        • Préférences générales
        • Préférences des commandes
        • Préférences des produits
        • Préférences des clients
        • Préférences des thèmes
        • Préférences SEO & URL
        • CMS - Gérer le contenu statique
        • Préférences des images
        • Préférences des coordonnées & magasins
        • Préférences de la recherche
        • Préférences de maintenance
        • Préférences de géolocalisation
      • Comprendre les paramètres avancés
        • Informations de configuration
        • Paramètres de performances
        • Paramètres des e-mails
        • Paramètres multiboutique
        • Paramètres d'import CSV
        • Sauvegarde BDD
        • Gestionnaire SQL
        • Paramètres de log
        • Paramètres du service web
      • Administrer le back-office
        • Préférences de l'administration
        • Configuration de l'Accès rapide
        • Configuration des comptes des employés
        • Profils des employés
        • Permissions des employés
        • Configuration des menus de l'administration
        • Expertise PrestaShop (Merchant Expertise)
      • Comprendre les statistiques
        • Statistiques
        • Moteurs de recherche
        • Affiliés
      • Gestion avancée des stocks
        • Concepts généraux
        • Présentation des interfaces gestion des stocks
        • Règles de gestion des stocks
      • Gérer plusieurs boutiques
        • L'interface multiboutique
        • Créer un nouveau groupe de boutiques
        • Créer une nouvelle boutique
        • Mettre en place l'adresse d'une boutique
        • Exemples d'utilisations et utilisations spécifiques
      • Embarquer à bord de PrestaShop
      • Etre conforme au RGPD
    • Guide du développeur
      • Adapter votre module à Bootstrap
      • Créer un module pour le tableau de bord
    • Guide de l'administrateur système
      • Rendre votre installation de PrestaShop plus sûre
      • Nos bons conseils
    • Guide du vendeur
      • Exemples de promotions
    • Questions fréquentes
    • Dépannage
  • Documentación española 1.6
    • Guía de Actualización
      • PrestaShop 1.6 : Actualización automática
      • PrestaShop 1.6 : Actualización manual
    • Introducción
      • Lo que necesita para empezar
      • Instalación de PrestaShop
      • Instalación de PrestaShop en su ordenador
      • Instalación de PrestaShop utilizando la secuencia de línea de comandos
      • Actualizar y desinstalar Prestashop
      • Informaciones diversas
    • Guía del Usuario
      • Formación
      • Personalización de tu tienda
      • Conexión al back-office de PrestaShop
      • Descubriendo el Área de Administración
      • Súbete a bordo de Prestashop - Haz un recorrido guiado
      • Primeros pasos con PrestaShop 1.6
      • Gestionar el Catálogo
        • Gestionar Productos
        • Gestionar Categorías
        • Monitorear tu Catálogo
        • Gestionar Atributos del Producto
        • Gestionar Características del Producto
        • Gestionar Fabricantes
        • Gestionar Proveedores
        • Gestionar Etiquetas
        • Mapeo de imágenes
        • Gestionar Archivos adjuntos
      • Gestionar Pedidos
        • Pedidos
        • Facturas
        • Devoluciones de mercancía
        • Albaránes de entrega
        • Facturas por abono (Notas de crédito)
        • Estados de Pedidos
        • Mensajes para Pedidos predefinidos
      • Gestionar Clientes
        • Tus clientes
        • PrestaShop 1.6 : Direcciones de clientes
        • Grupos de clientes
        • Carritos de compra
        • Servicio de atención al cliente
        • Tus Contactos
        • Tratamientos (Títulos sociales)
        • Saldo pendiente por cobrar (B2B)
      • Crear Reglas de precios y Cupones de descuento
        • Reglas del carrito
        • Reglas de Precios del catálogo
        • Módulos de Marketing
      • Gestionar Módulos y Temas
        • Tus Módulos
        • Catálogo de Módulos y Temas
        • Posiciones de los módulos en el Front-Office
        • Configurar Métodos de pago y restricciones
      • Configurar y trabajar con los Módulos nativos
        • Módulos de Administración
        • Módulos de Publicidad y Marketing
        • Módulos de Análisis y Estadísticas
        • Módulos de Impuestos y Facturación
        • Módulos Inicio
        • Módulos de Aplicaciones Front-Office
        • Módulos de Mercado
        • Módulos de Dispositivos móviles
        • Módulos de Pago Seguro
        • Módulos de Plataformas de pago
        • Módulos de Precios y Descuentos
        • Módulos SEO
        • Módulos de Búsqueda y Filtrado
        • Módulos de Envío y Logística
        • Módulos de Compras Inteligentes
        • Módulos de Traducciones
      • Gestionar Transporte
        • Gestionar Transportistas
        • Preferencias de Transporte
      • Comprender la configuración local
        • Localización
        • Idiomas
        • Zonas
        • Países
        • Provincias (Estados)
        • Monedas
        • Impuestos
        • Reglas de impuestos
        • Traducciones
      • Comprender las Preferencias
        • Preferencias Generales
        • Preferencias de Pedidos
        • Preferencias de Productos
        • Preferencias de Clientes
        • Preferencias de Temas
        • Preferencias SEO y URLs
        • CMS - Gestionar el Contenido Estático
        • Preferencias de Imágenes
        • Preferencias de Contactos de la tienda
        • Preferencias de Búsqueda
        • Preferencias de Mantenimiento
        • Preferencias de Geolocalización
      • Comprender los Parámetros avanzados
        • Información sobre la Configuración
        • Parámetros de Rendimiento
        • Parámetros de Correo electrónico
        • Parámetros Multitienda
        • Parámetros de Importación de archivos CSV
        • Copia de seguridad de la Base de Datos
        • Gestor de consultas SQL
        • Parámetros de Registros/Logs
        • Parámetros Webservice
      • Administrar el Back-Office
        • Administración de Preferencias
        • Configuración de Acceso rápido
        • Configuración de Cuentas de Empleados
        • Perfiles de Empleados
        • Permisos de Perfiles
        • Configuración de Menús de Administración
        • Experiencia Comercial (Experiencia minorista)
      • Comprender las Estadísticas
        • Estadísticas
        • Motores de búsqueda
        • Programa de afiliados
      • Gestión avanzada de stock
        • Conceptos Generales
        • Presentación de la interfaz back-office para gestionar el stock
        • Reglas del sistema de gestión
      • Gestionar múltiples tiendas
        • La interfaz multitienda
        • Crear un nuevo grupo de tiendas
        • Crear una nueva tienda
        • Configurar la URL de una tienda
        • Ejemplos de usos del modo multitienda
      • Cumplimiento de la legislación europea del RGPD
    • Guía del Desarrollador
      • Estándares de Codificación
  • Deutsche Dokumentation 1.6
    • Erste Schritte
      • Was für die Installation benötigt wird
    • Benutzerhandbuch
      • Übungen
      • Anpassung des Shops
      • Der PrestaShop Adminbereich
      • Entdecken der Administrationsoberfläche
      • Durchstarten mit PrestaShop
      • Erste Schritte in PrestaShop 1.6
      • Verwaltung des Katalogs
        • Artikel verwalten
        • Verwaltung der Kategorien
        • Kontrollübersicht
        • Artikelvarianten
        • Artikeleigenschaften
        • Hersteller
        • Lieferanten
        • Bildserien
        • Tags verwalten
        • Anhänge
      • Verwalten von Bestellungen
        • Bestellungen
        • Rechnungen
        • Warenrücksendungen
        • Lieferscheine
        • Rückvergütungen
        • Status
        • Bestellnachrichten
      • Kundenverwaltung
        • Kunden
        • Adressen
        • Gruppen
        • Warenkörbe
        • Kundenservice
        • Kontakte
        • Anreden
        • Offene Posten
      • Preisregeln und Gutscheine erstellen
        • Warenkorb Preisregeln
        • Katalog Preisregeln
        • Marketing-Addons
      • Module und Templates verwalten
        • Module
        • Modul- und Template-Shop
        • Positionen
        • Zahlungsart
      • Funktionen der Standardmodule
        • Verwaltungsmodule
        • Module zu Werbung & Marketing
        • Module zu Statistiken & Analysen
        • Module zu Zahlungen und Rechnungen
        • Dashboardmodule
        • Module zu Front-Office-Funktionen
        • Mobil-Module
        • Module zu Preisen & Sonderangeboten
        • SEO-Module
        • Such- und Filter-Module
        • Module zu Versand & Logistik
        • Module zur Seitenverifzierung und Betrugsprävention
        • Smart-Shopping-Module
        • Module zu Steuern & Rechnungen
        • Übersetzungsmodule
      • Versand
        • Versanddienste
        • Voreinstellungen verwalten
      • Lokalisierung
        • Lokalisierung verwalten
        • Sprachen
        • Gebiete
        • Länder
        • Bundesländer
        • Währungen
        • Steuersätze
        • Steuerregeln
        • Übersetzungen
      • Voreinstellungen
        • Allgemein
        • Voreinstellung Bestellungen
        • Voreinstellung Artikel
        • Voreinstellung Kunden
        • Templates
        • SEO & URLs
        • CMS-Seiten
        • Bilder
        • Shopadressen
        • Suche
        • Wartung
        • Geotargeting
      • Erweiterte Einstellungen
        • Systemeinstellungen
        • Leistung
        • E-Mail
        • Multishop
        • CSV-Import
        • Datenbank-Backup
        • SQL-Abfragen
        • Log-Dateien
        • Webservice
      • Verwaltung
        • Verwalten der Voreinstellungen
        • Schnellzugriff
        • Mitarbeiter
        • Profile
        • Berechtigungen
        • Menüpunkte
        • Handelserfolg
      • Statistiken
        • Statistiken verwalten
        • Suchmaschinen
        • Referrer
      • Erweiterte Lagerverwaltung
        • Allgemeines Konzept
        • Die Oberfläche der Lagerverwaltung
        • Regeln zur Lagerverwaltung
      • Verwalten mehrerer Shops
        • Das Multishop Interface
        • Erstellen einer neuen Shop Gruppe
        • Erstellen eines neuen Shops
        • Die URL eines Shops festlegen
  • Polska dokumentacja 1.6
    • Początek (PrestaShop 1.6)
      • Czego potrzebujesz, by zacząć?
      • Instalacja PrestaShop
    • Aktualizacja PrestaShop
      • Automatyczna aktualizacja
      • Ręczna aktualizacja
    • Przewodnik użytkownika
      • Szkolenia
      • Dostosowanie Twojego sklepu
      • Połączenie z panelem administracyjnym
      • Odkrywanie obszaru administracyjnego
      • Rozpocznij pracę z PrestaShopem
      • Pierwsze kroki
      • Zarządzanie katalogiem
        • Zarządzanie produktami
        • Zarządzanie kategoriami
        • Monitorowanie Twojego katalogu
        • Zarządzanie atrybutami produktów
        • Zarządzanie cechami produktów
        • Zarządzanie producentami
        • Zarządzanie dostawcami
        • Tworzenie map obrazów
        • Zarządzanie tagami
        • Zarządzanie załącznikami
      • Zarządzanie zamówieniami
        • Zamówienia
        • Faktury
        • Zwroty produktów
        • Druki wysyłki
        • Potwierdzenia zwrotów
        • Statusy
        • Powiadomienia o zamówieniu
      • Zarządzanie klientami
        • Twoi klienci
        • Adresy klientów
        • Grupy klientów
        • Koszyki zakupowe
        • Serwis obsługi klienta
        • Kontakty
        • Zwroty grzecznościowe
        • Saldo
      • Ustalanie reguł cenowych i promocyjnych
        • Reguły koszyka
        • Reguły cenowe katalogu
        • Moduły marketingu
      • Zarządzanie modułami i szablonami
        • Twoje moduły
        • Katalog modułów i szablonów
        • Pozycje we Front-Office
        • Ustawienia płatności
      • Konfiguracja modułów domyślnych
        • Moduły Administracyjne
        • Moduły Reklamy i Marketingu
        • Moduły Statystyk i Analiz
        • Moduły Fakturowania
        • Moduły Funkcjonalności Front-Office
        • Moduły Mobilne
        • Moduły Cen i promocje
        • Moduły pozycjonowania i SEO
        • Moduły Wyszukiwania i filtrów
        • Moduły Transportu i logistyki
        • Moduły Bezpieczeństwa płatności
        • Inne Moduły
      • Zarządzanie wysyłką
        • Zarządzanie przewoźnikami
        • Ustawienia wysyłki
      • Poznaj Ustawienia lokalne
        • Lokalizacja
        • Języki
        • Strefy
        • Kraje
        • Województwa lub regiony
        • Waluty
        • Podatki
        • Reguły podatków
        • Tłumaczenia
      • Poznaj Preferencje
        • Ustawienia ogólne
        • Zamówienia - Ustawienia
        • Produkty - Ustawienia
        • Klienci - Ustawienia
        • Szablony - Ustawienia
        • SEO & URL
        • CMS - Ustawienia
        • Zdjęcia - Ustawienia
        • Kontakty Sklepu
        • Szukaj
        • Przerwa techniczna
        • Geolokalizacja
      • Poznaj Parametry Zaawansowane
        • Informacje konfiguracyjne
        • Wydajność
        • Adres e-mail
        • Multisklep
        • Import CSV
        • Kopia zapasowa DB
        • Menadżer SQL
        • Logi
        • API
      • Administracja Panelem Adminstracyjnym
        • Preferencje Administracyjne
        • Szybki dostęp - konfiguracja
        • Konfiguracja kont Pracowników
        • Profile Pracowników
        • Uprawnienia
        • Menu - konfiguracja
        • Merchant Expertise Administracja
      • Poznaj Statystki
        • Statystyki
        • Wyszukiwarki
        • Polecający
      • Zaawansowane Zarządzanie magazynem
        • Uwagi ogólne
        • Prezentacja interfejsu zarządzania magazynem
        • Zasady zarządzania magazynem
      • Zarządzanie Multisklepem
        • Interfejs Mutlisklepu
        • Tworzenie nowej grupy sklepów
        • Tworzenie nowego sklepu
        • Ustalanie nowego adresu URL sklepu
        • Przykładowe użycie i specyfika
    • Przewodnik dewelopera
      • Coding Standards-
      • Fundamentals of PrestaShop Development -
      • Setting Up Your Local Development Environment -
      • Diving into PrestaShop Core Development -
        • Accessing the database-
        • The Dispatcher-
        • Controllers within PrestaShop-
        • Views within PrestaShop-
        • Managing Cookies -
        • Managing Hooks -
      • Creating a PrestaShop Module -
        • What is a PrestaShop module?-
        • Creating a first module-
        • About the config.xml file -
        • Adding a configuration page -
        • Displaying content on the front office -
        • Module translation -
        • Enabling the Auto-Update -
        • Development Troubleshooting -
        • 1.6-specific Developer Documentation -
          • Creating a Dashboard Module -
          • Making your module work with Bootstrap -
        • Miscellaneous developer documentation -
          • Specifics of multistore module development -
          • The Backward Compatibility Toolkit: Making your 1.5+ module compatible with PrestaS
          • Creating a payment module -
          • Creating a carrier module -
          • Tying your module to your Addons account -
      • Developer tutorials-
        • Best Practices of the Db Class -
        • Developer tips and tricks -
        • Handling special characters in links -
        • Overriding default behaviors -
        • PrestaShop's developer tools -
        • Using jQuery and jQueryUI -
        • Using the backward compatibility toolkit -
        • Using the Context Object -
        • Using the Helper classes -
        • Using the PrestaShop Web Service -
      • Contributing to PrestaShop -
        • Contributing code to PrestaShop -
        • How to use the Forge to contribute to PrestaShop -
        • How to write a commit message -
    • Przewodnik sprzedawcy
      • Our e-commerce advices -
      • Sample price rules -
    • FAQ - Najczęściej zadawane pytania
      • Używanie PrestaShop1.6 z WordPress
    • Rozwiązywanie problemów
    • Przewodnik projektanta
      • Podstawy rozwoju szablonu
      • Organizacja szablonu
      • Układanie Fundamentów Tematu
      • PSzablony tematyczne i Smarty
      • Korzystanie z jQuery i Ajax
      • Najlepsze praktyki
      • Bootstrap, Sass i Compass w PrestaShop 1.6
        • Używanie Bootstrap
        • Używanie Sass
        • Using Compass -
      • Tying your theme to your Addons account -
  • Documentazione Italiana 1.6
    • Come Cominciare
      • Di cosa hai bisogno per cominciare
      • Installazione di Prestashop
      • Installazione di PrestaShop sul tuo computer
      • Installazione di PrestaShop usando lo script da riga di comando.
    • Aggiornamento di PrestaShop
      • Aggiornamento automatico
    • Guida per l'Utente
      • Formazione
      • Personalizzare il tuo negozio
      • Connettersi al back office di PrestaShop
      • Scoprire l'Area Amministrativa
      • Salire a bordo di PrestaShop
      • Primi passi con PrestaShop 1.6
      • Gestire il Catalogo
        • Gestire i Prodotti
        • Gestire le Categorie
        • Osservare il Tuo Catalogo
        • Gestire gli Attributi Prodotto
        • Gestire le Funzioni Prodotto
        • Gestire i Produttori
        • Gestire i Fornitori
        • Creare mappature di immagini
        • Gestire i Tags
        • Gestire gli allegati
      • Gestione ordini
        • Fatture
        • Merce resa
        • Note di credito
        • Ordini
    • Guida allo sviluppo
      • Sovrascrittura del comportamento di default
    • Integrazione alla Guida Ufficiale
      • Codice Tracking corrieri Italiani
  • Nederlandse documentatie 1.6
    • Aan de slag
      • Benodigdheden
      • PrestaShop installeren
      • PrestaShop installeren op uw computer
      • PrestaShop installeren met behulp van het command line script
      • PrestaShop bijwerken en deïnstalleren
      • Overige informatie
    • PrestaShop bijwerken
      • Automatisch bijwerken
      • Handmatig bijwerken
      • Backups aanmaken en terugzetten
      • Wanneer er problemen optreden
    • Gebruikershandleiding
      • Cursussen & trainingen
      • Uw winkel aanpassen
      • Verbinding maken met de back office
      • Kennismaken met het administratiepaneel
      • Kom aan boord van PrestaShop
      • Eerste stappen met PrestaShop 1.6
      • De catalogus beheren
        • Producten beheren
        • Categorieën beheren
        • Uw catalogus monitoren
        • Productattributen beheren
        • Productkenmerken beheren
        • Fabrikanten beheren
        • Leveranciers beheren
        • Image mapping toepassen
        • Tags beheren
        • Bijlagen beheren
      • Bestellingen beheren
        • Bestellingen
        • Facturen
        • Retourzendingen
        • Pakbonnen
        • Creditnota's
        • Statussen
        • Bestellingsberichten
      • Klanten beheren
        • Uw klanten
        • Klantadressen
        • Klantengroepen
        • Winkelwagens
        • Klantenservice
        • Uw contacten
        • Aanhefsvormen
        • Openstaand bedrag
      • Prijsregels en waardebonnen aanmaken
        • Winkelwagenregels
        • Catalogus prijsregels
        • Marketingmodules
      • Modules en thema's beheren
        • Uw modules
        • Module- en themacatalogus
        • Frontoffice-posities
        • Betaalinstellingen
      • Vooraf geïnstalleerde modules gebruiken
        • Administratiemodules
        • Reclame- en marketingmodules
        • Analyse- en statistiekmodules
        • Modules voor betaalmethoden en gateways
        • Dashboardmodules
        • Modules voor extra winkelfuncties
        • Mobiele modules
        • Prijs- en promotiemodules
        • SEO-modules
        • Zoek- en filtermodules
        • Verzending- en logistiekmodules
        • Modules voor site-certificatie en fraudepreventie
        • Vergelijkingssites & Feed-beheer
        • Belasting- en facturatiemodules
        • Vertaalmodules
      • Zendingen beheren
        • Vervoerders beheren
        • Verzendinstellingen
      • Lokalisatie-instellingen
        • Lokalisatie
        • Talen
        • Zones / gebieden
        • Landen
        • Staten / provincies
        • Valuta's
        • Belastingen
        • Belastingregels
        • Vertalingen
      • Algemene instellingen
        • Algemeen instellen
        • Bestellingen instellen
        • Producten instellen
        • Klanten instellen
        • Thema's instellen
        • SEO & URL's instellen
        • CMS instellen - statische content beheren
        • Afbeeldingen instellen
        • Winkelcontacten beheren
        • Zoekinstellingen
        • Onderhoudsinstellingen
        • Geolocatie instellen
      • Geavanceerde instellingen
        • Configuratie-informatie bekijken
        • Prestaties instellen
        • E-mail instellen
        • Multistore instellen
        • CSV-bestanden importeren
        • Database backup
        • SQL-beheer
        • Logboek bekijken
        • Webservice instellen
      • Backoffice beheren
        • Administratie instellen
        • Snelle toegang instellen
        • Medewerkers instellen
        • Medewerkersprofielen instellen
        • Permissies instellen
        • Menu's instellen
        • Verkoopervaring instellen
      • Statistieken
        • Statistieken bekijken
        • Zoekmachines instellen
        • Referrers bekijken
      • Geavanceerd voorraadbeheer
        • Algemene concepten
        • Voorraadbeheer-interface
        • Regels voor voorraadbeheer
      • Meerdere winkels beheren
        • De multistore-interface
        • Een nieuwe winkelgroep aanmaken
        • Een nieuwe winkel aanmaken
        • Een URL voor de winkel instellen
        • Gebruiksvoorbeelden
    • Handleiding voor de winkelier
      • Onze e-commerce adviezen
      • Voorbeelden van prijsregels
    • Veelgestelde vragen
      • PrestaShop 1.6 integreren met WordPress
    • Probleemoplossing
  • Documentação em português 1.6
    • Começando com PrestaShop
      • O que você precisa para começar?
      • Instalando o PrestaShop
      • Instalando o PrestaShop em seu computador
      • Instalando o PrestaShop usando scripts de linha de comando
      • Atualizando e Desinstalando o PrestaShop
      • Outras Informações
    • Atualização do PrestaShop
      • Atualização Automática
      • Atualização Manual
      • Criando e restaurando o seu próprio backup
      • Em caso de problemas
    • Guia do Usuário
      • Treinamentos
      • Personalizando sua loja
      • Acessando o Back Office do PrestaShop
      • Descobrindo a Área Administrativa
      • Primeros Passos no PrestaShop 1.6
      • Gerenciamento do Catálogo
        • Gerenciamento dos Produtos
  • Οδηγίες χρήσης 1.6
    • Ξεκινώντας
      • Τι χρειάζεστε για να ξεκινήσετε
Powered by GitBook
On this page
  • Web service one-page documentation
  • Setting everything up
  • Working with your data
  • Available resources

Was this helpful?

  1. English documentation 1.6
  2. Developer Guide
  3. Developer tutorials
  4. Using the PrestaShop Web Service

Web service one-page documentation

PreviousUsing the PrestaShop Web ServiceNextWeb service tutorial

Last updated 4 years ago

Was this helpful?

Table of contents

Web service one-page documentation

Setting everything up

In order for you to view, edit and delete the data on your PrestaShop store through its web service, you first need to enable the web service feature, and then create an access key.

Enabling cURL

Configure your PHP installation so that it has the cURL extension installed and enabled:

With Windows, place this line in your php.ini file:

extension=php_curl.dll

With Linux/Mac, install the cURL extension:

sudo apt-get install php5-curl

Enabling the webservice feature

Go in the PrestaShop back office, open the "Webservice" page under the "Advanced Parameters" menu, and then choose "Yes" for the "Enable PrestaShop's webservice". Save your change: you're done!

Creating an access key

Open the "Webservice" page under the "Advanced Parameters" menu, and then click the "Add New" button to access the account configuration section. A long form appears:

  • Key. The API key serves as the main identifier for the webservice account you are creating. Click the "Generate" button to get an unique authentication key. You can also create your own (which must be 32 characters long), but using a generated key prevents wrong-doers from guessing your key too easily. Using this key, you and other selected users will be able to access the webservice.

  • Key description. Helps you remember who you created that key for, what are the access rights assigned to it, etc. The description is not public, but make sure to put all the keywords pertaining to the user, so that you can find their key more quickly.

  • Status. You can disable any key at any time.

  • Permissions. This section is very important, as it enables you to assign rights for each resource you want to make available to this key. Indeed, you might want a user to have read and write access on some resources, but only read access on others – and no access to the more important ones. In the list of permissions, the checkbox most on the left enables you to define all the rights for a given resource. Likewise, the checkbox at the top of each column enables you to give the select right (View, Modify, etc.) to all the resources. Make sure to only select the rights needed for the usage of that key. Do not give all the rights for all resources to any key, keep that to yours and yours only.

  • Shop association. This only appears in multistore mode. It enables you to choose which of your stores the key owner should have access to.

If you choose to use a custom passkey instead of a generated one, make sure it is very secure and that its rights are limited – and that it is 32characters long!

Accessing the webservice from the browser

The endpoint to your store's webservice is located in the /api/ folder at the root of your installation of Prestashop:

To access it, you need to provide your API key when request. There is no password, providing your API key is enough – and therefore the key should be kept secret by the user!

You can either type the API endpoint address directly then enter your API key, or indicate your API key in the address. Here is an example, with "UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX" being the API key.

You can test this with any browser that supports XML.

If no permission has been set for the key, then the browser will keep asking you to enter the key indefinitely.

If you cannot access some resources, the API might answer with this XML response:

<?xml version="1.0" encoding="UTF-8"?>
<prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
  <errors>
    <error>
      <message><![CDATA[Internal error. To see this error please display the PHP errors.]]></message>
    </error>
  </errors>
</prestashop>

Using XLink, you will then be able to access your various resources. XLink associates an XML file to another XML file via a link.

Accessing the webservice use our PHP library

  • Copy/paste the file into an empty text local file, using for instance Notepad.

  • Save the file as PSWebServiceLibrary.php.

Put PSWebServiceLibrary.php at the root of your web server, and add this line at the beginning of any PHP file that needs to use your store's webservice.

Then, you must create an instance of the PrestaShopWebservice object, which takes 3 parameters in its constructor:

  • The authentication key (ex: UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX).

  • A boolean value, indicating whether the webservice must use its debug mode.

Here's how you create a webservice call:

$webService = new PrestaShopWebservice('http://example.com/', 'UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX', false);

Handling errors

It is essential that you understand how to handle errors with the webservice library. By implementing error-catch method early, you will more easily detect issues, and be able to correct them on the go.

How it works

The error handling is done within a try..catch block, with the webservice processing being done in the try section, the catch one containing the error handling code.

try {
  // Execution ( if an error occurs in this code, stops and goes in the catch block)
}
catch {
  // Error handling (tries to catch the error or the error display)
}

Example

That means each creation or use of the library must be located within a "try" block. The "catch" block can then handle the error if it occurs during the execution of the try block. Now we'll see how to list all customers via the webservice, and then we will see the four CRUD methods.

In the following code sample, we want to get the list of all customers:

  • In the try block, we instantiate the PrestaShopWebservice object with the necessary parameters and retrieve the customer resource XML in a variable.

  • In the catch block, we put code to display the PHP error message, if anything wrong happens in the try block.

try {
   // creating webservice access
   $webService = new PrestaShopWebservice('http://example.com/', 'UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX', false);
 
   // call to retrieve all clients
   $xml = $webService->get(array('resource' => 'customers'));
}
catch (PrestaShopWebserviceException $ex) {
   // Shows a message related to the error
   echo 'Other error: <br />' . $ex->getMessage();
}

Examples files

Working with your data

As shown above, you have to instantiate the PrestaShopWebservice object in order to use its methods: add(), get(), edit() and delete(). You can also directly use call the REST API and get XML results, as this correspondence table shows:

CRUD operations

SQL statements

PrestaShopWebservice methods

HTTP methods

Create

INSERT

add()

POST

Read

SELECT

get()

GET

Update

UPDATE

edit()

PUT

Delete

DELETE

delete()

DELETE

Viewing your data

Using the PrestaShopWebservice methods

Let's see how to view a full list of client IDs. As you can see from the table above, we need the get() method in order to retrieve a XML file containing all the customers. The parameter has to be a key-value array, where we define the resource we want:

Key

Value

resource

customers

The value defines the resource that the webservice will use in a future call. The value could be carrier types, countries or any other type of resource that can be found in the "Available resources" section of this guide.

The code

In order to retrieve a list of customers in XML format, you only need to instantiate PrestaShopWebservice (a seen earlier) and use this code:

// The key-value array
$opt['resource'] = 'customers';
 
Retrieving the XML data
$xml = $webService->get($opt);

The result

Launching the code above will return a XML object containing all the current customer IDs on the store:

<?xml>
<prestashop>
  <customer id="1" xlink:href="http://example.com/api/customers/1"/>
  <customer id="2" xlink:href="http://example.com/api/customers/2"/>
  <customer id="3" xlink:href="http://example.com/api/customers/3"/>
  <customer id="4" xlink:href="http://example.com/api/customers/4"/>
</prestashop>

With this information, you can access the customer that interests you by using the value in the id attribute:

$opt['resource'] = 'customers';
$opt['id'] = 1;
$xml = $webService->get($opt);

Structure

As you can see in the result in the previous section, the data returned by calling $webService->get() puts you at the root of the XML document, in the context you requested.

To access the fields of clients who are children of the <customers> tag, we only need to retrieve all fields in an associative array in XML, like this:

$resources = $xml->customers->children();

From there, you can easily access client IDs. Here's an example with a path from identifiers:

foreach ($resources as $resource)
    echo $resource->attributes() . '<br />';

Thanks to these elements, you can create a HTML table containing all the client IDs – or anything that displays this information in your interface.

Using HTTP requests

If you would rather not use the PrestaShopWebservice object, note that PrestaShop's webservice is RESTful, in that you can work with its data using the known HTTP verbs just as easily as you would use the methods of the PrestaShopWebservice object.

Viewing your data follows the same rule, but with a HTTP GET request on the same URL: To view your data you simply have to launch an HTTP GET request on the following URL:

http://UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX@example.com/api/customers/

The resulting XML document is the same as the one obtained using PrestaShopWebservice's get() method.

Creating and adding

Creating and adding data takes a bit more work. Indeed, in order to create a new entry or edit an existing one, you need to send a fully formed and complete XML document, whether you use PrestaShopWebservice or the HTTP methods.

When you need to create a new entry, the API can help you by providing a blank schema for any resource, or even a synopsis with indications of the meaning for each tag:

// Returns a blank XML document, with all the tags ready to fill
http://UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX@example.com/api/manufacturers?schema=blank

// Returns a blank XML document, with all the tags ready to fill and indication of the expected value for each
http://UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX@example.com/api/manufacturers?schema=synopsis

When a client is created from within PrestaShop's administration interface, a confirmation e-mail is sent to the client. This cannot be done directly with the webservice: there is no way to trigger the sending of that confirmation e-mail.

However, you can create an override file for the Customer class and override the addWs() method. This method is similar to ObjectModel::add() but is only called from the webservice. You can find examples of its use in the Product and Order classes.

Deleting

The RESTful-ness of the API goes all the way: in order to delete the product with an ID of 12, you simply have to launch an HTTP DELETE request on the following URL:

http://UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX@example.com/api/products/12/

Available resources

The /api/ URL gives you the root of all the resources, in the form of an XML file.

Here it is, extremely simplified. This list is current as of version 1.5.4.1 of PrestaShop. Note that we only show the API resources available for one of the available stores.

<?xml version="1.0" encoding="UTF-8"?>
<prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
  <api shop_name="MYSHOP">
    <addresses>...</addresses>
    <carriers>...</carriers>
    <cart_rules>...</cart_rules>
    <carts>...</carts>
    <categories>...</categories>
    <combinations>...</combinations>
    <configurations>...</configurations>
    <contacts>...</contacts>
    <content_management_system>...</content_management_system>
    <countries>...</countries>
    <currencies>...</currencies>
    <customer_messages>...</customer_messages>
    <customer_threads>...</customer_threads>
    <customers>...</customers>
    <deliveries>...</deliveries>
    <employees>...</employees>
    <groups>...</groups>
    <guests>...</guests>
    <image_types>...</image_types>
    <images>...</images>
    <languages>...</languages>
    <manufacturers>...</manufacturers>
    <order_carriers>...</order_carriers>
    <order_details>...</order_details>
    <order_discounts>...</order_discounts>
    <order_histories>...</order_histories>
    <order_invoices>...</order_invoices>
    <order_payments>...</order_payments>
    <order_states>...</order_states>
    <orders>...</orders>
    <price_ranges>...</price_ranges>
    <product_feature_values>...</product_feature_values>
    <product_features>...</product_features>
    <product_option_values>...</product_option_values>
    <product_options>...</product_options>
    <product_suppliers>...</product_suppliers>
    <products>...</products>
    <search >...</search>
    <shop_groups>...</shop_groups>
    <shops>...</shops>
    <specific_price_rules>...</specific_price_rules>
    <specific_prices>...</specific_prices>
    <states>...</states>
    <stock_availables>...</stock_availables>
    <stock_movement_reasons>...</stock_movement_reasons>
    <stock_movements>...</stock_movements>
    <stocks>...</stocks>
    <stores>...</stores>
    <suppliers>...</suppliers>
    <supply_order_details>...</supply_order_details>
    <supply_order_histories>...</supply_order_histories>
    <supply_order_receipt_histories>...</supply_order_receipt_histories>
    <supply_order_states>...</supply_order_states>
    <supply_orders>...</supply_orders>
    <tags>...</tags>
    <tax_rule_groups>...</tax_rule_groups>
    <tax_rules>...</tax_rules>
    <taxes>...</taxes>
    <translated_configurations>...</translated_configurations>
    <warehouse_product_locations>...</warehouse_product_locations>
    <warehouses>...</warehouses>
    <weight_ranges>...</weight_ranges>
    <zones>...</zones>
  </api>
  <api shop_name="MYOTHERSHOP">...</api>
  <api shop_name="YETANOTHERSHOP">...</api>
</prestashop>

As with any XLink-bearing XML file, each resource element leads to more resources, linked from the xlink attribute.

<customers xlink:href="http://example.com/api/customers" get="true" put="true" post="true" delete="true" head="true">
  <description xlink:href="http://example.com/api/customers" get="true" put="true" post="true" delete="true" head="true">The e-shop's customers</description>
  <schema xlink:href="http://example.com/api/customers?schema=blank" type="blank"/>
  <schema xlink:href="http://example.com/api/customers?schema=synopsis" type="synopsis"/>
</customers>

In addition, the element contains a description of the resource, and two schemas: a blank one, which you can use to create a new item, and a synopsis one, which is just like the blank one but with a detailed description of what type of data is expected in each element.

Here is an extract of the Customer blank schema:Blank schema

<?xml version="1.0" encoding="UTF-8"?>
<prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
  <customer>
    <id></id>
    <id_default_group></id_default_group>
    <id_lang></id_lang>
    <newsletter_date_add></newsletter_date_add>
    <ip_registration_newsletter></ip_registration_newsletter>
    <last_passwd_gen></last_passwd_gen>
    <secure_key></secure_key>
    <deleted></deleted>
    <passwd></passwd>
    <lastname></lastname>
    <firstname></firstname>
    <email></email>
    ...
  </customer>
</prestashop>

Here is an extract of the Customer synopsis schema:Synopsis schema

<?xml version="1.0" encoding="UTF-8"?>
<prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
  <customer>
    <id_default_group></id_default_group>
    <id_lang format="isUnsignedId"></id_lang>
    <newsletter_date_add></newsletter_date_add>
    <ip_registration_newsletter></ip_registration_newsletter>
    <last_passwd_gen></last_passwd_gen>
    <secure_key format="isMd5"></secure_key>
    <deleted format="isBool"></deleted>
    <passwd required="true" maxSize="32" format="isPasswd"></passwd>
    <lastname required="true" maxSize="32" format="isName"></lastname>
    <firstname required="true" maxSize="32" format="isName"></firstname>
    <email required="true" maxSize="128" format="isEmail"></email>
    ...
  </customer>
</prestashop>

This chapter aims at grouping all the information from the into a handy one-page doc that you can print and keep at hand.

If PrestaShop is installed at the root of your server, you can access the API here:

If PrestaShop is installed in a subfolder of your server, you can access the API here:

At the root of the server:

In a subfolder of the server:

You will need the latest version of the PSWebServiceLibrary.php file, which can be found on our code repository: To download the file:

Click here to view the raw file:

You can also directly download a zip archive of all the files in this repository, including the example files, by clicking here:

The store's root path (ex: ).

Error handling with the webservice library is done using PHP exceptions. If you do not know about them, you should read , as exceptions are an essential part of good coding practice.

All the example files can be found on our code repository:

The value types can be found in the .

web service tutorial
http://example.com/api/
http://example.com/prestashop/api/
http://UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX@example.com/api/
http://UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX@example.com/prestasshop/api/
https://github.com/PrestaShop/PrestaShop-webservice-lib/blob/master/PSWebServiceLibrary.php
https://raw.github.com/PrestaShop/PrestaShop-webservice-lib/master/PSWebServiceLibrary.php
https://github.com/PrestaShop/PrestaShop-webservice-lib/archive/master.zip
http://example.com/
http://php.net/manual/en/language.exceptions.php
https://github.com/PrestaShop/PrestaShop-webservice-lib/tree/master/examples
webservice reference
Web service one-page documentation
Setting everything up
Enabling cURL
Enabling the webservice feature
Creating an access key
Accessing the webservice from the browser
Accessing the webservice use our PHP library
Handling errors
Examples files
Working with your data
Viewing your data
Creating and adding
Deleting
Available resources