Search

Contents

Revindex Storefront

Export Print

Coupon

The coupon is a token used to trigger certain promotion rules such as giving a discount for purchases.

DeleteCoupon

This service is used to delete a Coupon object.

Request Parameters

Node Required Data Type Description
couponID Yes Integer The object identifier.

 

Return Data

None


GetCoupon

This service is used to query the Category object.

Request Parameters

Node Required Data Type Description
couponID Yes Integer The object identifier.

 

Return Data

Node Data Type Description
coupon XML Container node.
  active Boolean Flag to indicate if coupon is active and can be used.
  availabilityRule XML Rule The rule to describe the conditions when the coupon can be used.
  code String The coupon code.
  couponID Integer The object identifier.
  createDate DateTime Creation date.
  description XML Locale Localized description.
  inventory Integer The number of remaining inventory of coupons.
  portalID Integer  
  startDate DateTime The start date when the coupon is valid for using.
  stopDate DateTime The stop date the coupon is no longer valid for using.
  updateDate DateTime Update date.
 

 


GetCoupons

This service is used to get all the Coupon objects belonging to the portal.

Request Parameters

None

Return Data

Node Data Type Description
coupons XML Container node
  coupon XML Zero or more coupon nodes with same data structure as GetCoupon service return data.

 


InsertCoupon

This service is used to create a new Coupon object.

Request Parameters

Node Required Data Type Description
active Yes Boolean Flag to indicate if coupon is active and can be used.
availabilityRule No XML Rule The rule to describe the conditions when the coupon can be used.
code Yes String The coupon code must be unique across your portal.
description No XML Locale Localized description.
inventory No Integer The number of remaining inventory of coupons. Value must be greater or equal to zero.
startDate No DateTime The start date when the coupon is valid for using.
stopDate No DateTime The stop date the coupon is no longer valid for using.

 

Return Data

Same as GetCoupon service return data.


UpdateCoupon

This service is used to update a Coupon object.

Request Parameters

Node Required Data Type Description
active Yes Boolean Flag to indicate if coupon is active and can be used.
availabilityRule No XML Rule The rule to describe the conditions when the coupon can be used.
code Yes String The coupon code must be unique across your portal.
couponID Yes Integer The object identifier.
description No XML Locale Localized description.
inventory No Integer The number of remaining inventory of coupons. Value must be greater or equal to zero.
startDate No DateTime The start date when the coupon is valid for using.
stopDate No DateTime The stop date the coupon is no longer valid for using.

 

Return Data

Same as GetCoupon service return data.

 

 

Comments

Add comment

Powered by Revindex Wiki