The coupon object and the allowed CRUD operations on the related resource endpoint

Commerce Layer provides a promotional engine built on top of two main resources: promotions and promotion rules.

Coupons must be associated with coupon code promotions rules so that a promotion is triggered when customers enter a specific coupon code at checkout. The number of promotions based on coupons is unlimited. The coupon can be used multiple times and it is considered valid until its usage count exceeds the threshold set by its usage limit. About that:

  • Set the usage_limit attribute to 1 if you want the code to be used just once.

  • Set the customer_single_use attribute to true if you want it to be used just once per customer.

  • Specify a value for the expires_at attribute if you want to set an expiration date for the coupon (within the time window in which the associated promotion is active).

The coupon code is also exposed at the line item level, so that you can check which coupon has been used to trigger that promotion line item.

Coupon codes minimum length is 8 characters, maximum length is 40 characters.

Last updated