Gift Wrap API Overview

Gift Wrap API

Info
We have created a public API collection for Gift Wrap 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\GiftWrap\Api\WrapRepositoryInterface - class for managing gift wraps:
  1. POST /V1/amasty_giftWrap/wrap, method="save" - create a wrap;
  2. PUT /V1/amasty_giftWrap/wrap/:entityId, method="save" - edit a wrap;
  3. DELETE /V1/amasty_giftWrap/wrap/:entityId, method="deleteById" - delete a wrap;
  4. GET /V1/amasty_giftWrap/wrap, method="getById" - get information about a specific gift wrap;
  5. GET /V1/amasty_giftWrap/wrap/all, method="getList" - get a list of all wraps.

2. Amasty\GiftWrap\Api\MessageCardRepositoryInterface - class for managing gift message cards:
  1. POST /V1/amasty_giftWrap/message_card, method="save" - create a card;
  2. PUT /V1/amasty_giftWrap/message_card/:entityId, method="save" - edit a card;
  3. DELETE /V1/amasty_giftWrap/message_card/:entityId, method="deleteById" - delete a card;
  4. GET /V1/amasty_giftWrap/message_card, method="getById" - get information about a card;
  5. GET /V1/amasty_giftWrap/message_card/all, method="getList" - get a list of all cards.

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

      • One Step Checkout API

        We have created public API collections for One Step Checkout module, as well its One Step Checkout Delivery Date and One Step Checkout Gift Wrap submodules, with all available queries and sample data that you can both test via our demo endpoints and ...

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

      • Gift Card API

        We have created public API collections for Gift Card module and its Gift Card Account submodule 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 ...

      • Advanced Conditions API (+Reward Points, Extra Fee, Free Gift, Shipping Rules, Shipping Restrictions)

        We have created a public API collection for Advanced Conditions module with all available queries and sample data, you can copy it to run local tests in your Magento environment. More details about using public collections can be found in the ...