Project

General

Profile

Coupon: Resource Representations

Coupon

Resource

Property name Value Description Note
coupon_id Integer Used to uniquely identify the coupon in your
date_issued Timestamp Timestamp indicating when this coupon is created
date_expire Timestamp Time until the coupon can be applied to
seller_name String The username of the seller in BL
buyer_name String The username of the buyer in BL
store_name String The store name displayed on BL store pages
status String Status of the coupon. Possible values are:
- O: Open
- A: Redeemed
- D: Declined
- E: Expired
remarks String A description of the coupon that can be displayed to buyers
order_id Integer Order ID associated with this coupon
currency_code String The three letter code for the currency used for the transaction ISO 4217
disp_currency_code String The three letter code for the currency used for displaying the price ISO 4217
discount_type String The type of discount. Possible values are:
- F: Fixed amount coupon. The discount is expressed as a discrete monetary value
- S: Percentage coupon. The discount is expressed as a percentage
applies_to Object This object provides ability to restrict a PERCENTAGE coupon to a specific item type or condition
applies_to.type String The type of restriction. Possible values are:
- A: Discount will be applied to the total of all items in an order which are a specified item type (or all items regardless of the type if applies_to.item_type is not specified)
- E: Discount will be applied to the total of all items in an order which are all except a specified item type
applies_to.item_type String The type of items for which this discounts need to be applied ( or excluded )
applies_to.except_on_sale Boolean Indicates that whether the discount of the coupon to exclude items on sale
discount_amount Decimal
disp_discount_amount Decimal
discount_rate Integer
max_discount_amount Decimal
disp_max_discount_amount Decimal
tier_price1 Decimal
disp_tire_price1 Decimal
tier_discount_rate1 Integer
tier_price2 Decimal
disp_tire_price2 Decimal
tier_discount_rate2 Integer
tier_price3 Decimal
disp_tire_price3 Decimal
tier_discount_rate3 Integer
Add picture from clipboard (Maximum size: 24.4 MB)