Customer Product Inventory

Note: Spartacus 4.x is no longer maintained. Please upgrade to the latest version.

Note: Spartacus 4.x was tested with SAP Commerce Cloud versions 1905 to 2205. Spartacus 4.x has not been verified to work with (and is not guaranteed to work with) SAP Commerce Cloud 2211 or later releases.

Note: This feature is introduced with version 1.1 of the TUA Spartacus libraries.

Customers use the Customer Product Inventory (CPI) feature to view their existing subscriptions and subscribed products information. Customers can manage their subscriptions with proper authorization. Entries in the Customer Product Inventory are created and updated from backend systems once the product offerings have been provisioned.

Table of Contents

Business Use Cases

Viewing Subscriptions

From the Account drop-down menu, click Subscriptions. All subscriptions and respective subscribed products are displayed along with the contract start and end dates and status. Depending on user authorization, additional information about each subscribed product can be viewed and managed.

Usage Consumption

If enabled, consumption information for each subscribed product can be viewed in either grid format, pie chart format or both.

Frontend and Backend Dependencies

Dependency Detail
Recipe b2c_telco_spa
Minimum version of backend TUA TUA Release 2003 (latest patch is required)
Minimum version of core commerce backend SAP Commerce Cloud release 1905 (latest patch is recommended)

Supported Backend Functionality

The Customer Product Inventory contains all subscription information for a given cugstomer, the mapping between subscriptions and users, as well as the mapping of the customer and billing account. For more information, see Customer Product Inventory and TUA Product Catalog in the TUA Help Portal.

Components

The following components must be enabled in the TUA backoffice to appear on the Spartacus TUA storefront:

Component Name Status Description
SubscriptionBaseListComponent New Displays all subscription bases Ids of the user
TmfProductComponent New Displays subscribed product details like subscribed product id, start date, end date, status and action
UsageConsumptionGridComponent New Displays usage consumption for subscriptionBase Ids in a grid format
UsageConsumptionPieChartComponent New Displays usage consumption for subscriptionBase Ids in a Pie chart format with usage in percentage is also displayed.
UsageConsumptionHeaderComponent New Displays usage consumption heading and navigation button to navigate to the subscription list page from subscription details page
CartItemOneTimeChargeComponent New Displays one time charges for the cart entry
CartItemRecurringChargeComponent New Displays recurring charges for the cart entry
CartItemUsageChargeComponent New Displays usage charges for the cart entry

TM Forum APIs

Entity Exposed for CPI TUA API Description
TmaSubscriptionBase GET /subscriptionBase Shows a list of of subscription base in the Subscription Details screen
TmaSubscribedProduct GET/product/{productId} Shows a list of subscription products in the Subscription Details screen
TmaSubscriptionAccess GET /subscriptionbase/{subscriptionBaseId} Shows details of subscription base
TmaSubscriptionUsage GET/usageConsumptionReport Shows the usage consumption for a subscriptionBase Id

For more information, see TM Forum APIs.

Further Reading