Blocos personalizados do Liquid para comprovantes impressos

Revise as seguintes regras de sintaxe antes de criar um bloco personalizado do Liquid:

• Nomes de variáveis usam letras minúsculas e sublinhados, um formato conhecido como "snake_case". Por exemplo, use order.total_price, order.customer.display_name e order.line_items.
• Valores em dinheiro são números simples. Formate-os com o filtro money, como {{ order.total_price | money }}.
• Proteja valores opcionais com uma instrução if para não imprimir uma linha em branco, como {% if order.customer.email %}{{ order.customer.email }}{% endif %}.
• Itere sobre listas com uma instrução for, como {% for item in order.line_items %} ... {% endfor %}.
• Não há compatibilidade com algumas tags do Liquid. Não é possível usar assign, capture, include, render, raw, increment ou decrement. Se o bloco usar uma tag incompatível, o comprovante não será salvo e você verá um erro.
• Um bloco personalizado do Liquid pode conter até 50 kB de código.

HTML e CSS

É possível usar HTML básico em um bloco personalizado do Liquid para estruturar o conteúdo, como <p>, <br>, <strong>, <em>, títulos, listas e links. O conteúdo usa as fontes e os tamanhos atuais do comprovante.

Não é possível usar CSS para alterar a aparência do comprovante. Blocos <style> e atributos style são incompatíveis. Assim, um bloco personalizado do Liquid não pode reestilizar ou ocultar o conteúdo em outros lugares do comprovante. Tags <script>, manipuladores de eventos como onclick e links javascript: também não são compatíveis.

Se o bloco contiver HTML incompatível, o comprovante não será salvo e você verá um erro. Remova o HTML incompatível e salve de novo.

Um bloco personalizado do Liquid pode referenciar os seguintes objetos e variáveis. Alguns valores não constam no comprovante padrão, portanto, uma das formas de adicioná-los é usando um bloco personalizado do Liquid.

Variáveis de nível superior

As seguintes variáveis de nível superior estão disponíveis em um bloco personalizado do Liquid.

order

shop

location

settings

purchased_gift_cards

staff_member_description

locale

is_pickup

pickup_location

Objeto de pedido

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

Objeto do cliente

O objeto order.customer contém as informações do cliente.

display_name

first_name

last_name

email

phone

default_address

metafields

Objeto de item de linha do pedido

Cada item em order.line_items contém as seguintes propriedades.

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

Objeto de transação

Cada pagamento em order.transactions contém as seguintes propriedades. O crédito na loja gasto no pedido é listado como um pagamento denominado "Crédito na loja". O saldo de crédito na loja restante do cliente não fica disponível como uma variável.

name

payment_type

amount

kind

status

credit_card_number

created_at

additional_details

Objeto da loja

O objeto shop é o objeto que contém as informações da loja.

name

domain

currency

id

Objeto de local

O objeto location é o objeto que contém as informações do local de varejo.

name

address1

address2

city

province

province_code

zip

country

phone

metafields

Objeto de endereço

Um endereço, como order.shipping_address ou order.customer.default_address, contém as seguintes propriedades.

company

name

address1

address2

city

province

province_code

zip

country

country_code

phone

Objeto de desconto

Cada desconto em order.discounts ou item.discounts contém as seguintes propriedades.

description

amount

percentage

Objeto de linha de tributo

Cada linha de tributo em order.tax_lines contém as seguintes propriedades.

title

rate

rate_percentage

price

taxable_amount

Objeto de cartão-presente

Cada cartão-presente em purchased_gift_cards contém as seguintes propriedades.

code

masked_code

balance

created_at

qr_code_content

Os metacampos e as propriedades de itens de linha podem ter dois formatos.

Os metacampos e as propriedades de itens de linha são indexados por chave. Acesse um valor diretamente pela chave correspondente:

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

Os metacampos de pedido e cliente são listas. Faça a iteração por eles:

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

As chaves são normalizadas para snake_case. O acesso a uma chave como Care Instructions ou careInstructions é feito por care_instructions. Sempre referencie valores com chave em letras minúsculas com sublinhados.

A disponibilidade dos metacampos de pedido e cliente depende da existência deles no registro.

É possível usar filtros para formatar as informações no bloco personalizado do Liquid. Para aplicar um filtro, adicione um caractere de barra vertical, |, e depois o filtro dentro da saída do Liquid, como em {{ order.total_price | money }}.

Os filtros padrão do Liquid também funcionam. Para saber mais, consulte a Referência de filtros do 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 }}

Os exemplos a seguir adicionam conteúdo que não está no modelo padrão de comprovante impresso.

Para adicionar a observação do pedido, quando houver, use o seguinte Liquid:

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

Para adicionar o SKU ao lado de cada item, use o seguinte Liquid:

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

Para adicionar uma propriedade de item de linha, como uma gravação, use o seguinte Liquid:

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

Para adicionar um metacampo de produto, como instruções de lavagem, use o seguinte Liquid:

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

Para adicionar um metacampo de cliente, use o seguinte Liquid:

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

Para adicionar um código QR com um link para o pedido, use o seguinte Liquid:

{{ order.qr_code_content | qrcode }}