運賃商品

運賃商品は、利用者が購入できる旅行契約です。

概要

D1 Transit内で定義されている主な運賃商品カテゴリーは3つあります：

1. チャージ式運賃商品
2. 回数制運賃商品
3. 時間制運賃商品

チャージ式運賃商品

チャージ式運賃商品は、利用者がトランジットカードに一定金額を事前にチャージし、それを使って交通ネットワークの乗車に利用できるようにするものです。

事業者は運賃キャッピングを提供する場合があり、指定された期間内に利用者が支払う金額が一定額を超えないようにして、コスト節約を提供します。

回数制運賃商品

回数制運賃商品は、利用者が事前に一定回数の乗車を購入できるようにするもので、特定期間内の無制限乗車（例：週次・月次製品）とは異なります。

これらの製品は利用可能な回数が有限で、利用者はその回数を使用できます。通常、回数制運賃商品は回数が使い果たされるまで利用できますが、有効期限がある場合があります。

時間制運賃商品

時間制運賃商品は通常、月間または週間単位で提供され、定められた期間内に無制限の乗車を許可します。

従来の利用ごとの乗車券とは異なり、時間制製品は一定の期間にわたって有効化されます：

• 購入の瞬間から
• 予定された将来の日付に
• または最初の利用時に

そしてその期間全体にわたって有効であり続けます。

データモデル

以下のセクションでは、D1 Transitソリューション内で運賃商品がどのように定義されているかを説明します。

考慮すべき2つの概念があります：

• 製品メタデータ：購入され、ユーザーカードアカウントにリンクされた製品に関連付けられたメタデータ。
• 購入可能な製品メタデータ：購入可能な製品、すなわち利用者が購入できる製品に関連付けられたメタデータ。

製品／購入可能製品の共通メタデータ

ProductId

運賃商品の一意の識別子

ProductType

前述のように、運賃商品の性質を定義します。チャージ式、回数制、または時間制のいずれかです。

ProductName

デジタルウォレット内に表示されるローカライズされた製品名。

Fare

Fareオブジェクトは以下で構成されます：

• fareId：トランジット事業者が公開するGTFSフィードの識別子
• fareClass：製品が特定の価格／カテゴリに紐づく場合に利用者が購入できるもの（例：ビジネス、ファースト、標準…）
• concession：学生、高齢者、正規運賃…

ValidityParameters

ValidityParametersオブジェクトは以下で構成されます：

• numberOfTrips：製品が利用できる乗車回数。通常は回数制製品で使用されます。
• timeLimits (start time / end time)：製品が有効な時間窓。通常は時間制製品で使用されますが、回数制製品にも適用できます。
• validityAfterTapIn：最初のタップイン後に製品が有効である期間。
• validityAfterTapOut：タップアウト後に製品が有効である期間。通常は乗り継ぎ目的で使用されます。
• zoneLimits：製品が有効な出発／到着ゾーン。
• stationLimits：製品が有効な出発／到着駅。
• topupLimits：チャージ式製品のチャージに適用される上限。

製品固有のメタデータ

PurchaseDetails

PurchaseDetailsオブジェクトは以下で構成されます：

• purchaseId：製品購入を追跡するための領収書番号／識別子。
• purchaseTime：元の製品の購入時刻。
• price：製品の価格。
• currencyCode：通貨コード。
• repurchaseUrl：同じ製品を再購入するためのリンク。
• refundUrl：その製品の返金用ウェブサイトへのリンク。

購入可能な製品固有のメタデータ

SalePeriod

SalePeriodオブジェクトは以下で構成されます：

• startDate：この製品を購入できる最も早い日時（包含）。
• endDate：この製品を購入できる最も遅い日時（排除）。

EligibleForTopup

製品をチャージできるかどうかを示すフラグ。