Automatic Related Products API
We have created a public API collection for Automatic Related Products module with all available queries and sample data that you can both test via our demo endpoints and copy to run local tests in your Magento environment. More details about using public collections can be found in the following FAQ post.
1. Amasty\Mostviewed\Api\GroupRepositoryInterface - class for managing related product rules.
- POST /V1/amasty_mostviewed/rules", method="save" - create a rule;
- PUT /V1/amasty_mostviewed/rules/:groupId, method="save" - edit a rule;
- DELETE /V1/amasty_mostviewed/rules/:groupId", method="deleteById" - delete a rule by its ID;
- GET /V1/amasty_mostviewed/rules/:groupId", method="getById" - get a rule by its ID;
- GET /V1/amasty_mostviewed/rules", method="getList" - get a list of rules.
2. Amasty\Mostviewed\Api\ProductGroupResolverInterface - class for managing rules for product pages.
- GET /V1/amasty_mostviewed/rules/product-group-by-id", method="getGroupByProductIdAndPosition" - get a group for product pages by product ID and position;
- GET /V1/amasty_mostviewed/rules/product-group-by-sku", method="getGroupByProductSkuAndPosition" - get a group for product pages by product and position
3. Amasty\Mostviewed\Api\CategoryGroupResolverInterface - class for managing rules for category pages.
- GET /V1/amasty_mostviewed/rules/category-group", method="getGroupByCategoryIdAndPosition - get a group for category pages by category ID and position.
4. Amasty\Mostviewed\Api\CartGroupResolverInterface - class for managing rules for shopping cart pages.
- GET /V1/amasty_mostviewed/rules/guest-cart-group/:maskedCartId", method="getGroupByMaskedQuoteIdAndPosition" - get a group for shopping cart pages by positiob for not logged-in customers;
- GET /V1/amasty_mostviewed/rules/cart-group", method="getGroupByQuoteIdAndPosition" - get a group for shopping cart pages.
5. Amasty\Mostviewed\Api\CustomGroupResolverInterface - class for managing rules with custom positions (for example, CMS pages).
- GET /V1/amasty_mostviewed/rules/custom-group", method="getGroup"- get a group with custom position by its ID;
- GET /V1/amasty_mostviewed/rules/custom-group-for-product", method="getGroupForProduct" - get a group with custom position by product ID;
- GET /V1/amasty_mostviewed/rules/custom-group-for-guest-cart/:maskedCartId", method="getGroupForGuestCart" - get a group with custom position for not logged-in user shopping cart page;
- GET /V1/amasty_mostviewed/rules/custom-group-for-customer-cart", method="getGroupForCart" - get a group with custom position for users on shopping cart page.
Related Articles
What Amasty extensions support API?
Each Amasty extension that has API support, includes the etc/webapi.xml file. The webapi.xml file contains API configurations with the list of available API requests. For example, a request from the Custom Form module interface: 1 - endpoint URL; 2 - ...Can I test how your modules work with API?
Our team have created a public Postman workspace where we provide access to API collections from our modules. You can copy these API collections to test them in your own Magento installation together with our modules, and some collections can be ...Automatic Related Products | GraphQL methods
Queries amMostviewedGroups -(uid: String!, position: String) description: get information about related product rules amMostviewedBundlePacks (uid: String) description: get information about bundle packsHow can I display related products block on blog pages?
Automatic Related Products extension can be integrated with the Amasty Blog Pro module. In order to set the related products block on the blog page, follow the steps below. Step 1. Navigate to Amasty → Automatic Related Products → Related Product ...The Automatic Related Products module does not return any related products on the product/category pages or in cart. How to fix that?
There are several reasons why the related block might be missing from the front-end. To make sure the issue is not related to the rule settings, follow the instructions below, Step 1: Make sure your products have Stock Status = In Stock, since ...
Announcements
⚡ Have you enlarged the functionality of the Amasty extension with your own code? Share your improvements with us!
At Amasty, we understand that some of our clients require customized features to perfectly align the extension with their business needs. If you have developed new functionality within an Amasty module and would like to share it, please submit a ticket