Referência do Liquid de variáveis e filtros para o app Shopify Order Printer
Use o Liquid para criar seus modelos personalizados no app Shopify Order Printer, bem como criar e renderizar modelos de texto com base nos dados exclusivos de cada pedido.
As referências do Liquid listadas nesta página são uma extensão da versão de código aberto dessa linguagem e devem ser usadas no app Shopify Order Printer. Para renderizar informações com base em order
e shop
, use a lista de objetos, tags e filtros dessa referência para personalizar seus modelos. Além disso, você tem a opção de usar a documentação da API Admin GraphQL para conferir informações sobre os campos de objeto.
Nesta página
Usar variáveis e atributos
Nos modelos do Shopify Order Printer, os principais objetos de dados são order
e shop
. Use order.variable_name
para acessar os atributos do pedido.
Os seguintes atributos de pedido usados comumente são acessíveis sem o prefixo order.
:
line_items
tax_lines
fulfillments
transactions
discounts
refunds
shipping_methods
customer
Por exemplo, se você quiser acessar a variável de itens de linha, poderá usar line_items
ou order.line_items
.
Variáveis do Liquid disponíveis no Shopify Order Printer
Confira a seguir as classes disponíveis. Os atributos estão listados em ordem alfabética.
Pedido
Estes são os atributos de pedido disponíveis no Shopify Order Printer:
attributes
b2b
billing_address
cancel_reason
cancel_reason_label
cancelled
cancelled_at
cart_level_discount_applications
checkout_id
checkout_payment_collection_url
company
company_location
confirmation_number
created_at
. O momento em que o pedido foi processado. É igual aorder.processed_at
da API GraphQL. Use o filtrodate
para formatar a marcação de data e hora, por exemplo, com{{ order.created_at | date: "%B %e, %Y" }}
.customer
discounts
. Descontinuado porque nem todos os tipos a informações de desconto são capturados. A propriedadeorder.discounts
foi substituída pororder.discount_applications
.discounts_amount
. Descontinuado porque nem todos os tipos a informações de desconto são capturados. A propriedadeorder.discounts
foi substituída pororder.total_discounts
.discount_applications
discounts_savings
. Descontinuado porque nem todos os tipos a informações de desconto são capturados. A propriedadeorder.discounts
foi substituída por-
.email
fees
financial_status
financial_status_label
fulfilled_line_items
fulfillment_aborted
fulfillment_status
fulfillments
gateway
id
item_count
landing_site
landing_site_ref
line_items
line_items_subtotal_price
location
metafields
name
net_payment
note
order_name
order_number
order_status_url
payment
payment_details
po_number
refunds
requires_shipping
shipping_address
shipping_method
shipping_methods
shipping_price
shop
shop_name
subtotal_price
tags
tax_lines
tax_price
tip_line_items
total_discounts
total_duties
total_landed_cost_additional_fees
total_net_amount
total_outstanding
total_price
total_refunded_amount
total_tip
transactions
unacceptable_risks
unfulfilled_line_items
unique_gateways
user
void_transactions
Shop
Confira na lista a seguir os atributos de loja disponíveis no Shopify Order Printer:
accepts_gift_cards
account_owner
allows_discounts
checkout
checkout_requires_confirmation_step
collections_count
contact_information
currency
customer_accounts_enabled
customer_accounts_optional
description
domain
email
email_accent_color
email_logo_url
email_logo_width
email_marketing
enabled_currencies
enabled_locales
enabled_payment_types
features
id
latitude
legal_notice
longitude
metafields
money_format
money_with_currency_format
name
password_message
permanent_domain
phone
policies
privacy_policy
products_count
refund_policy
secure_url
shipping_policy
subscription_policy
terms_of_sale
terms_of_service
types
url
LineItem
Confira na lista a seguir os atributos de item de linha disponíveis no Shopify Order Printer:
aggregated_update
applied_discounts
. Descontinuado porque nem todos os tipos a informações de desconto estão disponíveis. A propriedadeline_item.discounts
foi substituída porline_item.discount_allocations
.current_quantity
discount_allocations
discounts
. Descontinuado porque nem todos os tipos a informações de desconto estão disponíveis. A propriedadeline_item.discounts
foi substituída porline_item.discount_allocations
.final_line_price
final_price
fulfillment
fulfillment_service
gift_card
grams
groups
id
image
index
item_updates
json_filter
key
line_level_discount_allocations
line_level_total_discount
line_price
. Descontinuado porque os descontos de descontos automáticos e códigos de desconto não são incluídos. A propriedadeline_item.line_price
foi substituída porline_item.final_line_price
.message
options_with_values
original_line_price
original_price
price
. Descontinuado porque os descontos de descontos automáticos e códigos de desconto não são incluídos. A propriedadeline_item.price
foi substituída porline_item.final_price
.product
product_id
properties
quantity
refunded_quantity
requires_shipping
selling_plan_allocation
sku
successfully_fulfilled_quantity
tax_lines
taxable
title
total_discount
. Descontinuado porque os descontos de descontos automáticos e códigos de desconto não são incluídos. A propriedadeline_item.total_discount
foi substituída porline_item.line_level_total_discount
.unit_price
unit_price_measurement
url
url_to_remove
variant
variant_id
vendor
Processamento
Confira na lista a seguir os atributos de processamento de pedidos disponíveis no Shopify Order Printer:
created_at
. Use o filtrodate
para formatar a marcação de data e hora, por exemplo, com{{ fulfillment.created_at | date: "%B %e, %Y" }}
.estimated_delivery_at
fulfillment_line_items
item_count
line_items
requires_shipping
tracking_company
tracking_number
tracking_numbers
tracking_url
tracking_urls
updated_at
Endereço
Confira na lista a seguir os atributos de endereço disponíveis no Shopify Order Printer:
address1
address2
city
company
country
country_code
country_upper
errors
first_name
id
last_name
name
phone
province
province_code
street
summary
translated_country_name
translated_province_name
url
zip
Cliente
Confira na lista a seguir os atributos de cliente disponíveis no Shopify Order Printer:
accepts_marketing
account_activation_url
addresses
addresses_count
b2b?
default_address
email
first_name
has_account
id
last_name
last_order
metafields
name
new_address
orders
orders_count
payment_methods
phone
reset_password_url
subscribe_url
tags
tax_exempt
total_spent
DiscountApplication
Confira na lista abaixo os atributos DiscountApplication disponíveis no Shopify Order Printer:
target_selection
target_type
title
total_allocated_amount
type
value_type
value
Imprimir descontos
Os descontos podem ser aplicados ao pedido inteiro ou a itens de linha específicos:
- Descontos no nível do pedido: são aplicados ao pedido inteiro. É possível exibir os descontos separadamente na parte inferior ao imprimir a fatura.
- Descontos no nível de itens de linha: são aplicados a itens individuais. É possível mencionar esses descontos na impressão das informações de itens individuais, na seção de itens de linha.
As informações de descontos podem ser acessadas com estas variáveis:
Acesse todos os descontos aplicados ao pedido ou a um dos itens de linha com o valor
order.total_discounts
e a coleçãoorder.discount_applications
.Acesse os descontos de itens de linha com o valor
line_item.line_level_total_discount
ou a coleçãoline_item.line_level_discount_allocations
.Acesse o preço do item de linha anterior à aplicação do desconto com o valor
line_item.original_price
. - Acesse o preço resultante do item de linha após a aplicação de todos os descontos relacionados no nível de item de linha com o valorline_item.final_price
. - Os valoresline_item.original_line_price
eline_item.final_line_price
são iguais aos valoresline_item.original_price
eline_item.final_price
multiplicados porline_item.quantity
.Acesse os descontos no nível de pedido com a coleção
order.cart_level_discount_applications
.
Exemplo de bloco de código para imprimir descontos no nível de item de linha:
{% for line_item in order.line_items %}
<tr>
<td>{{ line_item.quantity }}</td>
<td>{{ line_item.title }}
{% if line_item.line_level_discount_allocations.size > 0 %}
<span class="subduedText">
{% for discount_allocation in line_item.line_level_discount_allocations %}
<br>{{ discount_allocation.discount_application.title }} (-{{ discount_allocation.amount | money }})
{% endfor %}
</span>
{% endif %}
</td>
<td style="text-align: right;">
{% if line_item.original_price != line_item.final_price %}
<span class="subduedText"><s>{{ line_item.original_price | money }}</s></span>
{% endif %}
{{ line_item.final_price | money }}
</td>
</tr>
{% endfor %}
Exemplo de bloco de código para imprimir descontos no nível do pedido:
{% for discount_application in order.cart_level_discount_applications %}
<tr>
<td colspan="2" style="text-align: right;">{% if discount_application.title %}<span class="subduedText">{{ discount_application.title }}</span>{% endif %}</td>
<td style="text-align: right;">-{{ discount_application.total_allocated_amount | money }}</td>
</tr>
{% endfor %}
- Saiba mais sobre os tipos de desconto e sobre como trabalhar com descontos no Liquid.
DiscountAllocation
Confira na lista abaixo os atributos DiscountAllocation disponíveis no Shopify Order Printer:
amount
discount_application
Desconto
Confira na lista a seguir os atributos de desconto disponíveis no Shopify Order Printer:
amount
code
free_shipping_discount
id
savings
title
total_amount
total_savings
Produto
Confira na lista a seguir os atributos de produto disponíveis no Shopify Order Printer:
as_json
available
collections
compare_at_price
compare_at_price_max
compare_at_price_min
compare_at_price_varies
content
created_at
description
featured_image
featured_media
first_available_variant
gift_card?
handle
has_only_default_variant
id
images
json_filter
media
metafields
object_type
options
options_by_name
options_with_values
price
price_max
price_min
price_varies
published_at
requires_selling_plan
selected_or_first_available_selling_plan_allocation
selected_or_first_available_variant
selected_selling_plan
selected_selling_plan_allocation
selected_variant
selling_plan_groups
tags
template_suffix
title
type
url
variants
vendor
Variante
Confira na lista a seguir os atributos de variante disponíveis no Shopify Order Printer:
as_json
available
barcode
compare_at_price
featured_image
featured_media
id
image
incoming
inventory_management
inventory_policy
inventory_quantity
json_filter
metafields
next_incoming_date
option1
option2
option3
options
price
product
requires_selling_plan
requires_shipping
selected_selling_plan_allocation
selling_plan_allocations
sku
store_availabilities
taxable
title
unit_price
unit_price_measurement
url
weight
weight_in_unit
weight_unit
Reembolsar
Confira na lista a seguir os atributos de reembolso disponíveis no Shopify Order Printer:
amount
created_at
id
note
refund_line_items
restock
transactions
ShippingLine
Confira na lista a seguir os atributos de linha de frete disponíveis no Shopify Order Printer:
handle
id
original_price
price
. Desativado porque o preço não incluiu descontos no nível do pedido. A propriedadeshipping_line.price
foi substituída porshipping_line.price_with_discounts
.price_with_discounts
tax_lines
title
TaxLine
Confira na lista a seguir os atributos de linha de tributo disponíveis no Shopify Order Printer:
price
rate
rate_percentage
title
Transação
Confira na lista a seguir os atributos de transação disponíveis no Shopify Order Printer:
amount
buyer_pending_payment_instructions
buyer_pending_payment_notice
created_at
gateway
gateway_display_name
id
kind
name
payment_details
receipt
show_buyer_pending_payment_instructions
status
status_label
Metacampo
Um metacampo anexado a um objeto principal. Para saber como acessar um metacampo em um objeto específico, consulte Acessar metacampos.
Os metacampos aceitam vários tipos de dados, que determinam o gênero de informação armazenada. O caminho de acesso a metacampos é composto por duas camadas:
- Namespace: um grupo de metacampos para evitar conflitos.
- Chave: o nome do metacampo.
Devido a isso, é possível acessar o objeto de metacampo com esta sintaxe: {{ resource.metafields.namespace.key }}
.
Nome: <object>.metafields.<namespace>.<key>
. Por exemplo, order.metafields.shipping.express_delivery_status
.
Tipos:
String
Array
: use[]
para indexar. Por exemplo,order.metafield.shipping.express_delivery_status[0]
Integer
Boolean
Date
Observação: o tipo Metaobject
não é compatível.
Objetos que aceitam metacampos:
Order
Customer
Product
Variant
Location
Filtros do Liquid disponíveis no Shopify Order Printer
Uso
Para aplicar filtros a uma saída, adicione o filtro e seus parâmetros às chaves delimitadoras da saída {{ }}
, precedidos por um caractere de barra vertical |
. No exemplo abaixo, o produto é o objeto, o título é sua propriedade e upcase é o filtro aplicado:
{{ product.title | upcase }}
Se product.title
tiver o valor Health potion
, HEALTH POTION
será a saída do filtro upcase
.
Consulte a seção Filtros na referência do Liquid para temas da Shopify se quiser saber mais sobre como usar os filtros do Liquid.
Filtros a serem aplicados em objetos Address
format_address
Para conferir exemplos de uso, consulte a documentação do Liquid para temas da Shopify sobre format_address.
Filtros a serem aplicados em todos os textos/strings
camelcase
camelize
encode_url_component
format_code
handle
highlight
pad_spaces
paragraphize
pluralize
url_escape
url_param_escape
Para conferir exemplos de uso, consulte a documentação do Liquid para temas da Shopify sobre filtros de string.
Filtros a serem aplicados em números relacionados a dinheiro
money
money_with_currency
money_without_currency
money_without_trailing_zeros
O Shopify Order Printer usa as opções de formatação da moeda das notificações por e-mail configuradas no admin da Shopify para formatar dinheiro. Você pode alterar a formatação da moeda. Defina os valores de Email with currency
e Email without currency
no admin da Shopify para alterar a formatação dos filtros de dinheiro no Shopify Order Printer.
Para conferir exemplos de uso, consulte a documentação do Liquid para temas da Shopify sobre filtros de dinheiro.
Filtros a serem aplicados para converter objetos em JSON
json
Para conferir exemplos de uso, consulte a documentação do Liquid para temas da Shopify sobre filtros JSON.
Filtros a serem aplicados em números relacionados a peso
weight
weight_with_unit
Para conferir exemplos de uso, consulte a documentação do Liquid para temas da Shopify sobre peso com unidade.
Filtros a serem aplicados em tags
highlight_active_tag
link_to_add_tag
link_to_remove_tag
link_to_tag
Para conferir exemplos de uso, consulte a documentação do Liquid para temas da Shopify sobre filtros de tag.
Filtros a serem aplicados em URLs
article_img_url
asset_img_url
asset_url
cdn_asset_url
collection_img_url
file_img_url
file_url
global_asset_url
image_url
img_tag
img_url
link_to
payment_icon_png_url
payment_type_img_url
payment_type_svg_tag
placeholder_svg_tag
product_img_url
script_tag
shopify_asset_url
stylesheet_tag
Para conferir exemplos de uso, consulte a documentação do Liquid para temas da Shopify sobre filtros de mídia e HTML.
Filtros a serem aplicados em coleções
link_to_type
link_to_vendor
sort_by
url_for_type
url_for_vendor
within
Para conferir exemplos de uso, consulte a documentação do Liquid para temas da Shopify sobre filtros de coleção.