Niestandardowe bloki Liquid dla drukowanych paragonów

Przed utworzeniem niestandardowego bloku Liquid zapoznaj się z poniższymi zasadami składni:

• Nazwy zmiennych zapisuje się małymi literami i ze znakami podkreślenia, co stanowi format znany jako snake_case. Użyj na przykład order.total_price, order.customer.display_name i order.line_items.
• Wartości pieniężne to zwykłe liczby. Sformatuj je za pomocą filtru money, tak jak w przypadku {{ order.total_price | money }}.
• Zabezpiecz opcjonalne wartości za pomocą instrukcji if, aby uniknąć drukowania pustego wiersza, np. {% if order.customer.email %}{{ order.customer.email }}{% endif %}.
• Wykonuj iteracje na listach za pomocą instrukcji for, np. {% for item in order.line_items %} ... {% endfor %}.
• Niektóre tagi Liquid nie są obsługiwane. Nie można używać tagów assign, capture, include, render, raw, increment ani decrement. Jeśli użyjesz w bloku nieobsługiwanego tagu, zapisanie paragonu nie będzie możliwe i pojawi się błąd.
• Niestandardowy blok Liquid może zawierać do 50 KB kodu.

HTML i CSS

Aby ustrukturyzować treść w niestandardowym bloku Liquid, możesz użyć podstawowych tagów HTML, np. <p>, <br>, <strong>, <em>, nagłówków, list i linków. Twoja treść będzie wykorzystywać istniejące czcionki i rozmiary zdefiniowane dla paragonu.

Do zmiany wyglądu paragonu nie można użyć języka CSS. Bloki <style> oraz atrybuty style nie są obsługiwane po to, by niestandardowy blok Liquid nie mógł modyfikować wyglądu ani ukrywać innych treści na paragonie. Tagi <script>, procedury obsługi zdarzeń, takie jak onclick, oraz linki javascript: również nie są obsługiwane.

Jeśli blok zawiera nieobsługiwany kod HTML, paragon nie zostanie zapisany i wyświetli się błąd. Usuń nieobsługiwany kod HTML, a następnie spróbuj ponownie zapisać zmianę.

Niestandardowy blok Liquid może odwoływać się do następujących obiektów i zmiennych. Niektóre wartości nie występują na domyślnym paragonie, więc użycie niestandardowego bloku Liquid jest jednym ze sposobów na ich dodanie.

Zmienne najwyższego poziomu

Następujące zmienne najwyższego poziomu są dostępne w niestandardowym bloku Liquid.

order

shop

location

settings

purchased_gift_cards

staff_member_description

locale

is_pickup

pickup_location

Obiekt zamówienia

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

Obiekt klienta

Obiekt order.customer zawiera dane klienta.

display_name

first_name

last_name

email

phone

default_address

metafields

Obiekt pozycji pojedynczej zamówienia

Każda pozycja w order.line_items zawiera następujące właściwości.

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

Obiekt transakcji

Każda płatność w order.transactions zawiera następujące właściwości. Kredyty sklepowe wydane na zamówienie są wymienione jako płatność o nazwie Store credit. Pozostałe saldo kredytów sklepowych klienta nie jest dostępne jako zmienna.

name

payment_type

amount

kind

status

credit_card_number

created_at

additional_details

Obiekt sklepu

Obiekt shop zawiera dane sklepu.

name

domain

currency

id

Obiekt lokalizacji

Obiekt location zawiera dane lokalizacji detalicznej.

name

address1

address2

city

province

province_code

zip

country

phone

metafields

Obiekt adresu

Adres, taki jak order.shipping_address lub order.customer.default_address, zawiera następujące właściwości.

company

name

address1

address2

city

province

province_code

zip

country

country_code

phone

Obiekt rabatu

Każdy rabat w order.discounts lub item.discounts zawiera następujące właściwości.

description

amount

percentage

Obiekt pozycji podatku

Każda pozycja podatku w order.tax_lines zawiera następujące właściwości.

title

rate

rate_percentage

price

taxable_amount

Obiekt karty prezentowej

Każda karta prezentowa w purchased_gift_cards zawiera następujące właściwości.

code

masked_code

balance

created_at

qr_code_content

Metapola i właściwości pozycji pojedynczej mają dwie formy.

Metapola i właściwości pozycji pojedynczej są powiązane z kluczami. Uzyskaj dostęp do wartości bezpośrednio przez jej klucz:

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

Metapola zamówień i klientów to listy. Przejdź przez nie w pętli:

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

Klucze są znormalizowane do formatu snake_case. Dostęp do klucza, takiego jak Care Instructions lub careInstructions, uzyskuje się jako care_instructions. Zawsze odwołuj się do wartości kluczy za pomocą małych liter i podkreśleń.

Dostępność metapól zamówień i klientów zależy od tego, czy te metapola istnieją w rekordzie.

Możesz użyć filtrów do formatowania informacji w niestandardowym bloku Liquid. Aby zastosować filtr, dodaj znak pionowej kreski |, a następnie wstaw filtr wewnątrz danych wyjściowych Liquid, np. {{ order.total_price | money }}.

Działają również standardowe filtry Liquid. Aby dowiedzieć się więcej o filtrach Liquid, zapoznaj się z dokumentacją filtrów.

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 }}

Poniższe przykłady umożliwiają dodanie treści, której nie ma w domyślnym szablonie drukowanego paragonu.

Aby dodać uwagę do zamówienia (jeśli istnieje), użyj poniższego kodu Liquid:

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

Aby dodać kod SKU obok każdej pozycji, użyj poniższego kodu Liquid:

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

Aby dodać właściwość pozycji pojedynczej, na przykład informację o grawerowaniu, użyj poniższego kodu Liquid:

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

Aby dodać metapole produktu, na przykład instrukcję pielęgnacji, użyj poniższego kodu Liquid:

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

Aby dodać metapole klienta, użyj poniższego kodu Liquid:

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

Aby dodać kod QR, który kieruje do zamówienia, użyj poniższego kodu Liquid:

{{ order.qr_code_content | qrcode }}