sfcc-cip-analytics-client
Version:
SFCC Commerce Intelligence Platform Analytics Client
40 lines (39 loc) • 1.65 kB
TypeScript
import { SiteSpecificQueryTemplateParams, EnhancedQueryFunction } from "../helpers";
export interface TopSellingProduct {
nproduct_id: string;
product_display_name: string;
units_sold: number;
std_revenue: number;
order_count: number;
device_class_code: string;
registered: boolean;
nsite_id: string;
}
export interface ProductCoPurchase {
product_1_id: string;
product_1_name: string;
product_2_id: string;
product_2_name: string;
co_purchase_count: number;
std_cobuy_revenue: number;
}
/**
* Query top selling products by performance dimensions
* Business Question: How do my products perform across different channels?
* Primary users: Buyers and Merchandising teams
* @param client The Avatica client instance (must have an open connection)
* @param siteId The natural site ID to filter by
* @param dateRange Date range to filter results
* @param batchSize Size of each batch to yield (default: 100)
*/
export declare const queryTopSellingProducts: EnhancedQueryFunction<TopSellingProduct, SiteSpecificQueryTemplateParams>;
/**
* Query product co-purchase analysis for cross-sell optimization
* Business Question: Which products are frequently bought together?
* Primary users: Merchandising and Product teams
* @param client The Avatica client instance (must have an open connection)
* @param siteId The natural site ID to filter by
* @param dateRange Date range to filter results
* @param batchSize Size of each batch to yield (default: 100)
*/
export declare const queryProductCoPurchaseAnalysis: EnhancedQueryFunction<ProductCoPurchase, SiteSpecificQueryTemplateParams>;