Variables
Variables globales
- shop
- page_title — Titre de la page courante
- featured_products — tableau/objet de produits vedettes (voir product). Ex: Le nom d'un produit est accessible par featured_products.slug-de-ce-produit.name
- categories — tableau/objet de catégories de produits de premier niveau (voir category). Ex: Le titre d'une catégorie est accessible par categories.slug-de-cette-categorie.title
- link_lists — tableau/objet de toutes les listes de liens (voir link_list). Ex: La liste de liens du pied de page est accessible par link_lists.footer.links
- requested_uri — URL courante (Ex: /products/product-name)
- latest_blog_posts — tableau des 10 derniers articles du blog (voir blog_post)
- blog_categories — tableau/objet de toutes les catégories du blog (voir blog_category). Ex: Le titre d'une catégorie est accessible par blog_categories.slug-de-cette-categorie.title
- template_name — slug du template affiché
- pages — tableau/objet de toutes les pages (voir page). Ex: Le contenu de la page par défaut "À propos" est accessible par pages.a-propos.content
Vous avez aussi uns liste d'URL, leur nom est auto-explicite :
products_url / products_rss_url / blog_posts_url / blog_posts_rss_url / cart_url / add_to_cart_url / update_cart_url / checkout_url / contact_url (URL de la page de contact) / submit_contact_message_url (URL vers où soumettre un message de contact)
Définitions de variables
shop
Contient des informations générales concernant votre boutique.
- name — Nom de votre boutique
- language — "en" ou "fr"
- country_code — "US", "GB", "FR", etc.
- currency — "USD", "GBP" ou "EUR"
- url — URL définie de votre boutique
product
Contient les informations relatives à un produit.
- name — Ex: "Nom de mon produit"
- description
- slug — Ex: "nom-de-mon-produit"
- featured? — true / false
- price — prix (ou prix de la variante par défaut)
- sku — Référence (ou Référence de la variante par défaut)
- weight — poids (ou poids de la variante par défaut)
- categories — tableau d'objets category.
- custom_fields — un objet de champs personnalisés, par slug. Si un slug a lpus d'une valeur, il retourne un tableau de ses valeurs.
- has_options? — true si le produit a des options (et une ou plusieurs variantes)
- pictures — tableau d'objets picture, ordonnés par leur positions
- default_picture — L'objet picture de l'image par défaut
- options — tableau d'objets option
- variants — tableau d'objets variant
- default_variant — L'objet variant de la variante par défaut
- is_discounted? — true si le produit (ou la variante par défaut) est en promotion
- discount_transformation — none / fixed / ratio (correspond au type de réduction)
- regular_price — prix du produit quand il n'est pas en promotion
- discounted_price — nouveau prix réduit du produit quand il est en promotion
- discount_ratio — nombre allant de 0 à 100 (correspond au pourcentage de réduction)
- stock — nombre de produits dans le stock (s'il est géré)
- out_of_stock? — true si le produit est en rupture de stock (stock = 0)
- out_of_stock_for_all_variants? — true si toutes les variantes du produit sont en rupture de stock
- url — URL du produit
- id — ID du produit (c'est cet ID qui doit être ajouté au panier)
option
Options d'un produit.
- name — Nom de l'option
- id
variant
Détails d'une variante de produit.
- product
- price — prix
- sku — Référence
- weight — poids
- is_discounted? — true si en promotion
- discount_transformation — none / fixed / ratio (correspond au type de réduction)
- regular_price — prix quand elle n'est pas en promotion
- discounted_price — nouveau prix réduit quand elle est en promotion
- discount_ratio — nombre allant de 0 à 100 (correspond au pourcentage de réduction)
- options — un tableau avec pour chaque option, som nom et sa valeur. Vous pouvez donc utiliser variant.options.first.name et variant.options.first.value
- is_default? — true si il sagit de la variante par défaut d'un produit
- id — ce que vous devez ajouter au panier
category
Détails d'une catégorie de produit.
- title — titre de la catégorie
- products — un tableau de produits (product) appartenant à cette catégorie
- all_products — un tableau de produits (product) appartenant à cette catégorie et a toutes ses sous-catégories
- parent — objet category de la catégorie parente
- parents — tableau des catégories parentes
- url — URL de la liste de produits dans cette catégorie
- id
picture
Détails d'une image de produit.
- url — URL du format originel de l'image
- urls — objet des URLs pour les différentes tailles enregistrées, picture.urls.thumbnail retournera l'URL pour la taille "thumbnail" de l'image
- is_default? — true si il sagit de l'image par défaut pour ce produit
- position — Ex: 1, 2, ...
- file_name — nom du fichier de l'image
- id
blog_post
Détails d'un article du blog.
- title — Ex: "Mon article"
- slug — Ex: "mon-article"
- category — objet blog_category
- extract — extrait facultatif, contient probablement de l'HTML
- content — contenu de l'article, peut contenir de l'HTML
- published_at
- accepts_comments? — true si les commentaires de blog sont ouverts ET si les commentaires sont ouvert sur cet article
- comments — tableau d'objets blog_comment
- id
blog_category
Détails d'une catégorie de blog.
- title — "Vêtements féminins"
- slug — Ex: "vetements-feminins"
- posts — tableau d'objets blog_post
- url — URL de la liste d'articles de cette catégorie
blog_comment
Détails d'un commentaire d'article de blog.
- author — nom de l'auteur
- email — e-mail de l'auteur
- ip_address
- content — contenu (sans HTML) de leur commentaire
- posted_at
- id
link_list
Détails d'une liste de liens.
- name — nom de la liste
- slug
- links — tableau d'objets link_list_link
- id
link_list_list
Détails d'un lien d'une liste de liens.
- title — titre du lien
- url — URL du lien
- id
page
Détails d'une page fixe.
- title — titre de la page
- slug
- content — contenu de la page, probablement HTML
- url — URL de la page
- id
cart
Détails du panier.
- grouped_variants — un tableau d'objets cart_variant
- products_quantity — nombre de produits dans le panier
- total — somme des prix des produits
- id
cart_variant
Détails d'un un produit/variante du panier.
- product_variant — un objet variant (= le produit si il n'a pas de variantes)
- quantity — quantité de ce produit/variante dans le panier, à partir de 1
- id