通知の変数リファレンス
ストアから送信される通知は、Liquid を使用してレンダリングされます。Liquid は、Shopify 独自のシンプルで使いやすいプログラミング言語です。これは、テーマストアのテーマが構築されているのと同じプログラミング言語です。
ストアから送信される通知を編集するには、通知テンプレートの基本的なカスタマイズを行うことができます。カスタマイズできる通知の完全なリストにアクセスするには、Shopify 管理画面で[通知] ページに移動します。
より高度な変更や、カスタム通知テンプレートの変更についてサポートが必要な場合は、フォーラムでコミュニティに問い合わせるか、Shopify パートナーにカスタマイズを依頼することができます。 Shopify パートナーへの依頼についての詳細はこちら。
このページの内容
注文プロパティ
注文の多くのプロパティは、Liquid を使用してテンプレート内で直接利用できます。
| プロパティ | 説明 |
|---|---|
id |
内部で使用される、システム全体で固有の注文 ID です。以下の例を使用して、ストアの管理画面セクションで注文へのリンクを生成します。たとえば、[新規注文] テンプレートに、次のコードを追加できます。 注文を表示する
|
email | 注文に関連付けられているメール。 |
name |
通常、これはシャープ記号で、その後に 例:#1004 |
order_name | name と同じです。 |
order_number |
シャープ記号 (#) のプレフィックスや、ショップオーナーがショップの設定で注文 ID に追加したプレフィックスやサフィックスが付かない、ストア固有の注文番号です。 例:1004 |
confirmation_number | 連番の注文名の代わりにお客様に表示される可能性のある、ランダムに生成された英数字の注文 ID です。この値は、一意であることが保証されていません。 例:XPAV284CT |
created_at |
お客様が注文を作成した日時です。date フィルターを使用してフォーマットできます。 例:2009-05-30T17:43:51+02:00 |
payment_terms |
決済条件では、注文の支払期日を指定します。 注文の請求書に決済条件を追加する方法をご覧ください。 詳細については、payment_terms の Liquid リファレンスを参照してください。 |
destination | アイテムが送られる配送先です。 |
tags | 注文のタグすべての配列を返します。タグはアルファベット順に返されます。アプリやプラットフォームの機能によって動的に適用されるタグ (Shopify Collective タグなど) は、通知メールが生成される時点では利用できない場合があります。特定の機能によるアイテムを検出するには、代わりに各項目の商品レベルのタグを確認してください。詳細については、Liquid のリファレンスドキュメントを参照してください。 |
transactions | 注文の 取引の配列を返します。 |
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 | お客様の出力の属性を含むお客様オブジェクトです。 |
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 | 現在の決済ステータスです。nil、pending、authorized、paid、voided、refunded のいずれかになります。 |
requires_shipping | (ブール値) 注文に発送が必要なアイテムが1つ以上含まれている場合に true を返します。 |
shipping_method.title | 配送料名です。 お客様向けの通知では、お客様がチェックアウト時に使用した言語がストアのデフォルト言語と異なる場合、配送料名はその言語に翻訳されます。 例:標準配送 |
shipping_method.price |
配送料ディスカウントを含む配送料金です。 例: |
shipping_price |
配送料金です。 例: |
shipping_address | 配送先住所です。 |
shipping_address.first_name | 配送先住所の名です。 |
shipping_address.company | 配送先住所の会社名です。 |
shipping_address.phone | 配送先住所の電話番号です。 |
line_items | 注文にあるすべての 項目のリストです。 |
line_items_including_zero_quantity | 注文にあるすべての 項目のリストです (数量がゼロのものも含まれます)。項目は、全額返金されると数量がゼロになります。 |
line_item_groups(Orders and POS only) | 注文にある項目コンポーネントを含む、すべての 項目グループのリストです。 |
item_count | すべてのアイテムの数量の合計です。 |
fulfillment_status | 注文の現在のフルフィルメント状況です。unfulfilled、partial、fulfilled のいずれかになります。 |
note | 注文に添付された備考です。この備考は、お客様から取得したり、管理画面の注文詳細画面で編集したりできます。 |
attributes |
注文に添付されたすべての 属性です。 例: |
metafields |
注文のメタフィールドです。次の構文を使用します。 metafields.NAMESPACE.KEY |
referring_site |
お客様をストアに誘導した参照元の URL が含まれます。 例: |
landing_site |
お客様が使用したランディングサイトのパスが含まれます。これは、お客様がストアにアクセスしたときに最初に表示されたページです。 例: |
landing_site_ref |
ランディングサイトを確認し、そこから参照パラメーターを抽出します。参照パラメーターには、 `landing_site` が `/products/great-product?ref=my-tracking-token` の場合、
{% if landing_site_ref == 'my-tracking-token' %}
My action...
{% endif %}
|
cancelled | (ブール値) 注文がキャンセルされている場合に true を返します。 |
cancelled_at | 注文がキャンセルされた時刻です。 |
cancel_reason | 注文をキャンセルする際に選択された理由です。inventory、customer、declined、fraud、other のいずれかになります。 |
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 の注文では、次の情報を含むヘッダーをテンプレートに追加できます。
{% if b2b? %}
<p> Customer: {{ customer.name }}
<p> Company: {{ company.name }}
<p> Location: {{ company_location.name }}
{% endif%}
|
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 | 下書き注文を最後に変更したスタッフのメールアドレス。 |
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 | パーセント形式の税率。たとえば、rate が 0.175 の場合、17.5 が返されます。 |
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 | 注文の合計金額 (小計 + 送料 - 配送ディスカウント + 税)。 |
amount_due_now | 下書き注文の請求書で要求される金額。 |
requires_shipping | を返します true (下書き注文に発送が必要なアイテムが1つ以上ある場合)。 を返します false (下書き注文に発送が必要なアイテムがない場合)。 |
shipping_method.title | 配送方法名。 例: 通常配送 |
shipping_method.price | 配送方法の価格。 と同じ情報を返します shipping_price。 |
shipping_price |
配送料金です。 Liquid のmoney フィルターを使用して、この金額のフォーマットを設定できます。 |
shipping_address |
配送先住所です。 注: 通常の注文とは異なり、下書き注文の配送先住所は不完全な場合があります。 |
shipping_address.first_name | 配送先住所の名です。 |
shipping_address.company | 配送先住所の会社名。 |
shipping_address.phone | 配送先住所の電話番号。 |
line_items | 下書き注文に含まれるすべての項目のリスト。 |
item_count | 下書き注文のすべてのアイテムの数量の合計。 |
note | 下書き注文に添付されたメモ。このメモは、お客様から取得できるほか、Shopify の管理画面の下書き注文の詳細画面で編集することもできます。 |
metafields |
下書き注文のメタフィールド。次の構文を使用します。 metafields.NAMESPACE.KEY |
location |
注文の物理的なロケーション。利用可能なロケーションプロパティがいくつかあります。 ロケーションは、Shopify の管理画面にある[ロケーション] ページで設定できます。 |
b2b? |
注文が B2B の注文である場合に true を返します。このプロパティを B2B の変数とともに使用すると、会社名、会社のロケーション、住所などの関連情報をメールに表示できます。たとえば、B2B の注文では、次の情報を含むヘッダーをテンプレートに追加できます。
{% if b2b? %}
<p> Customer: {{ customer.name }}
<p> Company: {{ company.name }}
<p> Location: {{ company_location.name }}
{% endif%}
|
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_methods | 下書きの合計金額を処理するために利用できる、保存済みの決済方法のリスト。 |
payment_method.payment_instrument | 保存済みの決済方法に関する詳細を含む決済手段。 |
payment_method.payment_instrument.payment_type | 保存された決済方法のタイプ。例:「credit_card、apple_pay」 |
payment_method.payment_instrument.credit_card_brand | `payment_type` が「credit_card」の場合のカードのブランド。 |
payment_method.payment_instrument.credit_card_company | `payment_type` が「credit_card」の場合のカード会社。 |
payment_method.payment_instrument.credit_card_company | `payment_type` が「credit_card」の場合のカードの下 4 桁。 |
決済スケジュールのプロパティ
| プロパティ | 説明 |
|---|---|
payment_schedule.amount_due |
決済スケジュールで支払う金額。 Liquid の money filter を使用して、通貨を含む金額をフォーマットできます。 |
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 の transaction オブジェクトについて詳しくはこちら |
バンドルコンポーネントのプロパティ
line_item.bundle_components のリストに含まれる各 bundle_component には、以下のプロパティがあります。(下書き注文のみ)
| プロパティ | 説明 |
|---|---|
bundle_component.image_url | バンドルコンポーネントの画像の URL。 |
bundle_component.product.title | バンドルコンポーネント商品のタイトル。 |
bundle_component.quantity | バンドルコンポーネントの数量。 |
bundle_component.variant.title |
例: small / red |
コンポーネントのプロパティ
line_item.components のリストに含まれる各 component には、以下のプロパティがあります。(カゴ落ちのみ)
`
| プロパティ | 説明 |
|---|---|
component.image_url | コンポーネントの画像の URL。 |
component.product.title | コンポーネント商品のタイトル。 |
component.quantity | コンポーネントの数量。 |
component.variant.title |
例: small / red |
項目のプロパティ
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.components(Abandoned checkout only) | このアイテムのコンポーネントである項目のリスト。 |
line.parent?(Abandoned checkout only) | (ブール値) 項目にコンポーネントがある場合に true を返します。 |
line.custom(Draft orders only) | (ブール値) 項目が下書き注文のカスタム項目である場合に true を返します。 |
line.delivery_agreement | この項目に関連付けられている配送契約。 |
line.grams | アイテム 1 個の重量。 |
line.groups | アイテムの項目グループ。 |
line.image | この項目に関連付けられている画像の URL を返します。img_url フィルターを使用して特定の画像サイズを取得することもできます (例: {{ line.image | img_url: 'small' }})。 |
line.line_price | そのアイテムの価格と数量を掛け合わせた金額。 |
line.original_line_price | ディスカウントが適用される前の、項目の合計価格。 |
line.final_line_price | すべての項目レベルのディスカウントを適用した後の、項目内の全アイテムの合計価格。 |
line.pre_tax_price | 項目の税抜価格と購入数量を掛け合わせた金額。 |
line.price | アイテム 1 個の価格。 |
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 | 販売時の商品名の後にダッシュと販売時のバリエーション名が続きます。バリエーション名が「Default 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 | バリエーションのオプション値の現在の名前を、 例: small / red |
line.refunded.quantity(within refund notifications) | 返金されるアイテムの数量です。このプロパティを使用すると、注文内の返金済みアイテムに ID を追加できます。 例: |
通知テンプレートで Shopify Collective のアイテムを検出する
Shopify Collective タグは、注文の確認メールが送信された後に注文に適用されるため、注文の確認テンプレートで {% if tags contains 'Shopify Collective' %} が true になることはありません。Shopify Collective のアイテムを検出するには、代わりに各項目の商品レベルのタグを確認してください:
{% assign has_collective_item = false %}
{% for line in line_items %}
{% if line.product.tags contains 'Shopify Collective' %}
{% assign has_collective_item = true %}
{% endif %}
{% endfor %}
{% if has_collective_item %}
<!-- Collective-specific content -->
{% endif %}項目グループのプロパティ
line_item_groups のリストに含まれる各 line_item_group には、以下のプロパティがあります。
| プロパティ | 説明 |
|---|---|
line_item_group.display_title | 項目グループのタイトルです。 |
line_item_group.components | グループに属する項目コンポーネントのリストです。 |
line_item_group.image | 項目グループの画像です。 |
line_item_group.product_id | 項目グループの商品 ID です。 |
line_item_group.variant | 項目グループのバリエーションオブジェクトです。 |
line_item_group.variant_id | 項目グループのバリエーション ID です。 |
返金のプロパティ
| プロパティ | 説明 |
|---|---|
amount | 返金された金額です。 |
refund_line_items | 返金される返金項目のリストです。 |
返金項目のプロパティ
refund_line_items のリストに含まれる各 refund_line には、以下のプロパティがあります。
| プロパティ | 説明 |
|---|---|
refund_line.line_item | 返金される line_item です。すべての項目のプロパティにアクセスできます。 |
refund_line.quantity | 返金される項目の数量です。 |
フルフィルメントのプロパティ
| プロパティ | 説明 |
|---|---|
service_name | 設定 > 配送と配達ページで定義されているカスタムサービスの名前。(フルフィルメントリクエストのみ) |
fulfillment.estimated_delivery_at | 以下のいずれかの配送業者によって提供される追跡番号 (利用可能な場合) に基づく推定配達日です。USPS、FedEx、UPS、Canada Post (カナダのみ)。このプロパティは、配送料自動計算が使用されている場合にのみ利用できます。 |
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_items のリストに含まれる各 fulfillment_line には、以下のプロパティがあります。
| プロパティ | 説明 |
|---|---|
fulfillment_line.line_item | フルフィルメントされる line_item です。すべての項目のプロパティにアクセスできます。 |
fulfillment_line.quantity | フルフィルメントされる項目の数量です。 |
準備済みのパッケージのプロパティ
準備済みのパッケージには、「受取準備完了」としてマークされたアイテムが含まれます。
| プロパティ | 説明 |
|---|---|
item_count | 準備済みのパッケージに含まれるすべてのアイテムの数量の合計です。 |
prepared_package_line_items | 準備済みのパッケージの項目のリストです。 |
準備済みのパッケージの項目のプロパティ
prepared_package_line_items のリストに含まれる各 prepared_package_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_item_groups | 配達契約に含まれる、バンドルされた項目コンポーネントを含むすべての項目グループのリストです。 |
delivery_agreement.line_items | この配達契約に関連付けられているすべての項目のリストです。 |
ディスカウントのプロパティ
ディスカウントのプロパティには 2種類あります。
discount_applications は、アイテムがディスカウントされた理由と方法を説明します。
discount_allocations は、特定のディスカウントが項目にどのように影響し、価格をどのように引き下げるかを説明します。このプロパティは、項目レベルで使用する必要があります。
これらのプロパティを組み合わせることで、項目レベルまたは注文レベルでディスカウント情報を表示できます。
例
この例では、ディスカウントが項目に適用されたかどうかを確認します。ディスカウントが注文レベル (all) で適用されていない場合は、ディスカウント名と金額が表示されます。
{% if line.discount_allocations %}
{% for discount_allocation in line.discount_allocations %}
{% if discount_allocation.discount_application.target_selection != 'all' %}
{{ discount_allocation.discount_application.title | upcase }}
(-{{ discount_allocation.amount | money }})
{% endif %}
{% endfor %}
{% endif %}結果は、次のようになります。
SPRING5 (-$5.00)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 | ディスカウントのタイプです。automatic、discount_code、manual、script のいずれかです。 |
discount_application.value | ディスカウントの値です。 |
discount_application.value_type | ディスカウントの値のタイプです。fixed_amount または percentage のいずれかです。 |
サブスクリプションのプロパティ
サブスクリプション契約、現在の請求サイクル、およびその項目、配達方法、決済方法の詳細は、すべてのサブスクリプションメールテンプレートで利用できます。
サブスクリプションの通知テンプレートを編集するには、Shopify Subscriptions アプリをインストールし、[設定] > [通知] の [サブスクリプション] セクションでテンプレートを見つけます。
サブスクリプション契約の請求サイクルのプロパティ
サブスクリプション契約とその請求サイクルのプロパティにアクセスするには、subscription_contract_billing_cycle オブジェクトを使用します。
例
{% assign contract = subscription_contract_billing_cycle %}
This contract is currently {{ contract.status }}.結果:
This contract is currently paused.プロパティ
| プロパティ | 説明 |
|---|---|
status |
契約のステータスです。active、paused、cancelled、failed、expired、stale のいずれかです。
|
delivery_method |
サブスクリプションの配達方法です。 サブスクリプションがサービスまたはデジタル商品の場合は、 nil が返されます。
|
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 プロパティからアクセスします。
例
{% for line_item in subscription_contract_billing_cycle.line_items %}
{{ line_item.url }}
{% endfor %}| プロパティ | 説明 |
|---|---|
url | 項目の商品バリエーションに関する商品詳細ページへの URL です。 |
requires_shipping | 項目で物理的な発送が必要かどうか。 |
unit_price_measurement | 項目の単位価格の測定です。 |
selling_plan_allocation | 項目の販売プランの割り当てです。 |
サブスクリプション契約の配達方法のプロパティ
この請求サイクルで使用されている配達方法のプロパティです。配達方法のプロパティには、親プロパティである subscription_contract_billing_cycle.delivery_method を介してアクセスします。
例
{% if subscription_contract_billing_cycle.delivery_method != blank %}
Delivery method: {{ subscription_contract_billing_cycle.delivery_method.title }}
{% endif %}| プロパティ | 説明 |
|---|---|
title | 配達方法に関連付けられている配送オプションのタイトルです。 |
type |
配達方法のタイプです。shipping、local、pick-up のいずれかです。
|
サブスクリプション契約の決済手段のプロパティ
サブスクリプション契約の決済手段に関する詳細です。この決済手段は、お客様への請求に使用されます。決済手段のプロパティには、親プロパティである subscription_contract_billing_cycle.payment_instrument を介してアクセスします。
例
{% assign instrument = subscription_contract_billing_cycle.payment_instrument %}
<img src="{{ instrument.payment_type | payment_type_img_url }} " alt="{{ instrument.credit_card_company }}" />
{{ instrument.credit_card_company }} ending with {{ instrument.credit_card_last_four_digits }}| プロパティ | 説明 |
|---|---|
payment_type |
決済手段で表される決済方法のタイプです。 画像の URL や SVG を出力するには、payment filtersを使用します。 |
credit_card_brand | クレジットカードのブランドです。 |
credit_card_company | クレジットカード会社の名前です。 |
credit_card_last_four_digits | クレジットカードの下4桁です。 |
メール通知のプロパティ
| プロパティ | 説明 |
|---|---|
shop.email_logo_url | 管理画面のメールテンプレートのカスタマイズセクションで指定されているロゴの URL です。 |
shop.email_logo_width | 管理画面のメールテンプレートのカスタマイズセクションで指定されているロゴの幅 (ピクセル単位) です。 |
shop.email_accent_color | 管理画面のメールテンプレートのカスタマイズセクションで指定されているアクセントカラーの HEX コードです。 |
ストアクレジットのプロパティ
ストアクレジットの発行に関する詳細が含まれるプロパティです。
| プロパティ | 説明 |
|---|---|
issued_store_credit.amount |
発行されたストアクレジットの金額です。 Liquid のmoney フィルターを使用して、この金額のフォーマットを設定できます。 |
issued_store_credit.expires_at |
発行されたストアクレジットの有効期限が切れる日時です。 Liquid の date filters を使用して、この日付をフォーマットできます。 |
issued_store_credit.balance_after_transaction |
クレジットが発行された後のストアクレジットアカウントの残高です。 Liquid のmoney フィルターを使用して、この金額のフォーマットを設定できます。 |
customer | お客様の出力の属性を含むお客様オブジェクトです。 |