Bloques de Liquid personalizados para recibos impresos

Revisa las siguientes reglas de sintaxis antes de crear un bloque de Liquid personalizado:

• Los nombres de las variables usan letras minúsculas y guiones bajos, un formato conocido como snake_case. Por ejemplo, usa order.total_price, order.customer.display_name y order.line_items.
• Los valores monetarios son números simples. Dales formato con el filtro money, como {{ order.total_price | money }}.
• Protege los valores opcionales con una declaración if para no imprimir una línea vacía, como {% if order.customer.email %}{{ order.customer.email }}{% endif %}.
• Itera sobre las listas con una declaración for, como {% for item in order.line_items %} ... {% endfor %}.
• Algunas etiquetas de Liquid no son compatibles. No puedes usar assign, capture, include, render, raw, increment ni decrement. Si el bloque usa una etiqueta no compatible, el recibo no se guardará y verás un error.
• Un bloque de Liquid personalizado puede contener hasta 50 KB de código.

HTML y CSS

Puedes usar HTML básico en un bloque de Liquid personalizado para estructurar el contenido, como <p>, <br>, <strong>, <em>, encabezados, listas y enlaces. El contenido usa las fuentes y los tamaños existentes del recibo.

No puedes usar CSS para cambiar el aspecto de un recibo. Los bloques <style> y los atributos style no son compatibles para que un bloque de Liquid personalizado no pueda rediseñar ni ocultar contenido en otras partes del recibo. Las etiquetas <script>, los controladores de eventos como onclick y los enlaces de javascript: tampoco son compatibles.

Si el bloque contiene HTML no compatible, el recibo no se guardará y verás un error. Elimina el HTML no compatible y vuelve a guardar.

Un bloque de Liquid personalizado puede hacer referencia a los siguientes objetos y variables. Algunos valores no se encuentran en el recibo predeterminado, por lo que un bloque de Liquid personalizado es una forma de agregarlos.

Variables de nivel superior

Las siguientes variables de nivel superior están disponibles en un bloque de Liquid personalizado.

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 de cliente

El objeto order.customer contiene la información del cliente.

display_name

first_name

last_name

email

phone

default_address

metafields

Objeto de línea de artículo del pedido

Cada artículo en order.line_items contiene las siguientes propiedades.

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 transacción

Cada pago en order.transactions contiene las siguientes propiedades. El crédito en tienda que se gastó en el pedido se incluye como un pago con el nombre de Crédito en tienda. El saldo del crédito en tienda restante del cliente no está disponible como variable.

name

payment_type

amount

kind

status

credit_card_number

created_at

additional_details

Objeto de tienda

El objeto shop contiene la información de la tienda.

name

domain

currency

id

Objeto de sucursal

El objeto location contiene la información de la sucursal minorista.

name

address1

address2

city

province

province_code

zip

country

phone

metafields

Objeto de dirección

Una dirección, como order.shipping_address o order.customer.default_address, contiene las siguientes propiedades.

company

name

address1

address2

city

province

province_code

zip

country

country_code

phone

Objeto de descuento

Cada descuento en order.discounts o item.discounts contiene las siguientes propiedades.

description

amount

percentage

Objeto de línea de impuestos

Cada línea de impuestos en order.tax_lines contiene las siguientes propiedades.

title

rate

rate_percentage

price

taxable_amount

Objeto de tarjeta de regalo

Cada tarjeta de regalo en purchased_gift_cards contiene las siguientes propiedades.

code

masked_code

balance

created_at

qr_code_content

Los metacampos y las propiedades de línea de artículo tienen dos formatos.

Los metacampos y las propiedades de línea de artículo se basan en claves. Accede a un valor directamente mediante su clave:

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

Los metacampos de pedidos y clientes son listas. Itera sobre ellos:

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

Las claves se normalizan a snake_case. A una clave como Care Instructions o careInstructions se accede como care_instructions. Siempre haz referencia a los valores de clave en minúscula y con guiones bajos.

La disponibilidad de metacampos de pedido y cliente depende de que esos metacampos existan en el registro.

Puedes usar filtros para dar formato a la información en tu bloque personalizado de Liquid. Para aplicar un filtro, agrega un carácter de barra vertical, |, y luego el filtro dentro del resultado de Liquid; por ejemplo, {{ order.total_price | money }}.

Los filtros estándar de Liquid también funcionan. Para obtener más información sobre los filtros de Liquid, consulta la referencia de filtros.

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

Los siguientes ejemplos agregan contenido que no está en una plantilla de recibo impreso predeterminada.

Para agregar la nota de pedido (cuando haya una), usa el siguiente código de Liquid:

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

Para agregar el SKU junto a cada artículo, usa el siguiente código de Liquid:

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

Para agregar una propiedad de línea de artículo, como un grabado, usa el siguiente código de Liquid:

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

Para agregar un metacampo de producto, como las instrucciones de cuidado, usa el siguiente código de 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 agregar un metacampo de cliente, usa el siguiente código de Liquid:

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

Para agregar un código QR que enlace al pedido, usa el siguiente código de Liquid:

{{ order.qr_code_content | qrcode }}