MageSmith
magento/module-sales-rule · Magento 2.4.9

SalesRule REST endpoints

vendor/magento/module-sales-rule/etc/webapi.xml

13 endpoints

GET

GET

/V1/coupons/:couponId

Get coupon by coupon id.

SalesRule · Magento\SalesRule\Api\CouponRepositoryInterface::getById

→
GET

/V1/coupons/search

Retrieve a coupon using the specified search criteria.

SalesRule · Magento\SalesRule\Api\CouponRepositoryInterface::getList

→
GET

/V1/salesRules/:ruleId

Get rule by ID.

SalesRule · Magento\SalesRule\Api\RuleRepositoryInterface::getById

→
GET

/V1/salesRules/search

Retrieve sales rules that match te specified criteria.

SalesRule · Magento\SalesRule\Api\RuleRepositoryInterface::getList

→

POST

POST

/V1/coupons

Save a coupon.

SalesRule · Magento\SalesRule\Api\CouponRepositoryInterface::save

→
POST

/V1/coupons/deleteByCodes

Delete coupon by coupon codes.

SalesRule · Magento\SalesRule\Api\CouponManagementInterface::deleteByCodes

→
POST

/V1/coupons/deleteByIds

Delete coupon by coupon ids.

SalesRule · Magento\SalesRule\Api\CouponManagementInterface::deleteByIds

→
POST

/V1/coupons/generate

Generate coupon for a rule

SalesRule · Magento\SalesRule\Api\CouponManagementInterface::generate

→
POST

/V1/salesRules

Save sales rule.

SalesRule · Magento\SalesRule\Api\RuleRepositoryInterface::save

→

PUT

PUT

/V1/coupons/:couponId

Save a coupon.

SalesRule · Magento\SalesRule\Api\CouponRepositoryInterface::save

→
PUT

/V1/salesRules/:ruleId

Save sales rule.

SalesRule · Magento\SalesRule\Api\RuleRepositoryInterface::save

→

DELETE

DELETE

/V1/coupons/:couponId

Delete coupon by coupon id.

SalesRule · Magento\SalesRule\Api\CouponRepositoryInterface::deleteById

→
DELETE

/V1/salesRules/:ruleId

Delete rule by ID.

SalesRule · Magento\SalesRule\Api\RuleRepositoryInterface::deleteById

→

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.

Open app →