Extensions with API support
Countdown Timer API
Amasty\PromoCountdown\Api\Service\DateDifferenceInterface - class for calculating the difference between the dates: POST /V1/promo-countdown/service/date/difference, method="getDifference" - calculate the difference between the current date and 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 ...
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 ...
Store Credit & Refund API
1. Amasty\StoreCredit\Api\ApplyStoreCreditToQuoteInterface - class for managing store credits on checkout: POST /V1/carts/mine/amstorecredit/apply, method="apply" - apply store credits to the quote; POST /V1/carts/mine/amstorecredit/cancel, ...
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 ...
Store Pickup with Locator
1. Amasty\StorePickupWithLocator\Api\GuestLocationPickupValuesInterface - class for managin store pickup for guests: POST /V1/amstorepickup/:cartId/saveSelectedPickupValues, method="saveSelectedPickupValues" - deprecated query, retained for backward ...
Exit Intent Popup API
Amasty\ExitPopup\Api\EmailManagementInterface - class for managing emails: POST /V1/ampopup/sendEmail, method="sendEmail" - send a promotion email to a customer.
Advanced Conditions API (+Reward Points, Extra Fee, Free Gift, Shipping Rules, Shipping Restrictions)
Advanced Conditions can be purchased both separately and within other Amasty modules: Reward Points, Extra Fee, Free Gift, Shipping Rules, Shipping Restrictions. The Advanced Conditions extension adds its functionality to the main modules, ...
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 ...
Free Shipping Bar API
Amasty\ShippingBar\Api\BarManagementInterface: POST /V1/amasty_shipbar/mine/bar/data, method="getFilledData" - get all the information about a free shipping bar on the frontend.
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 ...
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 ...
Cash on Delivery API
Amasty\CashOnDelivery\Api\PaymentManagementInterface: POST /V1/cash_on_delivery/checkAvailable/:postalCode, method="checkAvailable" - check whether the Cash On Delivery payment method is available for a specific postcode.
Payments with Stripe API
1. Amasty\Stripe\Api\Quote\ApplePayGuestShippingMethodManagementInterface - class for managing shipping methods for guest users: POST /V1/guest-carts/:cartId/estimate-shipping-methods-apple-pay, method="estimateByExtendedAddress" - display the list ...
One Step Checkout API
1. Amasty\Checkout\Api\AdditionalFieldsManagementInterface - class for managing additional fields for logged-in users: POST /V1/amasty_checkout/carts/:cartId/amcheckoutFields, method="save" - save a field for a specific cart by ID; POST ...
Product Parts Finder API
1. Amasty\Finder\Api\DropdownRepositoryInterface - class for managing parts finder dropdowns: POST /V1/amasty_finder/dropdown, method="save" - create a dropdown; PUT /V1/amasty_finder/dropdown/:id, method="save" - edit a dropdown; DELETE ...
Mega Menu API
1. Amasty\MegaMenu\Api\LinkRepositoryInterface - class for managing links inside the menu: POST /V1/amasty_megaMenu/link, method="save" - create a link; PUT /V1/amasty_megaMenu/link/:entityId, method="save" - edit a link; DELETE ...
Landing Pages API
1. Amasty\Xlanding\Api\PageRepositoryInterface - class for managing Landing Pages: POST /V1/amasty_xlanding/page, method="save" - create a landing page; PUT /V1/amasty_xlanding/page/:id, method="save" - edit a landing page; DELETE ...
Advanced Reports API
1. Amasty\Reports\Api\RuleRepositoryInterface - class for managing rules for reports configuration: POST /V1/amasty_reports/rule, method="save" - create a rule; PUT /V1/amasty_reports/rule/:entityId, method="save" - edit a rule; DELETE ...
Product Attachments API
API functionality for Product Attachments will be available with the API for Product Attachments Add-On only. 1. Amasty\ProductAttachmentApi\Api\FrontendAttachmentInterface - class for getting product attachments on frontend: GET ...
Custom Form API
1. Amasty\Customform\Api\AnswerRepositoryInterface - class for managing form answers: POST /V1/amasty_customform/answer, method="save" - create an answer; PUT /V1/amasty_customform/answer/:answerId, method="save" - edit an answer; DELETE ...
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 ...
Product Tabs API
Amasty\CustomTabs\Api\TabsRepositoryInterface - classfor managing tabs: POST /V1/amasty_customTabs/tabs, method="save" - create a tab PUT /V1/amasty_customTabs/tabs/:tabId, method="save" - edit a tab DELETE /V1/amasty_customTabs/tabs/:tabId, ...
Gift Wrap API
1. Amasty\GiftWrap\Api\WrapRepositoryInterface - class for managing gift wraps: POST /V1/amasty_giftWrap/wrap, method="save" - create a wrap; PUT /V1/amasty_giftWrap/wrap/:entityId, method="save" - edit a wrap; DELETE ...
Request a Quote API
1. Amasty\RequestQuote\Api\RemarkServiceInterface: PUT /V1/amasty_quote/updateRemark, method="save" - add information to the Remark field. 2. Amasty\RequestQuote\Api\QuoteRepositoryInterface - class for managing quotes: PUT ...
Improved Layered Navigation API
API functionality for Improved Layered Navigation is added by its submodule Improved Layered Navigation Pages (shop-by-page). Amasty\ShopbyPage\Api\PageRepositoryInterface - class for pages: POST /V1/amasty_shopbypage/page, method="save" - ...
Login As Customer API
1. Amasty\CustomerLogin\Api\CustomerTokenInterface - class for customer token: POST /V1/amasty_customer_login/token, method="createCustomerToken" - create customer token. 2. Amasty\CustomerLogin\Api\LoggedInRepositoryInterface - class for logs: PUT ...
FAQ and Product Questions API
1. Amasty\Faq\Api\QuestionRepositoryInterface - class for questions: POST /V1/amasty_faq/question, method="save" - create a question; PUT /V1/amasty_faq/question/:questionId, method="save" - edit a question; DELETE ...
Order Archive API
Amasty\Orderarchive\Api\ArchiveProcessorInterface - class for managing order archives in backend: POST /V1/amastyMoveToArchive, method="moveToArchive" - move an order to archive; POST /V1/amastyMoveFromArchive, method="removeFromArchive" - remove an ...
Gift Card API
1. Amasty\GiftCard\Api\ImageRepositoryInterface - class for managing gift card images: POST /V1/amgcard/image, method="save" - save a gift card image; PUT /V1/amgcard/image/:id, method="save" - save a gift card image by ID; DELETE ...