Blocs Liquid personnalisés pour les reçus imprimés

Examinez les règles de syntaxe suivantes avant de créer un bloc Liquid personnalisé :

• Les noms de variables utilisent des lettres minuscules et des traits de soulignement, un format connu sous le nom de snake_case. Par exemple, utilisez order.total_price, order.customer.display_name et order.line_items.
• Les valeurs monétaires sont de simples nombres. Formatez-les avec le filtre money, tel que {{ order.total_price | money }}.
• Protégez les valeurs facultatives avec une instruction if afin de ne pas imprimer de ligne vide, comme {% if order.customer.email %}{{ order.customer.email }}{% endif %}.
• Parcourez les listes avec une instruction for, comme {% for item in order.line_items %} ... {% endfor %}.
• Certaines balises Liquid ne sont pas prises en charge. Vous ne pouvez pas utiliser assign, capture, include, render, raw, increment ou decrement. Si votre bloc utilise une balise non prise en charge, votre reçu ne s’enregistrera pas et vous verrez une erreur.
• Un bloc Liquid personnalisé peut contenir jusqu’à 50 Ko de code.

HTML et CSS

Vous pouvez utiliser du code HTML de base dans un bloc Liquid personnalisé pour structurer votre contenu, par exemple <p>, <br>, <strong>, <em>, des titres, des listes et des liens. Votre contenu utilise les polices et tailles existantes du reçu.

Vous ne pouvez pas utiliser de code CSS pour modifier l’apparence d’un reçu. Les blocs <style> et les attributs style ne sont pas pris en charge, de sorte qu’un bloc Liquid personnalisé ne peut pas modifier le style ni masquer du contenu ailleurs sur le reçu. Les balises <script>, les gestionnaires d’événements tels que onclick et les liens javascript: ne sont pas non plus pris en charge.

Si votre bloc contient du code HTML non pris en charge, votre reçu ne s’enregistrera pas et vous verrez une erreur. Supprimez le code HTML non pris en charge, puis enregistrez à nouveau.

Un bloc Liquid personnalisé peut référencer les objets et variables suivants. Certaines valeurs ne figurent pas sur le reçu par défaut, un bloc Liquid personnalisé constitue donc un moyen de les ajouter.

Variables de niveau supérieur

Les variables de niveau supérieur suivantes sont disponibles dans un bloc Liquid personnalisé.

order

shop

location

settings

purchased_gift_cards

staff_member_description

locale

is_pickup

pickup_location

Objet de commande

name

created_at

note

subtotal_price

total_price

shipping_price

total_tip_received

balance_due

change_due

taxes_included

receipt_number

barcode_content

qr_code_content

line_items

transactions

discounts

tax_lines

refunds

shipping_address

customer

metafields

Objet client

L’objet order.customer contient les détails du client.

display_name

first_name

last_name

email

phone

default_address

metafields

Objet d’article de la commande

Chaque article de order.line_items contient les propriétés suivantes.

name

variant_title

sku

vendor

quantity

price

total_price

discounted_total_price

discounted_unit_price

discounts

selling_plan_name

staff_member_description

custom_attributes

product_metafields

variant_metafields

Objet transaction

Chaque paiement dans order.transactions contient les propriétés suivantes. Le crédit en magasin dépensé pour la commande est répertorié comme un paiement nommé Store credit (Crédit en magasin). Le solde de crédit en magasin restant du client n’est pas disponible sous forme de variable.

name

payment_type

amount

kind

status

credit_card_number

created_at

additional_details

Objet boutique

L’objet shop contient les détails de la boutique.

name

domain

currency

id

Objet emplacement

L’objet location contient les détails de l’emplacement de vente au détail.

name

address1

address2

city

province

province_code

zip

country

phone

metafields

Objet adresse

Une adresse, telle que order.shipping_address ou order.customer.default_address, contient les propriétés suivantes.

company

name

address1

address2

city

province

province_code

zip

country

country_code

phone

Objet réduction

Chaque réduction dans order.discounts ou item.discounts contient les propriétés suivantes.

description

amount

percentage

Objet ligne de taxe

Chaque ligne de taxe dans order.tax_lines contient les propriétés suivantes.

title

rate

rate_percentage

price

taxable_amount

Objet carte-cadeau

Chaque carte-cadeau dans purchased_gift_cards contient les propriétés suivantes.

code

masked_code

balance

created_at

qr_code_content

Les champs méta et les propriétés d’articles se présentent sous deux formes.

Les champs méta et les propriétés d’articles sont associés à des clés. Accédez à une valeur directement par sa clé :

{{ item.product_metafields.care_instructions }}
{{ item.custom_attributes.engraving }}

Les champs méta de commande et de client sont des listes. Parcourez-les à l’aide d’une boucle :

{% for m in order.metafields %}
  {{ m.namespace }}.{{ m.key }}: {{ m.value }}
{% endfor %}

Les clés sont normalisées au format snake_case. Une clé telle que Care Instructions ou careInstructions est accessible via care_instructions. Référencez toujours les valeurs associées à des clés en minuscules avec des traits de soulignement.

La disponibilité des champs méta de commande et de client dépend de la présence de ces champs méta dans l’enregistrement.

Vous pouvez utiliser des filtres pour formater les informations de votre bloc Liquid personnalisé. Pour appliquer un filtre, ajoutez une barre verticale |, puis le filtre dans la balise de sortie Liquid, par exemple, {{ order.total_price | money }}.

Les filtres Liquid standard fonctionnent également. Pour en savoir plus sur les filtres Liquid, consultez la Référence des filtres.

money

{{ order.total_price | money }}

date

{{ order.created_at | date: '%B %e, %Y' }}

percent

{{ tax_line.rate | percent }}

t

{{ 'receipt.total' | t }}

barcode

{{ order.barcode_content | barcode }}

qrcode

{{ order.qr_code_content | qrcode }}

Les exemples suivants ajoutent du contenu qui ne figure pas sur un modèle de reçu imprimé par défaut.

Pour ajouter la note de commande si elle existe, utilisez le code Liquid suivant :

{% if order.note %}<p>Note: {{ order.note }}</p>{% endif %}

Pour ajouter le SKU à côté de chaque article, utilisez le code Liquid suivant :

{% for item in order.line_items %}
  <p>{{ item.name }} — {{ item.sku }} ×{{ item.quantity }}</p>
{% endfor %}

Pour ajouter une propriété d’article, comme une gravure, utilisez le code Liquid suivant :

{% for item in order.line_items %}
  {% if item.custom_attributes.engraving %}
    <p>{{ item.name }} — Engraving: {{ item.custom_attributes.engraving }}</p>
  {% endif %}
{% endfor %}

Pour ajouter un champ méta de produit, tel que des instructions d’entretien, utilisez le code Liquid suivant :

{% for item in order.line_items %}
  {% if item.product_metafields.care_instructions %}
    <p>{{ item.name }}: {{ item.product_metafields.care_instructions }}</p>
  {% endif %}
{% endfor %}

Pour ajouter un champ méta de client, utilisez le code Liquid suivant :

{% for m in order.customer.metafields %}
  {% if m.key == 'loyalty_tier' %}<p>Loyalty tier: {{ m.value }}</p>{% endif %}
{% endfor %}

Pour ajouter un code QR renvoyant à la commande, utilisez le code Liquid suivant :

{{ order.qr_code_content | qrcode }}