Open API v2 will be deprecated on April 3, 2023. Please begin transitioning to Open API v3 as soon as possible. As of September 29, 2022 all new apps will only be permitted to use Open API v3.

API Documentation

Coupon

Deprecated: The Etsy API no longer supports coupons.

Overview

Represents a shop coupon.

Fields

Field Visibility Level Permission Scope Type Description
coupon_id private shops_rw int The numeric ID of the coupon
coupon_code private shops_rw string The alphanumeric coupon code
seller_active private shops_rw boolean True if the coupon is active
pct_discount private shops_rw int The discount percent (null for free shipping coupons)
free_shipping private shops_rw boolean True if the coupon applies free shipping
domestic_only private shops_rw boolean True if the coupon free shipping applies to domestic addresses only
currency_code private shops_rw string The 3 letter currency code relating to currency values if any. fixed_discount or minimum_purchase_price
fixed_discount private shops_rw string Discount amount the coupon should take. For currency information see currency_code
minimum_purchase_price private shops_rw string The minimum amount in a cart before tax or shipping needed in order to apply the coupon. For currency information see currency_code
expiration_date private shops_rw int A epoch time (UTC) on which the coupon can no longer be applied
coupon_type private shops_rw string The type of coupon: fixed_discount, pct_discount, free_shipping for example

Associations

This resource has no associations.

Methods

findAllShopCoupons

Method Name findAllShopCoupons
Synopsis Retrieves all Shop_Coupons by shop_id
HTTP Method GET
URI /shops/:shop_id/coupons
Parameters
Name Required Default Type
shop_id Y   shop_id_or_name
Requires OAuth Y
Permission Scope shops_rw

createCoupon

Method Name createCoupon
Synopsis Creates a new Coupon. May only have one of free_shipping, pct_discount or fixed_discount
HTTP Method POST
URI /shops/:shop_id/coupons
Parameters
Name Required Default Type
shop_id Y   shop_id_or_name
coupon_code Y   string
pct_discount N   int
seller_active N false boolean
free_shipping N false boolean
domestic_only N false boolean
currency_code N USD string
fixed_discount N   string
minimum_purchase_price N   string
expiration_date N   int
Requires OAuth Y
Permission Scope shops_rw

findCoupon

Method Name findCoupon
Synopsis Retrieves a Shop_Coupon by id and shop_id
HTTP Method GET
URI /shops/:shop_id/coupons/:coupon_id
Parameters
Name Required Default Type
shop_id Y   shop_id_or_name
coupon_id Y   int
Requires OAuth Y
Permission Scope shops_rw

updateCoupon

Method Name updateCoupon
Synopsis Updates a coupon
HTTP Method PUT
URI /shops/:shop_id/coupons/:coupon_id
Parameters
Name Required Default Type
shop_id Y   shop_id_or_name
coupon_id Y   int
seller_active N false boolean
Requires OAuth Y
Permission Scope shops_rw

deleteCoupon

Method Name deleteCoupon
Synopsis Deletes a coupon
HTTP Method DELETE
URI /shops/:shop_id/coupons/:coupon_id
Parameters
Name Required Default Type
shop_id Y   shop_id_or_name
coupon_id Y   int
Requires OAuth Y
Permission Scope shops_rw

Open API v3New

Your developer account