Predicted Top Sellers

A lot of times it is useful to know which products are predicted to sell the most so that nudges can be provided to shoppers. Typically this nudge indicates that a product is selling fast, is a best seller, or could be predicted to have limited supply because it is very popular. This API will return true if the configured rank threshold by volume exceeds the threshold configured for the API. This information can be used to display a UX notice on a product accordingly.

API Configuration

export enum TopSellerPredictionType{
 Volume="Volume",
 Revenue="Revenue"
}
export interface TopSellersAPIConfiguration extends APIConfiguration{
 predictionType: TopSellerPredictionType;
 // Rank above which to return true
 thresholdValue: number;
}

getTopSeller
export interface PTopSellerRequest extends DmAlgRequest {
 urls: string[];
}

export interface PTopSellerItem {
 url: string;
 topSeller: boolean;
}

export interface PTopSellerResponse extends DmResponse {
 items: PTopSellerItem[];
}