RMA API

RMA API

Kindly note that the API functionality for RMA is available as part of the Pro and Premium extension plans. 

1. Amasty\Rma\Api\StatusRepositoryInterface - class for managing RMA statuses.
  1. GET /V1/amasty_rma/rma_status/get/:statusId, method="getById" - get info about an RMA status by ID.

2. Amasty\RmaApi\Api\StatusFinderInterface - class for managing RMA statuses.
  1. GET /V1/amasty_rma/rma_status/list, method="getList" - get a list of RMA statuses.

3. Amasty\Rma\Api\ResolutionRepositoryInterface - class for managing RMA resolutons.
  1. GET /V1/amasty_rma/rma_resolution/get/:resolutionId, method="getById" - get info about an RMA resolution by ID.

4. Amasty\RmaApi\Api\ResolutionFinderInterface - class for managing RMA resolutions.
  1. GET /V1/amasty_rma/rma_resolution/list, method="getList" - get a list of RMA resolutions.

5. Amasty\Rma\Api\ConditionRepositoryInterface - class for managing RMA conditions.
  1. GET /V1/amasty_rma/rma_condition/get/:conditionId, method="getById" - get info about an RMA condition by ID.

6. Amasty\RmaApi\Api\ConditionFinderInterface - class for managing RMA conditions.
  1. GET /V1/amasty_rma/rma_condition/list, method="getList" - get a list of RMA conditions.

7. Amasty\Rma\Api\ReasonRepositoryInterface - class for managing RMA reasons.
  1. GET /V1/amasty_rma/rma_reason/get/:reasonId, method="getById" - get info about an RMA reason by ID.

8. Amasty\RmaApi\Api\ReasonFinderInterface - class for managing RMA reasons.
  1. GET /V1/amasty_rma/rma_reason/list, method="getList" - get a list of RMA reasons.

9. Amasty\Rma\Api\ChatRepositoryInterface - class for managing RMA chat messages. 
  1. GET /V1/amasty_rma/rma_chat/get/:messageId, method="getById" - get a chat message;
  2. POST /V1/amasty_rma/rma_chat/message, method="save" - create a new chat message.

10. Amasty\RmaApi\Api\ChatMessageFinderInterface - class for managing RMA chat messages. 
  1. GET /V1/amasty_rma/rma_chat/list, method="getList" - get RMA chat messages.

11. Amasty\Rma\Api\RequestRepositoryInterface - class for managing RMA requests. 
  1. GET /V1/amasty_rma/rma_request/get/:requestId, method="getById" - get information about an RMA request by ID;
  2. PUT /V1/amasty_rma/rma_request/request/:requestId, method="save" - edit an RMA request;
  3. GET /V1/amasty_rma/rma_request_tracking/get/:trackingId, method="getTrackingById" - get an RMA tracking code;
  4. PUT /V1/amasty_rma/rma_request_tracking/save/:trackingId, method="saveTracking" - edit an RMA tracking code;
  5. POST /V1/amasty_rma/rma_request_tracking/create, method="saveTracking" - add a tracking code to an RMA request;
  6. DELETE /V1/amasty_rma/rma_request_tracking/delete/:trackingId, method="deleteTrackingById" - delete a tracking code from an RMA request.

12. Amasty\RmaApi\Api\RequestFinderInterface - class for managing RMA requests. 
  1. GET /V1/amasty_rma/rma_request/list, method="getList" - get a list of RMA requests.

13. Amasty\Rma\Api\CustomerRequestRepositoryInterface - class for managing RMA requests. 
  1. POST /V1/amasty_rma/rma_request/request, method="create" - create a new customer RMA request;
  2. POST /V1/amasty_rma/rma_request/cancel/:requestIdHash, method="closeRequest" - cancel an RMA request.

14. Amasty\RmaApi\Api\RequestDeleterInterface - class for managing RMA requests. 
  1. DELETE /V1/amasty_rma/rma_request/request/:requestId, method="deleteById" - delete an RMA request.

15. Amasty\RmaApi\Api\RequestItemRepositoryInterface - class for managing RMA request products.
  1. GET /V1/amasty_rma/rma_request_item/get/:itemId, method="getById" - get an RMA product by ID;
  2. PUT V1/amasty_rma/rma_request_item/item/:itemId, method="save" - edit an RMA product;
  3. POST /V1/amasty_rma/rma_request_item/item, method="save" - add a product to the RMA request;
  4. DELETE /V1/amasty_rma/rma_request_item/request/:itemId, method="deleteById" - remove a product from an RMA request.

16. Amasty\RmaApi\Api\RequestItemFinderInterface - class for managing RMA request products.
  1. GET /V1/amasty_rma/rma_request_item/list, method="getList" - get all products from an RMA request.

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

      • RMA | GraphQL methods

        Quries getAmRmaSettings description: a list of customer's return requests getAmRmaReturnsForCurrentCustomer description: get a list of customer's return requests getAmRmaReturnById (request_id: Int!) description: get Return Request by ID ...

      • How to allow guest customers to submit an RMA request?

        To enable guest RMA, navigate to Stores → Configuration → Amasty Extensions → RMA → General and enable the Allow Guest RMA option. Guest visitors will be able to find the link to the refund request creation page in the footer.

      • When does the RMA start counting refund period days?

        Out of the box, RMA starts counting refund period days when the order is created.

      • GDPR API

        1. Amasty\Gdpr\Api\RequestInterface - class for managing personal data deletion requests. POST /V1/amasty_gdpr/approveDeleteRequest, method="approveDeleteRequest" - approve a request; POST /V1/amasty_gdpr/denyDeleteRequest, method="denyDeleteRequest" ...