Product Parts Finder API

Product Parts Finder API

1. Amasty\Finder\Api\DropdownRepositoryInterface - class for managing parts finder dropdowns:
  1. POST /V1/amasty_finder/dropdown, method="save" - create a dropdown;
  2. PUT /V1/amasty_finder/dropdown/:id, method="save" - edit a dropdown;
  3. DELETE /V1/amasty_finder/dropdown/:id, method="deleteById" - delete a dropdown;
  4. GET /V1/amasty_finder/dropdown, method="getById" - get a dropdown;
  5. GET /V1/amasty_finder/dropdown/all, method="getList" - get a list of all dropdowns.

2. Amasty\Finder\Api\FinderRepositoryInterface - class for managing product part finder:
  1. POST /V1/amasty_finder/finder, method="save" - create a finder;
  2. PUT /V1/amasty_finder/finder/:id, method="save" - edit a finder;
  3. DELETE /V1/amasty_finder/finder/:id, method="deleteById" - delete a finder;
  4. GET /V1/amasty_finder/finder, method="getById" - get a finder;
  5. GET /V1/amasty_finder/finder/all, method="getList" - get a list of all finders. 

3. Amasty\Finder\Api\ImportLogRepositoryInterface - class for managing import logs:
  1. DELETE /V1/amasty_finder/importLog/:id, method="deleteById" - delete an import log;
  2. GET /V1/amasty_finder/importLog, method="getById"  - get an import log;
  3. GET /V1/amasty_finder/importLog/all, method="getList" - get all import logs.

4. Amasty\Finder\Api\ImportErrorsRepositoryInterface - class responsible for import log errors:
  1. DELETE /V1/amasty_finder/importLogErrors/:id, method="deleteById" - delete an import error log;
  2. GET /V1/amasty_finder/importLogErrors, method="getById" -get an import error log;
  3. GET /V1/amasty_finder/importLogErrors/all, method="getList" - get all import error logs. 

5. Amasty\Finder\Api\ImportHistoryRepositoryInterface - class for managing import log history:
  1. DELETE /V1/amasty_finder/importLogHistory/:id, method="deleteById" - delete a history log;
  2. GET /V1/amasty_finder/importLogHistory, method="getById" - get a history log;
  3. GET /V1/amasty_finder/importLogHistory/all, method="getList" - get all history logs.

6. Amasty\Finder\Api\UniversalRepositoryInterface - class for managing universal products:
  1. POST /V1/amasty_finder/universal, method="save" - create a universal product;
  2. PUT /V1/amasty_finder/universal/:id, method="save" - edit a universal product;
  3. DELETE /V1/amasty_finder/universal/:id, method="deleteById" - delete a universal product;
  4. GET /V1/amasty_finder/universal, method="getById" - get information about a universal product;
  5. GET /V1/amasty_finder/universal/all, method="getList" - get a list with universal products.

7. Amasty\Finder\Api\ValueRepositoryInterface - class for managing finder values:
  1. POST /V1/amasty_finder/value, method="save" - save a value;
  2. PUT /V1/amasty_finder/value/:id, method="save" - edit a value;
  3. POST /V1/amasty_finder/saveProduct, method="saveOption" - save an option with one SKU;
  4. DELETE /V1/amasty_finder/value/:id/:finder, method="deleteById" - delete an option (delete a mapping);
  5. DELETE /V1/amasty_finder/value/:id, method="deleteOnlyValue" - delete a value;
  6. GET /V1/amasty_finder/value, method="getById" - get one value;
  7. GET /V1/amasty_finder/value/all, method="getList" - get a list with all values.

8. Amasty\Finder\Api\MapRepositoryInterface - class for managing mappings:
  1. POST /V1/amasty_finder/map, method="save" - save a mapping;
  2. PUT /V1/amasty_finder/map/:id, method="save" - edit a mapping;
  3. POST /V1/amasty_finder/map/saveMap, method="saveMap" - create a mapping using only value ID and SKU;
  4. PUT /V1/amasty_finder/map/saveMap:id, method="saveMap" - edit a mapping using only value ID and SKU;
  5. DELETE /V1/amasty_finder/map/:id, method="deleteById" - delete a mapping;
  6. GET /V1/amasty_finder/map, method="getById" - get information about a mapping;
  7. GET /V1/amasty_finder/map/all, method="getList" - get a list with all mappings.

9. Amasty\Finder\Api\ProductRepositoryInterface:
  1. POST /V1/amasty_finder/product/find, method="getProductsByFinderValues" - get products that match the chosen finder options. 

      • Related Articles

      • Can the module keep the set selection of the parts finder (i.e. brand/model/year) when switching a category?

        Yes, Product Parts Finder provides the opportunity to apply certain filtering parameters that will not be reset when a customer browses different categories. To enable this functionality, navigate to Stores → Configuration → Amasty Extensions → ...

      • How to define which finder shows the product results on a .phtml page?

        If there are several Product Parts Finder blocks on a .phtml page, you may differentiate the results by the Finder ID value. When the needed finder is used, the \Amasty\Finder\Controller\Index\Search::execute controller receives the request with the ...

      • 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 - ...

      • Product Attachments API

        API functionality for Product Attachments is available with the API for Product Attachments Add-On only. 1. Amasty\ProductAttachmentApi\Api\FrontendAttachmentInterface - class for getting product attachments on frontend: GET ...

      • Product Labels API

        Amasty\Label\Api\LabelRepositoryInterface - class for managing lables: GET /V1/amasty_labels/get/:id, method="getById" - get information about a label; DELETE /V1/amasty_labels/delete/:id, method="deleteById" - delete a label; POST ...