通知变量参考
从商店发出的通知是使用 Liquid 呈现的。Liquid 是 Shopify 的简单易用的编程语言。我们在模板商店中提供的模板也是采用这种编程语言构建的。
若要编辑从商店发送的通知,您可以对您的通知模板进行基本的自定义。若要访问您可以自定义的通知的完整列表,请转到 Shopify 后台中的通知页面。
若要获取有关更高级更改的帮助或要更改自定义通知模板,您可以访问我们论坛上的社区,也可以聘请一位 Shopify 合作伙伴来为您完成自定义工作。详细了解如何聘请 Shopify 合作伙伴。
订单属性
一个订单的许多属性可以直接通过使用 Liquid、模板和自定义脚本获取。
属性 | 描述 |
---|---|
id |
订单在系统范围内的唯一 ID,供内部使用。使用以下示例在商店的后台部分生成指向订单的链接。例如,在新订单模板中,您可以添加以下代码: <a href="{{ shop.url }}/admin/orders/{{ id }}">查看订单</a> |
与订单关联的电子邮件。 | |
name |
通常是一个 # 符号,后跟 示例:#1004 |
order_name |
与名称相同。 |
order_number |
订单在商店中的唯一编号,没有 # 前缀,店主也不会在商店偏好设置中为订单 ID 添加任何前缀或后缀。 例如:1004 |
confirmation_number |
系统可能向客户显示为订单随机生成的字母数字识别码,而不是按顺序排列的订单名称。此值不一定是唯一的。 示例:XPAV284CT |
created_at |
客户创建订单的日期和时间。您可以使用日期筛选器对其进行格式化。 示例:2009-05-30T17:43:51+02:00 |
payment_terms |
付款期限指定了订单的应付款日期。 了解如何向订单发票中添加付款期限。 有关详细信息,请参阅 payment_terms 的 Liquid 参考。 |
destination |
应将商品发送到的目的地。 |
tags |
返回所有订单标签的数组。标签按字母顺序返回。有关详细信息,请参阅我们的 Liquid 参考文档。 |
transactions |
返回订单中交易的数组。 |
tax_price |
订单中所有商品的综合税金。 |
tax_lines |
按税种划分的税金:
|
tax_line.title |
税金的名称。 示例:QST 或 VAT |
tax_line.price |
金额。 |
tax_line.rate |
税率。如果是 17.5%,则将返回 0.175。 |
tax_line.rate_percentage |
采用可人工读取形式的税率。如果费率为 0.175,它将返回 17.5。 |
customer |
包含 customer 输出属性的 Customer 对象。 |
billing_address |
账单地址。 |
billing_address.first_name |
客户的名字。 |
billing_address.last_name |
客户的姓氏。 |
billing_address.company |
计费公司名称。 |
billing_address.phone |
账单地址中的电话号码。 |
shop.name |
您的商店名称。 |
shop.phone |
您商店的电话号码。 |
subtotal_price |
扣除任何订单项目折扣或购物车折扣后的订单项目价格总额。小计不含税费(除非税费已包含在价格中)、运费或小费。 |
discounts |
折扣列表。 |
discounts_amount |
所有折扣适用的折扣金额。 示例:+5.00 美元 |
discounts_savings |
使用所有折扣所节省的金额。 例如:-5.00 美元 |
total_price |
订单的总价(小计 + 运费 - 运费折扣 + 税金)。 |
financial_status |
当前的付款状态。可能的属性值包括:空、待付款 、已授权 、已付款 、已作废 和已退款 。 |
requires_shipping |
(布尔值)如果订单中至少有一件产品需要发货,则返回 true。 |
shipping_method.title |
运费名称。 在面向客户的通知中,当运费名称与默认商店语言不同时,运费名称会翻译为客户查看的语言。 示例:标准运费 |
shipping_method.price |
包括所有运费折扣的运费。 示例: |
shipping_price |
运费。 示例: |
shipping_address |
收货地址。 |
shipping_address.first_name |
收货地址中的名字。 |
shipping_address.company |
收货地址中的公司名称。 |
shipping_address.phone |
收货地址的电话号码。 |
line_items |
订单中所有订单项目的列表。 |
item_count |
所有商品的数量总和。 |
fulfillment_status |
订单的当前发货状态。可能的属性值包括:未发货 、部分发货 和已发货 。 |
note |
附加至订单的备注。该备注可以从客户处获取以及/或者在您的后台界面的订单详情页中编辑。 |
attributes |
附加到订单的任何属性。 示例: |
referring_site |
包含将客户引导至您商店的推荐来源的 URL。 示例: |
landing_site |
包含客户使用的登陆网站的路径。这是客户访问商店时看到的首个页面。 示例: |
landing_site_ref |
查看登陆网站并从中提取引用参数。引用参数可以为: 如果 {% if landing_site_ref == 'my-tracking-token' %} My action... {% endif %} |
cancelled |
(布尔值)如果订单已被取消,则返回 true。 |
cancelled_at |
订单取消的时间。 |
cancel_reason |
取消订单时所选择的原因。可以为以下原因之一:库存 、客户 、已拒绝 、欺诈 、其他 。 |
has_high_risks?(deprecated) |
如果订单存在高风险,则返回 true |
unique_gateways |
返回订单上唯一支付服务提供商的列表。例如,如果有人使用 Visa、Mastercard 和现金付款,则返回的列表为 |
location (POS only) |
|
order_status_url |
返回指向此订单的订单状态页面的链接。 |
fulfilled_line_items(deprecated) |
已发货的订单项列表。 |
unfulfilled_line_items(deprecated) |
尚未全部发货的订单项目的列表。 |
b2b? |
如果订单是 B2B 订单,则返回 true。使用具有 B2B 变量的属性在电子邮件中显示相关信息,例如公司名称、公司地点和地址。例如,对于 B2B 订单,您可以向模板中添加包含以下信息的标头:
|
company |
您的 B2B 订单的采购公司。 |
company.name |
B2B 订单中的公司名称。 |
company.id |
B2B 订单中的公司 ID。 |
company_location |
B2B 订单中的公司地点。向您下单的公司可以拥有多个地点。 |
company_location.name |
B2B 订单中公司地点的名称。 |
company_location.id |
B2B 订单中公司地点的 ID 号。 |
company_location.shipping_address |
B2B 订单中公司地点的收货地址。 |
company_location.billing_address |
B2B 订单中公司地点的账单地址。 |
customer_order_url |
草稿订单属性
属性 | 描述 |
---|---|
id |
草稿订单的唯一 ID,供内部使用。 |
invoice_url |
一个链接,客户可以通过此链接使用 Shopify 的安全结账支付发票。 |
reserve_inventory_until |
在草稿中将订单项目保留至的日期和时间,例如, 您可以使用 Liquid 日期筛选器对日期进行格式化。 |
user |
上次修改草稿订单的员工。 |
user.name |
上次修改草稿订单的员工的姓名。 |
user.email |
上次修改草稿订单的员工的电子邮件地址。 |
与草稿订单关联的电子邮件地址。 | |
name |
草稿订单的唯一 number ,前缀为数字符号 # 。 |
number |
草稿订单的唯一编号,无订单前缀或后缀。 |
created_at |
客户创建草稿订单的日期和时间,例如, 您可以使用 Liquid 日期筛选器对日期进行格式化。 |
tags |
返回所有订单标签的数组。标签按字母顺序返回。有关详细信息,请参阅我们的 Liquid 参考文档。 |
tax_price |
草稿订单中所有产品的综合税金。 |
tax_lines |
按税种划分的税金: {% for tax_line in tax_lines %} {{ tax_line.title }} ({{ tax_line.rate_percentage }}%) : {{ tax_line.price | money_with_currency }} {% endfor %} |
tax_line.title |
税金的名称。 示例:QST 或 VAT |
tax_line.price |
税额。 |
tax_line.rate |
采用十进制形式的税率。例如,若税率为 17.5%,则返回 0.175 。 |
tax_line.rate_percentage |
采用百分比形式的税率。例如,若税率 为 0.175,则返回 17.5 。 |
customer |
包含 customer 输出属性的 Customer 对象。 |
billing_address |
草稿订单的账单地址。 |
billing_address.first_name |
客户的名字。 |
billing_address.last_name |
客户的姓氏。 |
billing_address.company |
账单地址中的公司名称。 |
billing_address.phone |
账单地址中的电话号码。 |
shop.name |
商店名称。 |
shop.phone |
您商店的电话号码。 |
subtotal_price |
扣除任何订单项目折扣或购物车折扣后的草稿订单项目价格总额。小计不含税费(除非税费已包含在价格中)或运费。 |
discounts |
折扣列表。 |
discounts_amount |
所有折扣适用的折扣金额。 示例:+5.00 美元 |
discounts_savings |
使用所有折扣所节省的金额。 例如:-5.00 美元 |
total_price |
订单的总价(小计 + 运费 - 运费折扣 + 税金)。 |
requires_shipping |
如果草稿订单中至少有一件商品需要发货,则返回 true 。如果草稿订单中没有需要发货的商品,则返回 false 。 |
shipping_method.title |
运费名称。 示例:标准运费 |
shipping_method.price |
发货方式的价格。返回与 shipping_price 相同的信息。 |
shipping_price |
运费。 您可以使用 Liquid 金钱筛选器格式化此金额。 |
shipping_address |
收货地址。 备注:与常规订单不同,草稿订单中的收货地址可能不完整。 |
shipping_address.first_name |
收货地址中的名字。 |
shipping_address.company |
收货地址中的公司名称。 |
shipping_address.phone |
收货地址中的电话号码。 |
line_items |
草稿订单中的所有订单项目的列表。 |
item_count |
草稿订单中所有商品数量的综合。 |
note |
附加至草稿订单的备注。该备注可以从客户处获取,也可以在 Shopify 后台的草稿订单详情页中编辑。 |
location |
订单的实际地点。有几种可用的地点属性。 您可以在 Shopify 后台的地点页面配置地点。 |
b2b? |
如果订单是 B2B 订单,则返回 true。使用具有 B2B 变量的属性在电子邮件中显示相关信息,例如公司名称、公司地点和地址。例如,对于 B2B 订单,您可以向模板中添加包含以下信息的标头:
|
company |
您的 B2B 订单的采购公司。 |
company.name |
B2B 订单中的公司名称。 |
company.id |
B2B 订单中的公司 ID。 |
company_location |
B2B 订单中的公司地点。向您下单的公司可以拥有多个地点。 |
company_location.name |
B2B 订单中公司地点的名称。 |
company_location.id |
B2B 订单中公司地点的 ID 号。 |
company_location.shipping_address |
B2B 订单中公司地点的收货地址。 |
company_location.billing_address |
B2B 订单中公司地点的账单地址。 |
付款时间表属性
属性 | 描述 |
---|---|
payment_schedule.amount_due |
付款时间表中的待付金额。 您可以使用 Liquid 资金筛选器对带有货币的金额进行格式化。 |
payment_schedule.due_at |
付款时间表的到期日期。 您可以使用 Liquid 日期筛选器对日期进行格式化。 |
payment_schedule.due_in_days |
距到期日期的天数(如果付款时间表仍未到期,即未付款)。 |
payment_schedule.due_later? |
如果付款时间表中的款项尚未付款并且还未到其到期日期,则返回 true。 |
payment_schedule.number_of_days_overdue? |
付款时间表逾期后已超过到期日期的天数。 |
payment_schedule.overdue? |
如果付款时间表中的款项尚未付款并且已过到期日期,则返回 true。 |
付款状态属性
属性 | 描述 |
---|---|
has_pending_payment |
(布尔值)如果订单有付款待处理的交易,则返回 true。 详细了解付款待处理。 |
buyer_action_required |
(布尔值)如果订单有付款待处理的交易,并且需要客户操作来取消阻止付款,则返回 true。当此值返回 true 并且付款方式支持付款说明时, 详细了解 Liquid 交易对象。 |
订单项目属性
line_items
或 subtotal_line_items
列表中的每个 line
都具有以下属性。
属性 | 描述 |
---|---|
line.applied_discounts(POS and draft orders only) |
应用于此产品的折扣列表,每个折扣都有 title (标题)、code (代码)、amount (金额)、savings (节省金额)和 type (类型)属性。 |
line.bundle_components(Draft orders only) |
属于此商品套装的订单项目列表。如果此订单项目是套装产品,则仅返回列表。 |
line.bundle_parent?(Draft orders only) |
(布尔值)如果订单项目是套装产品,则返回 true。 |
line.custom(Draft orders only) |
(布尔值)如果产品是草稿订单的自定义订单项目,则返回 true。 |
line.delivery_agreement |
与此商品条目关联的配送协议。 |
line.grams |
单件产品的重量。 |
line.image |
返回与此订单项目关联的图片的 URL。您还可以使用 img_url 筛选器筛选出特定的图片尺寸,例如 {{ line.image | img_url: 'small' }}
|
line.line_price |
价格乘以该产品的数量。 |
line.original_line_price |
在应用折扣之前,订单中包含的商品数量的总计价格。 |
line.final_line_price |
订单项目中所有商品的总计价格,包括所有订单项目级别的折扣金额。 |
line.price |
单个产品的价格。 |
line.product.metafields |
产品级别的元字段。使用以下语法: line.product.metafields.NAMESPACE.KEY |
line.product.title |
产品的当前名称。 |
line.product.vendor |
商品的厂商。 |
line.properties |
返回商品的一组自定义信息。在将产品添加到购物车之前,客户在产品页面上指定了订单项目属性。 |
line.quantity |
产品数量。 |
line.current_quantity |
删除后的商品当前数量。 |
line.requires_shipping |
(布尔值)如果针对产品多属性在产品页面上选中了需要运输复选框,则返回 true。 |
line.selling_plan_allocation |
返回一个 selling_plan_allocation 对象,该对象描述销售计划(例如订阅)对订单项目的影响。 |
line.taxable |
(布尔值)如果针对产品多属性在产品页面上选中了“需要收税”复选框,则返回 true。 |
line.title |
用短划线连接促销时的产品名称和促销时的多属性名称,即产品名称 - 多属性名称。为“默认标题”时,多属性名称则不包含在内。 在面向客户的通知中,当语言与默认商店语言不同时,产品名称和多属性名称会翻译为客户查看的语言。 |
line.url |
订单项目多属性的相对 URL。相对 URL 不包含您商店的根 URL(mystore.myshopify.com )。 |
line.variant.barcode |
与产品多属性相关联的条码。 |
line.variant.compare_at_price |
与产品多属性相关的原价。 |
line.variant.image |
产品多属性的图片。如果为订单项目中的多属性分配了特定图片,则仅返回图片。 |
line.variant.metafields |
多属性级别的元字段。使用以下语法: line.variant.metafields.NAMESPACE.KEY |
line.variant.sku |
与产品多属性相关的 SKU。 |
line.variant.title |
多属性选项值的当前名称,由字符 示例:小/红色 |
line.refunded.quantity(within refund notifications) |
要退款商品的数量。您可以使用此属性为订单中的退款商品添加识别码。 例如: |
退款属性
属性 | 描述 |
---|---|
amount |
退款金额。 |
refund_line_items |
要退款的退款订单项目的列表。 |
Refund_line_item 属性
refund_line_items
列表中的每个 refund_line
都具有以下属性:
属性 | 描述 |
---|---|
refund_line.line_item |
要退款的 line_item。这可以访问所有 line_item 的属性。 |
refund_line.quantity |
要退款的订单项目数量。 |
发货属性
属性 | 描述 |
---|---|
service_name |
设置 > 发货页面中定义的自定义服务名称。(仅请求发货) |
fulfillment.estimated_delivery_at |
根据以下承运商之一提供的跟踪编号(如果可用)获得的预计配送日期:USPS、FedEx、UPS、加拿大邮政(仅限加拿大)。此属性仅在使用承运商计算的运费时可用。 |
fulfillment.fulfillment_line_items |
要发货的发货订单项目的列表。 |
fulfillment.item_count |
所有产品的数量总和。要发货的产品总数。 |
fulfillment.requires_shipping |
(布尔值)如果此发货请求需要发货,则返回 true。 |
fulfillment.tracking_company |
负责跟踪的公司。 |
fulfillment.tracking_numbers |
运单号列表。 |
fulfillment.tracking_urls |
跟踪 URL 的列表。 |
items_to_fulfill(deprecated) |
要通过特定的自定义发货服务发货的订单项目列表。(仅请求发货) |
items_to_fulfill_count(deprecated) |
此请求要发货的产品总数。(仅请求发货) |
Fulfillment_line_item 属性
fulfillment_line_items
列表中的每个 fulfillment_line
都具有以下属性。
属性 | 描述 |
---|---|
fulfillment_line.line_item |
要发货的订单项目。这可以访问所有订单项目的属性。 |
fulfillment_line.quantity |
要发货的订单项目的数量。 |
待取货包裹属性
待取货包裹包括标记为可以取货的商品。
属性 | 描述 |
---|---|
item_count |
待取货包裹中所有商品数量的总和。 |
prepared_package_line_items |
待取货包裹商品条目列表。 |
Prepared_package_line_item 属性
prepared_package_line_items
列表中的每个 prepared_package_line_item
都具有以下属性。
属性 | 描述 |
---|---|
line_item |
关联的 line_item。这可以访问所有 line_item 的属性。 |
quantity |
已标记为可以取货的商品条目的数量。 |
配送属性
属性 | 描述 |
---|---|
delivery_agreements |
订单的所有配送协议的列表。 |
delivery_instructions |
要与客户共享的本地配送信息。此信息由本地配送设置中的配送信息字段控制。 |
consolidated_estimated_delivery_time |
要与客户分享的订单配送日期信息。此信息取决于您在发货和配送页面中设置的处理时间设置。当订单有多个配送方式时,则会显示配送方式和日期列表。 |
has_multiple_delivery_methods |
(布尔值)如果订单有多个配送方式,则返回 true。 |
配送协议属性
属性 | 描述 |
---|---|
delivery_agreement.delivery_method_type |
配送方式类型。 |
delivery_agreement.delivery_method_name |
当客户的结账语言与默认商店语言不同时,配送方式类型将被翻译为客户的结账语言。 |
delivery_agreement.line_items |
与此配送协议关联的所有商品条目的列表。 |
折扣属性
有两种类型的折扣属性。
discount_applications
描述提供商品折扣的原因和方式。
discount_allocations
描述特定折扣对订单项目的影响及其降低价格的方式。您应在订单项目级别使用此属性。
您可以合并这些属性以在订单项目或订单级别显示折扣信息。
示例
此示例检查是否已将折扣应用于订单项目。如果未在订单级别 (all
) 应用折扣,则会显示折扣名称和金额。
结果可能如下所示:
Discount_allocation 属性
discount_allocations
列表中的每个 discount_allocation
都具有以下属性。
属性 | 描述 |
---|---|
discount_allocation.amount |
客户在某个订单项目上节省的金额。如果要允许多个折扣码,则必须在循环中输入。 |
discount_allocation.discount_application |
分配订单项目金额的折扣申请。 |
Discount_application 属性
discount_applications
列表中的每个 discount_application
都具有以下属性。
属性 | 描述 |
---|---|
discount_application.target_selection |
描述如何选择购物车中的订单项目以应用折扣。可能的属性值包括:
|
discount_application.target_type |
折扣适用的商品类型(line_item 或 shipping_line )。 |
discount_application.title |
面向客户的折扣名称。 示例:Welcome10 或 CBBWQQAKYBYY |
discount_application.total_allocated_amount |
折扣所节省的订单价格的总金额。 |
discount_application.type |
折扣类型。可能的属性值包括:自动 、discount_code 、手动 或脚本 。 |
discount_application.value |
折扣的值。 |
discount_application.value_type |
折扣值的类型。可能的属性值包括:fixed_amount 或百分比 。 |
订阅属性
可在所有订阅电子邮件模板中使用的订阅合同详细信息、当前账单周期及其订单项目、配送方式和付款方式。
若要编辑订阅通知模板,请安装 Shopify Subscriptions 应用,然后在订阅部分下的设置 > 通知下找到该模板。
订阅合同账单周期属性
若要访问订阅合同的属性及其账单周期,请使用 subscription_contract_billing_cycle
对象。
示例
结果:
属性
属性 | 描述 |
---|---|
status |
合同的状态。 可能为 有效 、已暂停 、已取消 、失败 、已过期 、失效 中的一项。
|
delivery_method |
订阅的配送方式。 如果订阅用于服务或数字产品,则返回 零。 |
billing_frequency |
订阅的计费频率 |
delivery_frequency |
订阅的配送频率。 |
origin_order |
首次创建订阅的原始订单。 如果未通过 Shopify 订单创建订阅,则返回 nil 。
|
customer |
订阅客户。 |
line_items |
订阅账单周期中的订单项目。 |
product_names |
订阅账单周期中包含的产品的名称列表。 |
update_payment_method_url |
客户可用于更新此合同的付款方式的 URL。 |
shipping_address |
订阅的收货地址。 如果订阅用于服务或数字产品,则返回 nil 。
|
billing_address |
订阅的账单地址。 |
subtotal_price |
订阅订单项目的小计价格。 |
shipping_price |
订阅的运费价格。 |
total_tax |
订阅的总税费。 |
total_price |
订阅的总价。 |
total_discounts |
订阅的总折扣。 |
customer_self_serve_url |
客户可用于管理其订阅的自助 URL。 |
billing_attempt_expected_date |
此账单周期的账单日期。 |
next_billing_date |
此账单周期后的下一个未跳过的账单日期。 |
last_attempted_billing_date |
账单周期的最后一个已尝试扣费的账单日期。 |
days_overdue |
此账单周期的账单逾期天数。 |
payment_instrument |
与订阅合同关联的支付工具。客户使用此支付工具付款。 |
订阅合同订单项目属性
账单周期中包含的每个订单项目的属性。通过父 subscription_contract_billing_cycle.line_items
属性访问合同订单项目属性。
示例
属性 | 描述 |
---|---|
url |
订单项目产品多属性的产品详细信息页面的 URL。 |
requires_shipping |
订单项目是否需要实际发货。 |
unit_price_measurement |
订单项目单价计量。 |
selling_plan_allocation |
订单项目销售计划分配。 |
订阅合同配送方式属性
此账单周期中使用的配送方式的属性。通过父 subscription_contract_billing_cycle.delivery_method
属性访问配送方式属性。
示例
属性 | 描述 |
---|---|
title |
与配送方式关联的发货选项的标题。 |
type |
配送方式类型。 可能为 发货 、本地配送 或取货 中的一项。
|
订阅合同支付工具属性
订阅合同的支付工具的相关详细信息。客户使用此支付工具付款。通过父 subscription_contract_billing_cycle.payment_instrument
属性访问支付工具属性。
示例
属性 | 描述 |
---|---|
payment_type |
用支付工具表示的付款方式的类型。 使用付款筛选条件来输出图片 URL 或 SVG。 |
credit_card_brand |
信用卡的品牌。 |
credit_card_company |
信用卡公司的名称。 |
credit_card_last_four_digits |
信用卡的后 4 位数字。 |
电子邮件通知属性
属性 | 描述 |
---|---|
shop.email_logo_url |
在后台的自定义电子邮件模板部分中指定的 logo 的 URL。 |
shop.email_logo_width |
在后台的自定义电子邮件模板部分中指定的 logo 宽度(像素)。 |
shop.email_accent_color |
在后台的自定义电子邮件模板部分中指定的主题色的十六进制代码。 |