通知の変数リファレンス
ストアから送信された通知は、Liquidを使用してレンダリングされます。Liquidは、Shopifyの分かりやすくて使いやすいプログラミング言語です。テーマストアのテーマの構築に使用されるものと同じプログラミング言語です。
ストアから送信される通知を編集するために、通知テンプレートの基本カスタマイズを行うことができます。カスタマイズ可能な通知の完全なリストにアクセスするには、管理画面の [通知] ページに移動します。
さらに高度な修正を加える場合、またはカスタム通知テンプレートに修正を加える場合は、フォーラムのコミュニティに問い合わせてください。Shopifyパートナーを雇ってカスタマイズを行うこともできます。Shopifyパートナーを雇うことについて詳しくはこちらをご覧ください。
目次
注文プロパティ
多くの注文プロパティは、テンプレートや追加スクリプトで直接Liquidを使用できます。
プロパティ | 説明 |
---|---|
id |
社内で使用するシステム全体の固有の注文ID。以下の例を使用して、ストアの管理画面セクションで注文へのリンクを生成します。たとえば、新しい注文テンプレートでは、以下のコードを追加できます。 <a href="{{ shop.url }}/admin/orders/{{ id }}">注文を見る</a> |
注文に関連づけられたメール | |
name |
通常はハッシュ記号とそれに続く 例: #1004 |
order_name |
nameと同様 |
order_number |
注文に含まれるストアの個別番号。これにはハッシュ記号 (#) のプリフィックス、または、ストアの各種設定でストアオーナーが注文IDに追加したプリフィックスまたはサフィックスが含まれない。 例: 1004 |
confirmation_number |
ランダムに生成された注文の英数字ID。連続した注文名の代わりにお客様に表示される場合があります。この値が固有の値である保証はありません。 例: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 |
お客様出力の属性を含むお客様オブジェクト。 |
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 |
数量が0の項目を含む、注文のすべての項目のリスト。全額返金された項目の数量は0になります。 |
item_count |
すべてのアイテムの個数の合計 |
fulfillment_status |
注文の現在のフルフィルメント状況。unfulfilled 、partial 、fulfilled のいずれかが表示される。 |
note |
注文に添付するメモ。お客様から入手し、管理画面のインターフェイスの注文明細画面で編集可能 |
attributes |
注文に添付する任意の属性。 例: |
referring_site |
お客様をストアに誘導した参照元のURLを含む 例: |
landing_site |
お客様が使用したランディングサイトのパスを含む。これは、お客様がストアを訪問したときに最初に閲覧したページです。 例: |
landing_site_ref |
ランディングサイトを確認し、そこから参照パラメータを抽出する。参照パラメータは、「ref」
{% 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の注文では、以下の情報を含むヘッダーをテンプレートに追加できます。
|
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 |
お客様出力の属性を含むお客様オブジェクト。 |
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 |
配送が必要な下書き注文に、少なくとも1つのアイテムがある場合に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 |
下書き注文に添付するメモ。お客様から入手でき、管理画面の下書き注文明細画面で編集することも可能 |
location |
注文の実際のロケーション。複数のロケーションプロパティが利用可能。 管理画面のロケーションページでロケーションの設定が可能 |
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
リストの各line
またはsubtotal_line_items
には、以下のようなプロパティがあります。
プロパティ | 説明 |
---|---|
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 |
1つのアイテムの重量 |
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 |
販売時の商品名、その後にダッシュと販売時のバリエーション名。「デフォルトのタイトル」の場合、バリエーション名は含まれません。 お客様向けの通知では、商品名とバリエーション名は、お客様がチェックアウトした言語がデフォルトのストア言語と異なる場合、その言語に翻訳されます。 |
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) |
返金されるアイテムの数量。このプロパティを使用して、注文の返金されたアイテムにIDを追加できます。 例: |
返金のプロパティ
プロパティ | 説明 |
---|---|
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、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_itemプロパティ
fulfillment_line_items
リストの各fulfillment_line
には、以下のプロパティがあります。
プロパティ | 説明 |
---|---|
fulfillment_line.line_item |
発送済になっているline_item。すべての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プロパティ
ディスカウントのプロパティには2種類あります。
discount_applications
では、アイテムがディスカウントされた理由と方法を説明します。
discount_allocations
では、特定のディスカウントが項目にどのように影響し、どのように価格を減額するか説明します。このプロパティは項目レベルで使用してください。
これらのプロパティを組み合わせて、項目または注文レベルでディスカウント情報を表示できます。
例
この例では、項目にディスカウントが適用されているかどうかを確認します。注文レベル (all
) でディスカウントが適用されていない場合に、ディスカウント名と金額が表示されます。
結果は以下のようになります。
discount_allocationプロパティ
discount_allocations
リストの各discount_allocation
には、以下のプロパティがあります。
プロパティ | 説明 |
---|---|
discount_allocation.amount |
項目でお客様が削減できた金額。複数のクーポンコードの許可を希望する場合、ループで入力する必要があります。 |
discount_allocation.discount_application |
項目に金額を割り当てるディスカウントアプリケーション。 |
discount_allocationプロパティ
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
のオブジェクトを使用します。
例
結果:
プロパティ
プロパティ | 説明 |
---|---|
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
プロパティから契約項目のプロパティにアクセスします。
例
プロパティ | 説明 |
---|---|
url |
項目の商品バリエーションの商品詳細ページにアクセスできるURLのことです。 |
requires_shipping |
項目に物理的な配送が必要かどうかを示します。 |
unit_price_measurement |
項目の単価計量単位のことです。 |
selling_plan_allocation |
項目の販売計画割り当てのことです。 |
サブスクリプション契約の配達方法プロパティ
該当する請求サイクルで使用されている配達方法プロパティのことです。親のsubscription_contract_billing_cycle.delivery_method
プロパティから配達方法のプロパティにアクセスします。
例
プロパティ | 説明 |
---|---|
title |
配達方法に関連付けられている配送オプションタイトルのことです。 |
type |
配達方法のタイプのことです。shipping 、local 、pick-up のいずれかです。
|
サブスクリプション契約の決済手段プロパティ
サブスクリプション契約の決済手段に関する情報のことです。この決済手段はお客様に請求するために使用されます。親の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 |
管理画面のメールテンプレートを編集セクションで指定したロゴのURL |
shop.email_logo_width |
管理画面のメールテンプレートを編集セクションで指定したロゴの幅 (ピクセル) |
shop.email_accent_color |
管理画面のメールテンプレートを編集セクションで指定したアクセントの色の16進コード |