Sign in

v1

latestOpenAPI 3.0.02026-07-14455376855.8 KB
coupons/{couponId}

coupons/{couponId}

Get coupon by coupon id.

get/V1/coupons/{couponId}

Path parameters

couponIdinteger required

Response

200 Success.

codestring

Coupon code

coupon_idinteger

Coupon id

created_atstring

When the coupon is created

expiration_datestring

Expiration date

extension_attributesSalesRuleDataCouponExtensionInterface

ExtensionInterface class for @see \Magento\SalesRule\Api\Data\CouponInterface

is_primaryboolean required

The coupon is primary coupon for the rule that it's associated with

rule_idinteger required

The id of the rule associated with the coupon

times_usedinteger required

The number of times the coupon has been used

typeinteger

Of coupon

usage_limitinteger

Usage limit

usage_per_customerinteger

Usage limit per customer