Abandoned Cart Email API Guide

Abandoned Cart Email API

Info
We have created a public API collection for Abandoned Cart Email 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\Acart\Api\BlacklistRepositoryInterface - class for managing blacklist data.
  1. GET /V1/amasty_acart/blacklist/:id, method="getById" - get a blacklist entry by ID;
  2. GET /V1/amasty_acart/blacklist/getByCustomerEmail/:customerEmail, method="getByCustomerEmail" - get a blacklist entry by customer email address;
  3. GET /V1/amasty_acart/blacklist/all, method="getList" - get a list of all blacklist entries;
  4. POST /V1/amasty_acart/blacklist, method="save" - add email to a blacklist;
  5. PUT /V1/amasty_acart/blacklist/:id, method="save" - edit a blacklisted email;
  6. DELETE /V1/amasty_acart/blacklist/:id, method="deleteById" - delete an email from blacklist.

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

      • How does the Abandoned Cart Email extension work for guests?

        The Abandoned Cart Email extension works for guest customers in the cases when a customer enters their email on the checkout page, but interrupts the checkout process. The extension captures the entered email with AJAX and immediately saves it. This ...

      • Does the Abandoned Cart Email extension have cross-device compatibility?

        If a user abandons their cart from desktop, and after receiving the email opens it on a mobile device, the cart will show correctly. Please refer to the screenshots below to see an example of this case behavior. 1. The cart was left at checkout with ...

      • I installed the Abandoned Cart Email extension but emails are not sent.

        The abandoned carts are tracked within the campaigns. To start sending emails to the customers, please create and configure a campaign in Marketing → Abandoned Cart Email → Campaigns. Here is our video guide for Abandoned Cart Email set up: Please ...