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.
- ApiMethod
- BillCharge
- BillingOverview
- BillPayment
- Cart
- CartListing
- Country
- Coupon
- DataType
- FavoriteListing
- FavoriteUser
- Feedback
- FeedbackInfo
- ForumPost
- Guest
- GuestCart
- ImageType
- Ledger
- LedgerEntry
- Listing
- ListingFile
- ListingImage
- ListingInventory
- ListingOffering
- ListingProduct
- ListingTranslation
- ListingVariationImage
- Money
- ParamList
- Payment
- PaymentAccountLedgerEntry
- PaymentAdjustment
- PaymentAdjustmentItem
- PaymentTemplate
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 |
|
int |
The numeric ID of the coupon |
coupon_code |
private |
|
string |
The alphanumeric coupon code |
seller_active |
private |
|
boolean |
True if the coupon is active |
pct_discount |
private |
|
int |
The discount percent (null for free shipping coupons) |
free_shipping |
private |
|
boolean |
True if the coupon applies free shipping |
domestic_only |
private |
|
boolean |
True if the coupon free shipping applies to domestic addresses only |
currency_code |
private |
|
string |
The 3 letter currency code relating to currency values if any. fixed_discount or minimum_purchase_price
|
fixed_discount |
private |
|
string |
Discount amount the coupon should take. For currency information see currency_code
|
minimum_purchase_price |
private |
|
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 |
|
int |
A epoch time (UTC) on which the coupon can no longer be applied |
coupon_type |
private |
|
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 |
|
||||||||
Requires OAuth | Y |
||||||||
Permission Scope |
|
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 |
|
||||||||||||||||||||||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||||||||||||||||||||||
Permission Scope |
|
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 |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|
updateCoupon
Method Name | updateCoupon |
||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Updates a coupon | ||||||||||||||||
HTTP Method | PUT |
||||||||||||||||
URI | /shops/:shop_id/coupons/:coupon_id |
||||||||||||||||
Parameters |
|
||||||||||||||||
Requires OAuth | Y |
||||||||||||||||
Permission Scope |
|
deleteCoupon
Method Name | deleteCoupon |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Deletes a coupon | ||||||||||||
HTTP Method | DELETE |
||||||||||||
URI | /shops/:shop_id/coupons/:coupon_id |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|