Overview

On this page, we’ll dive into the different coupon endpoints you can use to manage coupons programmatically.

Coupons help boost sales on your SellApp storefront — they allow you to attract new customers with exclusive offers and reward existing customers for their previous purchases.

On this page, we'll dive into the different coupon endpoints you can use to manage coupons programmatically. We'll look at how to create, update, and delete coupons.

Endpoints

The coupon model

The coupon model contains all the information about the coupons stores have, including the type, code, and discount amount.

Properties

Name: idinteger
Description: The unique identifier for the coupon.
Name: codestring
Description: The coupon code which the customer enters during checkout.
Name: typestring
Description: The type of coupon. Supported types:

PERCENTAGE

AMOUNT
Name: discountinteger
Description: The discount value related to the above type. Examples:

PERCENTAGE: 50 (in percentages)

AMOUNT: 5 (in dollars)
Name: limitinteger
Description: The total amount of times this coupon can be applied before it can no longer be used.
Name: store_wideboolean
Description: The scope of the coupon; if true it applies to all products in your store. If false, it only applies to certain products.
Name: minimum_amountinteger
Description: The minimum amount (in dollars) at which the coupon can be applied.
Name: expires_attimestamp
Description: The time at which this coupon stops being usable.
Name: created_attimestamp
Description: The time at which this coupon was first created.
Name: updated_attimestamp
Description: The time at which this coupon was last updated.
Name: store_idinteger
Description: The ID of the store this coupon belongs to.
Name: deleted_attimestamp
Description: The time at which this coupon was deleted.