Shipping Rules API Overview

Shipping Rules API

Info
We have created a public API collection for Shipping Rules 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.
Amasty\Shiprules\Api\RuleRepositoryInterface - class for managing shipping rules in backend:
  1. POST /V1/amasty_shiprules/rule, method="save" - create a rule;
  2. PUT /V1/amasty_shiprules/rule/:ruleId, method="save" - edit a rule;
  3. DELETE /V1/amasty_shiprules/rule/:ruleId, method="deleteById" - delete a rule;
  4. GET /V1/amasty_shiprules/rule, method="getById" - get information about a rule;
  5. GET /V1/amasty_shiprules/rule/all, method="getList" - get a list with all rules.


      • Related Articles

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

      • 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 can I check which delivery options the Shipping Rules extension is compatible with?

        The shipping methods present in the Magento Admin Panel → Stores → Configuration → Sales → Shipping Methods tab will also be available for selection in the Shipping Carriers and Methods dropdown that you see when creating a shipping rule: If some of ...

      • Free Shipping Bar API

        We have created a public API collection for Free Shipping Bar 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 ...