QUICKSTART
API Quick Start
Authentication
SignString
Versioning
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Scenarios
Recommendations
Best Sellers
Bought Together
Complements
New Arrival
Random
Similar
Search
Semantic Search
Visual Search
Browse
Tagging
Product tagging
Reference
API Overview
Discoveries
Recommend products
post
Suggest product query
post
Search products
post
Predict product category and tags
post
Model
Envelope
Meta
v1
Error
v1
Pagination
v1
Primitive
Partial Product
Predict Tag
Predict Category
Tagging Product
ENUM
Filter key
Support
Contact Support

Overview

This document focuses on the Best Sellers API within the recommendation module. The Best Sellers API dynamically generates and displays a list of the platform's top-selling products, based on sales data, to highlight popular items across various categories.

Use Case

A customer visits an online bookstore looking for popular reads but is unsure where to start. The Best Sellers API allows the platform to present a curated list of current best-selling books, providing the customer with immediate access to the most popular titles. This feature helps streamline the discovery process for users by directly pointing them to books that are trending, highly rated, and widely purchased, thus simplifying their search for quality reads.

Feature Comparison

Compare to other Personalization API features:

  • Similar Products
    Similar Products offers alternatives based on the attributes of a specific product, the Best Sellers focuses on overall sales performance to recommend products, regardless of the customer's current browsing context.
  • Random Products
    The Random Products introduces users to a variety of products without any sales performance consideration, whereas the Best Sellers specifically targets products that have achieved high sales volumes.
  • Complements and Bought Together
    These provide recommendations based on product compatibility or co-purchasing behavior, while the Best Sellers identifies products solely based on their popularity and sales data.

Example

In the sample request outlined below, we’ve initiated a request to the AfterShip Personalization API to fetch recommendations using the BEST_SELLERS type. The request includes the following parameters:

  • type: Specifies the type of recommendations, which in this case is set to BEST_SELLERS.

  • session_id: Represents the unique identifier for the user session.

  • limit: Determines the maximum number of products to be returned in the response. In this example, the limit is set to 5. Sample Request

preparing...

By providing these parameters in the request, the API will generate a curated list of the top-selling products based on sales data, allowing users to discover popular items that are likely to meet their needs and preferences.

Sample Response

preparing...