Store Credit and Refund API Overview

Store Credit & Refund API

Info
We have created a public API collection for Store Credit & Refund 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\StoreCredit\Api\ApplyStoreCreditToQuoteInterface - class for managing store credits on checkout:
  1. POST /V1/carts/mine/amstorecredit/apply, method="apply" - apply store credits to the quote;
  2. POST /V1/carts/mine/amstorecredit/cancel, method="cancel" - remove the applied store credits.

2. Amasty\StoreCredit\Api\StoreCreditRepositoryInterface - class for getting information about store credits:
  1. GET /V1/customers/me/amstorecredit, method="getByCustomerId" -get information about store credits by customer ID.

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

      • Can I refund orders with store credits?

        The RMA extension doesn’t deal with a refund itself. It works only with refund requests and is intended to help admins manage them much faster and easier. Everything about creating credit memos and sending money or store credits to customers should ...

      • 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 Pickup with Locator API

        We have created a public API collection for Store Pickup with Locator 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 ...