Schema Documentation
coupon
Description
A coupon object
Response
Returns a
Coupon
Arguments
Name | Description |
---|---|
id -
ID! | |
idType -
CouponIdTypeEnum | Type of ID being used identify coupon |
Example
Query
query coupon(
$id: ID!,
$idType: CouponIdTypeEnum
){
coupon(
id: $id,
idType: $idType
){
amountcodedatabaseIddatedateExpirydescriptiondiscountTypeemailRestrictionsexcludeSaleItemsexcludedProductCategories {
...CouponToExcludedProductCategoriesConnectionFragment
}excludedProducts {
...CouponToExcludedProductsConnectionFragment
}freeShippingidindividualUselimitUsageToXItemsmaximumAmountmetaData {
...MetaDataFragment
}minimumAmountmodifiedproductCategories {
...CouponToProductCategoryConnectionFragment
}products {
...CouponToProductConnectionFragment
}usageCountusageLimitusageLimitPerUserusedBy {
...CouponToCustomerConnectionFragment
}
}
}
Variables
{"id":4,"idType":"CODE"}
Response
{"data":{"coupon":{"amount":123.45,"code":"abc123","databaseId":123,"date":"abc123","dateExpiry":"abc123","description":"abc123","discountType":"FIXED_CART","emailRestrictions":["xyz789"],"excludeSaleItems":true,"excludedProductCategories":CouponToExcludedProductCategoriesConnection,"excludedProducts":CouponToExcludedProductsConnection,"freeShipping":false,"id":4,"individualUse":true,"limitUsageToXItems":123,"maximumAmount":987.65,"metaData":[MetaData],"minimumAmount":123.45,"modified":"abc123","productCategories":CouponToProductCategoryConnection,"products":CouponToProductConnection,"usageCount":987,"usageLimit":123,"usageLimitPerUser":123,"usedBy":CouponToCustomerConnection}}}