About the API:
This API will recommend e-commerce categories based on a search text string. This is a good fit for cross-seeling, where you can recommend other products and categories to a user based on their search.
This API will receive a text string and it will deliver all possible categories that could match that search.
Cross-Selling:
Cross-selling is the process of offering customers products that are compatible with the ones they're purchasing.
Besides API call limitations per month, there are no other limitations.
{"keywords":["coffee","maker"],"categories":["Coffee Maker Water Filters","Coffee Maker & Espresso Machine Accessories","Coffee","Pasta Maker Accessories","Popcorn Maker Accessories","Yogurt Maker Accessories","Pasta Maker Attachments","Coffee Cakes","Coffee Cups","Coffee Filters"],"keywords_scored":{"coffee":1,"maker":1},"categories_scored":{"Coffee Maker Water Filters":0.06249552,"Coffee Maker & Espresso Machine Accessories":0.04945657066666667,"Coffee":0.04701960266666667,"Pasta Maker Accessories":0.03924382666666667,"Popcorn Maker Accessories":0.03924382666666667,"Yogurt Maker Accessories":0.03924382666666667,"Pasta Maker Attachments":0.03924382666666667,"Coffee Cakes":0.038602158,"Coffee Cups":0.038602158,"Coffee Filters":0.038602158},"taxonomy_set":"product_categories","version":"7.5.7","author":"twinword inc.","email":"[email protected]","result_code":"200","result_msg":"Success"}
curl --location --request GET 'https://pr213-testing.zylalabs.com/api/837/e-commerce+category+recommendation+api/607/get+recommendations?text=coffee maker' --header 'Authorization: Bearer YOUR_API_KEY'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the E-Commerce Category Recommendation API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
Trusted by leading companies
The Get Recommendations endpoint returns a JSON object containing recommended categories based on the input text string. It includes keywords, a list of related categories, and scored values indicating the relevance of each category.
The key fields in the response include "keywords" (input terms), "categories" (recommended categories), "keywords_scored" (relevance scores for each keyword), and "categories_scored" (relevance scores for each category).
The response data is structured as a JSON object. It contains arrays for keywords and categories, along with nested objects for scored values, making it easy to parse and utilize in applications.
The endpoint provides information on related e-commerce categories based on user input, including potential cross-selling opportunities and relevant product categories.
Users can customize their requests by varying the input text string to receive different category recommendations. The API analyzes the provided string to generate tailored results.
Typical use cases include enhancing e-commerce platforms with cross-selling features, improving product discovery, and personalizing user experiences based on search queries.
Data accuracy is maintained through continuous updates and quality checks performed by the API provider, ensuring that the recommended categories remain relevant and up-to-date.
If the API returns partial or empty results, users should consider refining their input text for better matches or implementing fallback logic to suggest popular categories as alternatives.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund