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 - HTTP method;
3 - module interface class that handles the request;
4 - module method that is used to execute the request.
Usually, there are 4 basic methods in the API from HTTP:
GET - getting an object\an array of objects (without changing it);
POST - creation of a new object;
PUT - changing an already created object;
DELETE - deleting an object.
If you have access to the extension, you may check the available API requests in the /Module_Name/etc/webapi.xml file. In case the file does not exist, the corresponding module does not have API interfaces now.
Below, you may find the table with the info about API interfaces present in our extensions.
✓ - the extension supports the method;
〜 - the main extension doesn't support the method, but its submodule does;
○ - the extension supports the method and works both separately and with other extensions from the mentioned list;
— - the extension doesn't support the method.
Extension/Method | GET | POST | PUT | DELETE |
Improved Layered Navigation (via Shop By Base and Shop by Page submodules) | 〜 | 〜 | 〜 | 〜 |
Shop by Brand (via Shop by Page submodule) | 〜 | 〜 | 〜 | 〜 |
— | ✓ | — | — | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | — | ✓ | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |
Product Attachments (via API add-on) | 〜 | 〜 | 〜 | 〜 |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |
— | ✓ | — | — | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | — | |
— | ✓ | ✓ | — | |
✓ | ✓ | ✓ | ✓ | |
— | ✓ | — | — | |
— | ✓ | — | — | |
— | ✓ | — | — | |
Advanced Conditions (+ Reward Points, Extra Fee, Free Gift, Shipping Rules, Shipping Restrictions) | — | ○ | — | — |
— | ✓ | — | — | |
— | ✓ | — | — | |
— | ✓ | — | — | |
✓ | ✓ | — | — | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |
Promo Banners Lite (+Free Gift, Special Promotions, Special Promotions Pro, Loyalty Program) | — | ○ | — | — |
✓ | — | — | — | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | — | — | |
✓ | ✓ | — | — | |
✓ | ✓ | ✓ | ✓ | |
Customer Attributes (via Customer Login Attributes Submodule) | — | 〜 | — | — |
✓ | — | — | — | |
— | ✓ | — | — | |
✓ | ✓ | — | — | |
Import Export (via Import Export Core submodule) | 〜 | 〜 | — | — |
✓ | — | — | — | |
✓ | ✓ | ✓ | — | |
✓ | ✓ | — | — | |
RMA (Pro & Premium) | ✓ | ✓ | ✓ | ✓ |
— | ✓ | — | — | |
— | ✓ | — | — | |
✓ | ✓ | — | — | |
| ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ |
Related Articles
Store Pickup API
1. Amasty\StorePickup\Api\GuestShippingMethodManagementInterface - class for managing shipping methods on guest checkout: POST /V1/guest-carts/:cartId/estimate-shipping-methods, method="estimateByExtendedAddress" - displays available shipping methods ...Reward Points API
1. Amasty\Rewards\Api\CheckoutRewardsManagementInterface - class responsible for applying reward points on checkout: PUT /V1/carts/mine/points/:points, method="set" - apply points; DELETE /V1/carts/mine/points/delete, method="remove" - remove applied ...Extra Fee API
1. Amasty\Extrafee\Api\TotalsInformationManagementInterface - class for managing cart totals for logged-in users: POST /V1/amasty_extrafee/carts/:cartId/totals-information, method="calculate" - calculate totals of a specific cart; POST ...Order Attributes API
1. Amasty\Orderattr\Api\EntityDataRepositoryInterface - class for managing order attributes in the backend: POST /V1/amasty_orderattr/entityData, method="save" - create an attribute; PUT /V1/amasty_orderattr/entityData/:entityId, method="save" - edit ...Shipping Rules API
Amasty\Shiprules\Api\RuleRepositoryInterface - class for managing shipping rules in backend: POST /V1/amasty_shiprules/rule, method="save" - create a rule; PUT /V1/amasty_shiprules/rule/:ruleId, method="save" - edit a rule; DELETE ...
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