Commerce Layer provides a promotional engine built on top of two main resources: promotions and promotion rules. Coupons have to be associated with coupon code promotions rules so that a promotion is triggered when customers enter a specific coupon code at checkout. The coupon can be used multiple times and it is considered valid until its usage count exceeds the threshold set by its usage limit. Set the
usage_limit attribute to
1 if you want the code to be used just once.
A coupon object is returned as part of the response body of each successful list, retrieve, create or update API call.
The coupon unique identifier
The coupon endpoint URL
The coupon code, that uniquely identifies the coupon within the promotion rule.
The total number of times this coupon can be used.
The number of times this coupon has been used.
Time at which the resource was created.
Time at which the resource was last updated.
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
Any identifier of the third party system that defines the reference code
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
The associated promotion rule.
The resource environment (can be one of