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":987.65,"code":"abc123","databaseId":123,"date":"abc123","dateExpiry":"xyz789","description":"abc123","discountType":"FIXED_CART","emailRestrictions":["abc123"],"excludeSaleItems":true,"excludedProductCategories":CouponToExcludedProductCategoriesConnection,"excludedProducts":CouponToExcludedProductsConnection,"freeShipping":true,"id":4,"individualUse":false,"limitUsageToXItems":987,"maximumAmount":987.65,"metaData":[MetaData],"minimumAmount":123.45,"modified":"xyz789","productCategories":CouponToProductCategoryConnection,"products":CouponToProductConnection,"usageCount":123,"usageLimit":987,"usageLimitPerUser":123,"usedBy":CouponToCustomerConnection}}}