API Documentation
\

\Oxws_Vouchers

Functions related to vouchers/coupons

Summary

Methods
Properties
Constants
getConfig()
getDb()
fetchCouponSeries()
fetchCouponCodes()
updateSentCouponCode()
No public properties found
No constants found
No protected methods found
$myConfig
$oDb
N/A
No private methods found
No private properties found
N/A

Properties

$myConfig

$myConfig : object

Config object

Type

object

$oDb

$oDb : object

Database object

Type

object

Methods

getConfig()

getConfig() : object

Function to get config object

Returns

object

getDb()

getDb() : object

Function to get database object

Returns

object

fetchCouponSeries()

fetchCouponSeries() : array

Function to fetch available coupon series and details

Returns

array

fetchCouponCodes()

fetchCouponCodes(string  $csOxid, integer  $limit = 1) : array

Function to fetch available coupon codes under a coupon series

Parameters

string $csOxid

oxid of the coupon series to fetch coupons
integer $limit

limit of coupons to be fetched (optional parameter)

Returns

array

updateSentCouponCode()

updateSentCouponCode(string  $couponCode) : boolean

Function to update status for the coupon code which was sent

Parameters

string $couponCode

coupon code to be updated as used

Returns

boolean