Name 

Description 

CouponApi Methods 

The methods of the CouponApi class are listed here. 

 

Name 

Description 

 

Add 

Saves an new couponData object. CouponData.Id will be populated with the newly created Id.  

 

AddCouponToCatalog 

Applys a coupon to a catalog.  

 

AddCouponToProduct 

Applys a coupon to a product.  

 

AddCouponToTaxonomy 

Applys a coupon to a catalog.  

 

ApplyCouponToBasket 

Applies a coupon to a customer's basket.  

 

CalculateBasketCoupons 

This is the overview for the CalculateBasketCoupons method overload. 

 

Deactivate 

Deactivate a coupondata object.  

 

Delete 

Deletes a coupondata object.  

 

DeleteCouponProducts 

Deletes all the products a coupon is applied to accept the products included in the ExclusionList.  

 

GetCatalogList 

retrieves list of CouponEntryData for catalogs with coupons applied to them.  

 

GetCouponsAppliedToBasket 

Retrievies a list of coupons applied to a basket.  

 

GetItem 

Retrieves a CouponData object by Id.  

 

GetList 

Retrieves list of couponData objects for a given customer.  

 

GetProductList 

This is the overview for the GetProductList method overload. 

 

GetTaxonomyList 

retrieves list of CouponEntryData for taxonomies with coupons applied to them.  

 

IsCouponAppliedToProduct 

Returns true if the coupon is applied to the catalog entry.  

 

IsCouponUsedForBasket 

Checks if coupon has been applied to a basket.  

 

IsCouponUsedForOrder 

Checks if coupon has been used by an order.  

 

SaveCouponApplications 

Saves all the applications (taxonomy, catalog, product) for a given coupon. This is assumed to be an all inclusive lists. Any existing coupon applications that are not included will be deleted.  

 

Update 

Updates the supplied CouponData object.  

 

ValidateCoupon 

This is the overview for the ValidateCoupon method overload.