sfcc-cip-analytics-client
Version:
SFCC Commerce Intelligence Platform Analytics Client
49 lines (48 loc) • 1.76 kB
TypeScript
import { SiteSpecificQueryTemplateParams, QueryTemplateParams, EnhancedQueryFunction } from '../helpers';
export interface SalesSummaryRecord {
submit_date: Date | string;
site_id: number;
business_channel_id: number;
registered: boolean;
first_time_buyer: boolean;
device_class_code: string;
locale_code: string;
std_revenue: number;
num_orders: number;
num_units: number;
std_tax: number;
std_shipping: number;
std_total_discount: number;
}
export interface SalesMetrics {
date: Date | string;
std_revenue: number;
orders: number;
std_aov: number;
units: number;
aos: number;
std_tax: number;
std_shipping: number;
}
/**
* Query sales analytics data to track daily performance with automatic AOV/AOS calculations
* Business Question: How is my business performing across revenue and orders?
* Primary users: Merchandising teams
* @param client The Avatica client instance (must have an open connection)
* @param params Query parameters including siteId and dateRange
* @param batchSize Size of each batch to yield (default: 100)
*/
export declare const querySalesAnalytics: EnhancedQueryFunction<SalesMetrics, SiteSpecificQueryTemplateParams>;
interface SalesSummaryQueryParams extends QueryTemplateParams {
siteId?: string;
deviceClassCode?: string;
registered?: boolean;
}
/**
* Query raw sales summary data for custom aggregations
* @param client The Avatica client instance (must have an open connection)
* @param params Query parameters including optional filters
* @param batchSize Size of each batch to yield (default: 100)
*/
export declare const querySalesSummary: EnhancedQueryFunction<SalesSummaryRecord, SalesSummaryQueryParams>;
export {};