Create discount coupon

Create a new discount coupon in an Ecwid store.

Access scopes

Requires the following access scope: create_discount_coupons

Request

A JSON object of type 'Coupon' with the following fields:

Coupon

FieldTypeDescription
namestringCoupon title
codestringUnique coupon code, length limit is 128 characters.
discountTypestringDiscount type: ABS, PERCENT, SHIPPING, ABS_AND_SHIPPING, PERCENT_AND_SHIPPING . Default is ABS
statusstringDiscount coupon state: ACTIVE, PAUSED. Discount coupon states EXPIRED and USEDUP are set by Ecwid store only and not available in API
discountnumberDiscount amount . 0 is default
launchDatestringThe date of coupon launch, e.g. 2014-06-06 08:00:00 +0400. Any date provided will be corrected to the UTC timezone
expirationDatestringCoupon expiration date, e.g. 2014-06-06 08:00:00 +0400. Any date provided will be corrected to the UTC timezone
totalLimitnumberThe minimum order subtotal the coupon applies to
usesLimitstringNumber of uses limitation: UNLIMITED, ONCEPERCUSTOMER, SINGLE . UNLIMITED is default
repeatCustomerOnlybooleanDeprecated. Use applicationLimit instead. Coupon usage limitation flag identifying whether the coupon works for all customers or only repeat customers
applicationLimitstringApplication limit for discount coupons. Possible values: "UNLIMITED", "NEW_CUSTOMER_ONLY", "REPEAT_CUSTOMER_ONLY". If you are creating or updating a discount coupon, make sure to use the old repeatCustomerOnly field or the new applicationLimit field only. When both these fields are sent, the priority will be given to the new field – applicationLimit
orderCountnumberNumber of uses
catalogLimit<DiscountCouponCatalogLimit>The products and categories the coupon can be applied to
shippingLimit<DiscountCouponShippingLimit>Shipping methods, the cost of which will be free after applying the coupon (for 'Free shipping' coupons)

DiscountCouponCatalogLimit

FieldTypeDescription
productsArrayThe list of product IDs the coupon can be applied to
categoriesArrayThe list of category IDs the coupon can be applied to

DiscountCouponShippingLimit

FieldTypeDescription
shippingMethodsArrayThe list of shipping method IDs, the cost of which will be free after applying the coupon

Response

A JSON object of type 'CreateStatus' with the following fields:

CreateStatus

FieldTypeDescription
idnumberInternal unique coupon ID
codestringCode of the created coupon

Errors

In case of error, Ecwid responds with an error HTTP status code and, optionally, a JSON-formatted body containing error description.

HTTP codes

HTTP StatusResponse JSONDescription
400Request parameters are malformed
403Access token doesn't have create_discount_coupons scope
409The coupon with the given code already exists
415Unsupported content-type: expected application/json or text/json
500The creation request failed because of an error on the server

Error response body (optional)

FieldTypeDescription
errorMessagestringError message
Language
Click Try It! to start a request and see the response here!