カートアイテム
概要
カートエントリーを表すオブジェクトです。カートアイテムは複数の購入アイテムを表す場合があります。CartItem.quantityは購入アイテムの数を提供します。
プロパティ
cartItemId
• cartItemId: string
カートアイテムのグローバルに一意な識別子(GUID)です。このIDはカタログアイテムの新鮮な印象の間で一意です。したがって、Rokt SDKが顧客にアイテムを表示するアップセルページへの後続の訪問では変更される可能性があります。通常の場合と同様に、カートアイテムが変更された場合、RoktはCart.onUpdateItem
をトリガーしますが、この特定の場合では、更新されたアイテムと古いアイテムは異なるCartItem.cartItemId
を持つ場合があります。カート内のアイテムをCart.onUpdateItem
コールバックで提供されるアイテムに関連付けるためにCartItem.cartItemId
の値を使用する場合は、この動作に注意してください。
catalogItemId
• catalogItemId: string
カタログアイテムの一意の識別子です。同じカタログアイテムが異なる顧客に表示され、CartItem.cartItemIdとは異なり、その値はカタログアイテムの新鮮な印象の間に変化しません。これは製品のSKUとも考えることができます。
currency
• currency: string
ISO 4217に準拠した通貨コードです。
description
• description: string
アイテムの説明です。
linkedProductId
(オプション)
• linkedProductId: string | undefined
パートナーの在庫にリンクされたRoktのカートアイテムのID(SKU)。存在する場合、カートアイテムがパートナーの製品に関連付けられており、Roktのアイテムはパートナーの製品とは別に販売することはできません。
例えば、顧客がパートナーのページで販売されている商品の保証を購入するためにRoktのサービスを利用する場合、CartItem.linkedProductIdはパートナーの商品のIDを表します。取引フローのどの段階でも、顧客がカートからパートナーの商品を削除することを選択した場合、Roktのカートアイテムも削除されるべきです。保証は対象の商品なしでは購入できません。
name
• name: string
アイテムの名前です。
quantityMustBeSynchronized
(オプション)
• quantityMustBeSynchronized: boolean | undefined
このフラグの存在は、カートアイテムのCartItem.quantityがCartItem.linkedProductIdで表されるパートナーの商品の数量と同期されていることを示します。
例えば、顧客がパートナーページで販売されている商品の保証をRoktから購入する場合、同じ商品の複数のアイテムが購入された場合、保証は顧客が選択した時点でカートに追加された商品の数と一致する数量のRoktカートアイテムで表されます。取引フローのどの段階で顧客がパートナーの商品をカートから削除することを選択した場合、Roktのカートアイテムも削除されるべきです。保証は、それがカバーする商品なしでは購入できません。
providerData
• providerData: string
製品またはサービスプロバイダーによって指定された任意の情報を含むJSON文字列です。
quantity
• quantity: number
要求されたアイテムの数量です。
totalPrice
• totalPrice: number
合計金額は、単価に数量を掛けたものです。
CartItem.quantityMustBeSynchronizedがtrueに設定されている場合、顧客がリンクされた製品の数量を変更すると、値が最終的な合計金額を表さない場合があります。
unitPrice
• unitPrice: number
アイテムごとの価格。