MageSmith
POSTSalesRule · Magento 2.4.9 Admin · Magento_SalesRule::quote

POST /V1/coupons/deleteByCodes

POST /V1/coupons/deleteByCodes is a Magento 2 REST endpoint in the SalesRule module. Delete coupon by coupon codes. Requires an admin Bearer token with ACL Magento_SalesRule::quote.

Last verified: against Magento 2.4.9.

Returns

Magento\SalesRule\Api\Data\CouponMassDeleteResultInterface

Service contract

Magento\SalesRule\Api\CouponManagementInterface::deleteByCodes

Authorization

Admin Bearer token with ACL:

  • Magento_SalesRule::quote

Body parameters

codes string[] Required
ignoreInvalidCoupons bool default: true

Example request

Auto-generated from the service contract — paste-ready against your store's /rest/default base. Replace the host, store code, ACL token, and any required values before running.

Headers

Accept
application/json
Content-Type
application/json
Authorization
Bearer <ACCESS_TOKEN> admin token with ACL: Magento_SalesRule::quote

Path

/V1/coupons/deleteByCodes

Body

{
  "codes": [
    ""
  ],
  "ignoreInvalidCoupons": false
}

Related in SalesRule

Other endpoints shipped by the same module.

POST

/V1/coupons

Save a coupon.

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

→
DELETE

/V1/coupons/:couponId

Delete coupon by coupon id.

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

→
GET

/V1/coupons/:couponId

Get coupon by coupon id.

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

→
PUT

/V1/coupons/:couponId

Save a coupon.

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

→
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

→

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 →