API Quick Start
This guide aims to provide you with a comprehensive overview of how to effectively utilize the AfterShip Personalization API and walk you through some common scenarios to help enhance your eCommerce platform's shopping experience.
1. What is AfterShip Personalization API?
AfterShip Personalization API provides functionalities aimed at optimizing product discovery and guiding purchasing decisions.
Key features:
- Recommendation engine: Delivers personalized product recommendations based on individual customer preferences and browsing history.
- Search optimization: Simplifies the search process to help customers find desired products quickly.
- Tagging system: Organizes products by applying tags based on attributes such as product type, brand, or price range.
graph TD
Ecom(("Customer System"))
CommerceAPI["AfterShip Commerce API"]
PersonalizationAPI["AfterShip Personalization API"]
Ecom--"1. Stores, Products, Orders"-->CommerceAPI-->PersonalizationAPI--"2. Recommendations, Search, Tagging"-->Ecom
As different API endpoints require different resources, the table below shows an overview of the required resource of each API endpoints:
Endpoint | Stores | Products | Orders |
---|---|---|---|
POST /discoveries/recommend | ✔ | ✔ | ✔ |
POST /discoveries/suggest | ✔ | ✔ | |
POST /discoveries/search | ✔ | ✔ | |
POST /discoveries/tagging |
2. API Endpoint
All endpoints are only accessible via HTTPS and are located at:
preparing...
3. Common scenarios
Scenario: Recommended random products
Here’s a sample request to receive recommended random products:
Sample Request
preparing...
Sample Response
preparing...