Coupon

Object

A coupon object

Fields

amount:Float

Amount off provided by the coupon

code:String

Coupon code

databaseId:Int

The ID of the coupon in the database

date:String

Date coupon created

dateExpiry:String

Date coupon expires

description:String

Explanation of what the coupon does

discountType:DiscountTypeEnum

Type of discount

emailRestrictions:[String]

Only customers with a matching email address can use the coupon

excludeSaleItems:Boolean

Excluding sale items mean this coupon cannot be used on items that are on sale (or carts that contain on sale items)

excludedProductCategories(first: Int, last: Int, after: String, before: String, where: CouponToExcludedProductCategoriesConnectionWhereArgs):CouponToExcludedProductCategoriesConnection

Connection between the Coupon type and the productCategory type

excludedProducts(first: Int, last: Int, after: String, before: String, where: CouponToExcludedProductsConnectionWhereArgs):CouponToExcludedProductsConnection

Connection between the Coupon type and the ProductUnion type

freeShipping:Boolean

Does this coupon grant free shipping?

id:ID!

The globally unique identifier for the coupon

individualUse:Boolean

Individual use means this coupon cannot be used in conjunction with other coupons

limitUsageToXItems:Int

The number of products in your cart this coupon can apply to (for product discounts)

maximumAmount:Float

Maximum spend amount that must be met before this coupon can be used

metaData(key: String, keysIn: [String], multiple: Boolean):[MetaData]

Object meta data

minimumAmount:Float

Minimum spend amount that must be met before this coupon can be used

modified:String

Date coupon modified

productCategories(first: Int, last: Int, after: String, before: String, where: CouponToProductCategoryConnectionWhereArgs):CouponToProductCategoryConnection

Connection between the Coupon type and the productCategory type

products(first: Int, last: Int, after: String, before: String, where: CouponToProductUnionConnectionWhereArgs):CouponToProductUnionConnection

Connection between the Coupon type and the ProductUnion type

usageCount:Int

How many times the coupon has been used

usageLimit:Int

Amount of times this coupon can be used globally

usageLimitPerUser:Int

Amount of times this coupon can be used by a customer

usedBy(first: Int, last: Int, after: String, before: String, where: CouponToCustomerConnectionWhereArgs):CouponToCustomerConnection

Connection between the Coupon type and the Customer type

Implements

Node

Loading…

Coupon

Object

A coupon object

Fields

amount:Float

Amount off provided by the coupon

code:String

Coupon code

databaseId:Int

The ID of the coupon in the database

date:String

Date coupon created

dateExpiry:String

Date coupon expires

description:String

Explanation of what the coupon does

discountType:DiscountTypeEnum

Type of discount

emailRestrictions:[String]

Only customers with a matching email address can use the coupon

excludeSaleItems:Boolean

Excluding sale items mean this coupon cannot be used on items that are on sale (or carts that contain on sale items)

excludedProductCategories(first: Int, last: Int, after: String, before: String, where: CouponToExcludedProductCategoriesConnectionWhereArgs):CouponToExcludedProductCategoriesConnection

Connection between the Coupon type and the productCategory type

excludedProducts(first: Int, last: Int, after: String, before: String, where: CouponToExcludedProductsConnectionWhereArgs):CouponToExcludedProductsConnection

Connection between the Coupon type and the ProductUnion type

freeShipping:Boolean

Does this coupon grant free shipping?

id:ID!

The globally unique identifier for the coupon

individualUse:Boolean

Individual use means this coupon cannot be used in conjunction with other coupons

limitUsageToXItems:Int

The number of products in your cart this coupon can apply to (for product discounts)

maximumAmount:Float

Maximum spend amount that must be met before this coupon can be used

metaData(key: String, keysIn: [String], multiple: Boolean):[MetaData]

Object meta data

minimumAmount:Float

Minimum spend amount that must be met before this coupon can be used

modified:String

Date coupon modified

productCategories(first: Int, last: Int, after: String, before: String, where: CouponToProductCategoryConnectionWhereArgs):CouponToProductCategoryConnection

Connection between the Coupon type and the productCategory type

products(first: Int, last: Int, after: String, before: String, where: CouponToProductUnionConnectionWhereArgs):CouponToProductUnionConnection

Connection between the Coupon type and the ProductUnion type

usageCount:Int

How many times the coupon has been used

usageLimit:Int

Amount of times this coupon can be used globally

usageLimitPerUser:Int

Amount of times this coupon can be used by a customer

usedBy(first: Int, last: Int, after: String, before: String, where: CouponToCustomerConnectionWhereArgs):CouponToCustomerConnection

Connection between the Coupon type and the Customer type

Implements

Node