Get coupon

get https://app.ecwid.com/api/v3/{storeId}/discount_coupons/{couponIdentifier}

Get discount coupon details

Headers

Name	Type	Description
Authorization	string	oAuth token with mandatory `Bearer` before it. Example: `Bearer e*s0`, where `e*s0` should be replaced with your oAuth token.

Response

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

Coupon

Field	Type	Description
id	number	Internal unique coupon ID
name	string	Coupon title
code	string	Unique coupon code
discountType	string	Discount type: `ABS`, `PERCENT`, `SHIPPING`, `ABS_AND_SHIPPING`, `PERCENT_AND_SHIPPING`
status	string	Discount coupon state: `ACTIVE`, `PAUSED`, `EXPIRED` or `USEDUP`
discount	number	Discount amount
launchDate	string	The date of coupon launch, e.g. `2014-06-06 08:00:00 +0400`. Any date provided will be corrected to the UTC timezone
expirationDate	string	Coupon expiration date, e.g. `2014-06-06 08:00:00 +0400`. Any date provided will be corrected to the UTC timezone
totalLimit	number	The minimum order subtotal the coupon applies to
usesLimit	string	Number of uses limitation: `UNLIMITED`, `ONCEPERCUSTOMER`, `SINGLE`
repeatCustomerOnly	boolean	Deprecated. Use applicationLimit instead. Coupon usage limitation flag identifying whether the coupon works for all customers or only repeat customers
applicationLimit	string	Application 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`
creationDate	string	Coupon creation date. Format example: `2016-06-29 11:36:55 +0000`
updateDate	string	Coupon update date. Format example: `2016-06-29 11:36:55 +0000`
orderCount	number	Number 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

Field	Type	Description
products	Array	The list of product IDs the coupon can be applied to
categories	Array	The list of category IDs the coupon can be applied to

DiscountCouponShippingLimit

Field	Type	Description
shippingMethods	Array	The list of shipping method IDs, the cost of which will be free after applying the coupon

Errors

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

HTTP codes

HTTP Status	Meaning
400	Malformed request parameters
403	Access token doesn't have `read_discount_coupons` scope
404	Coupon is not found
415	Unsupported content-type: expected `application/json` or `text/json`

Language

Authorization

Query