Пользовательские блоки Liquid для печатных квитанций

Прежде чем создавать пользовательский блок Liquid, ознакомьтесь со следующими правилами синтаксиса:

• В именах переменных используются строчные буквы и символы подчеркивания. Этот формат известен как snake_case. Например: order.total_price, order.customer.display_name и order.line_items.
• Денежные суммы представлены в виде простых чисел. Форматируйте их с помощью фильтра money, например {{ order.total_price | money }}.
• Защитите необязательные значения оператором if, чтобы избежать вывода пустой строки. Например: {% if order.customer.email %}{{ order.customer.email }}{% endif %}.
• Перебирайте списки с помощью оператора for, например {% for item in order.line_items %} ... {% endfor %}.
• Некоторые теги Liquid не поддерживаются. Вы не можете использовать assign, capture, include, render, raw, increment или decrement. Если в вашем блоке используется неподдерживаемый тег, квитанция не будет сохранена, и появится сообщение об ошибке.
• Пользовательский блок Liquid может содержать до 50 КБ кода.

HTML и CSS

Вы можете использовать базовый HTML в пользовательском блоке Liquid для структурирования контента, например <p>, <br>, <strong>, <em>, заголовки, списки и ссылки. Ваш контент использует существующие шрифты и размеры квитанции.

Вы не можете использовать CSS для изменения внешнего вида квитанции. Блоки <style> и атрибуты style не поддерживаются, поэтому пользовательский блок Liquid не может изменить стиль или скрыть контент в других местах квитанции. Теги <script>, обработчики событий (такие как onclick) и ссылки javascript: также не поддерживаются.

Если ваш блок содержит неподдерживаемый HTML, квитанция не будет сохранена, и появится сообщение об ошибке. Удалите неподдерживаемый HTML и сохраните изменения еще раз.

Пользовательский блок Liquid может ссылаться на следующие объекты и переменные. Некоторые значения отсутствуют в стандартной квитанции, поэтому пользовательский блок Liquid — один из способов их добавить.

Переменные верхнего уровня

В пользовательском блоке Liquid доступны следующие переменные верхнего уровня.

order

shop

location

settings

purchased_gift_cards

staff_member_description

locale

is_pickup

pickup_location

Объект заказа

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

Объект клиента

Объект order.customer содержит данные клиента.

display_name

first_name

last_name

email

phone

default_address

metafields

Объект позиции заказа

Каждая позиция в order.line_items содержит следующие свойства.

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

Объект транзакции

Каждый платеж в order.transactions содержит следующие свойства. Кредит магазина, потраченный на заказ, указывается как платеж с названием Store credit. Оставшийся баланс кредита магазина клиента недоступен в качестве переменной.

name

payment_type

amount

kind

status

credit_card_number

created_at

additional_details

Объект магазина

Объект shop содержит данные магазина.

name

domain

currency

id

Объект места расположения

Объект location содержит данные места расположения розничной точки.

name

address1

address2

city

province

province_code

zip

country

phone

metafields

Объект адреса

Адрес, например order.shipping_address или order.customer.default_address, содержит следующие свойства.

company

name

address1

address2

city

province

province_code

zip

country

country_code

phone

Объект скидки

Каждая скидка в order.discounts или item.discounts содержит следующие свойства.

description

amount

percentage

Объект строки налога

Каждая строка налога в order.tax_lines содержит следующие свойства.

title

rate

rate_percentage

price

taxable_amount

Объект подарочной карты

Каждая подарочная карта в purchased_gift_cards содержит следующие свойства.

code

masked_code

balance

created_at

qr_code_content

Метаполя и свойства позиций бывают двух видов.

Метаполя и свойства позиций имеют ключи. Обращайтесь к значению напрямую по его ключу:

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

Метаполя заказов и клиентов представляют собой списки. Перебирайте их в цикле:

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

Ключи нормализуются в формат snake_case. Ключ типа Care Instructions или careInstructions доступен как care_instructions. Всегда указывайте значения с ключами в нижнем регистре с нижним подчеркиванием.

Доступность метаполей заказов и клиентов зависит от наличия этих метаполей в записи.

Вы можете использовать фильтры для форматирования информации в пользовательском блоке Liquid. Чтобы применить фильтр, добавьте символ вертикальной черты |, а затем фильтр в вывод Liquid, например {{ order.total_price | money }}.

Стандартные фильтры Liquid также работают. Чтобы узнать больше о фильтрах Liquid, ознакомьтесь со Справочником по фильтрам.

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

В следующих примерах добавляется контент, которого нет в шаблоне распечатанной квитанции по умолчанию.

Чтобы добавить примечание к заказу, если оно есть, используйте следующий код Liquid:

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

Чтобы добавить SKU рядом с каждым предметом, используйте следующий код Liquid:

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

Чтобы добавить свойство позиции, например гравировку, используйте следующий код Liquid:

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

Чтобы добавить метаполе продукта, например инструкции по уходу, используйте следующий код Liquid:

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

Чтобы добавить метаполе клиента, используйте следующий код Liquid:

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

Чтобы добавить QR-код со ссылкой на заказ, используйте следующий код Liquid:

{{ order.qr_code_content | qrcode }}