Class: CouponInsert

Request~CouponInsert(clientnullable, couponnullable)

Handles API Request Coupon_Insert. Scope: Store.

Constructor

new CouponInsert(clientnullable, couponnullable)

CouponInsert Constructor.

CouponInsert Constructor.

Parameters:
Name Type Attributes Default Description
client Client <nullable>
coupon Coupon <nullable>
 null
Source:
See:

Methods

createResponse() → {Response}

Create a response object from the response data.

Create a response object from the response data.

Source:
Returns:
Type
Response

getActive() → {boolean}

Get Active.

Get Active.

Source:
Returns:
Type
boolean

getCode() → {string}

Get Code.

Get Code.

Source:
Returns:
Type
string

getCustomerScope() → {string}

Get CustomerScope.

Get CustomerScope.

Source:
Returns:
Type
string

getDateTimeEnd() → {number}

Get DateTime_End.

Get DateTime_End.

Source:
Returns:
Type
number

getDateTimeStart() → {number}

Get DateTime_Start.

Get DateTime_Start.

Source:
Returns:
Type
number

getDescription() → {string}

Get Description.

Get Description.

Source:
Returns:
Type
string

getMaxPer() → {number}

Get Max_Per.

Get Max_Per.

Source:
Returns:
Type
number

getMaxUse() → {number}

Get Max_Use.

Get Max_Use.

Source:
Returns:
Type
number

getPriceGroupId() → {number}

Get PriceGroup_ID.

Get PriceGroup_ID.

Source:
Returns:
Type
number

setActive(active) → {CouponInsert}

Set Active.

Set Active.

Parameters:
Name Type Description
active boolean
Source:
Returns:
Type
CouponInsert

setCode(code) → {CouponInsert}

Set Code.

Set Code.

Parameters:
Name Type Description
code string
Source:
Returns:
Type
CouponInsert

setCustomerScope(customerScope) → {CouponInsert}

Set CustomerScope.

Set CustomerScope.

Parameters:
Name Type Description
customerScope string
Source:
Returns:
Type
CouponInsert

setDateTimeEnd(dateTimeEnd) → {CouponInsert}

Set DateTime_End.

Set DateTime_End.

Parameters:
Name Type Description
dateTimeEnd number | Date
Source:
Returns:
Type
CouponInsert

setDateTimeStart(dateTimeStart) → {CouponInsert}

Set DateTime_Start.

Set DateTime_Start.

Parameters:
Name Type Description
dateTimeStart number | Date
Source:
Returns:
Type
CouponInsert

setDescription(description) → {CouponInsert}

Set Description.

Set Description.

Parameters:
Name Type Description
description string
Source:
Returns:
Type
CouponInsert

setMaxPer(maxPer) → {CouponInsert}

Set Max_Per.

Set Max_Per.

Parameters:
Name Type Description
maxPer number
Source:
Returns:
Type
CouponInsert

setMaxUse(maxUse) → {CouponInsert}

Set Max_Use.

Set Max_Use.

Parameters:
Name Type Description
maxUse number
Source:
Returns:
Type
CouponInsert

setPriceGroupId(priceGroupId) → {CouponInsert}

Set PriceGroup_ID.

Set PriceGroup_ID.

Parameters:
Name Type Description
priceGroupId number
Source:
Returns:
Type
CouponInsert

toObject() → {Object}

Reduce the request to a an object.

Reduce the request to a an object.

Source:
Returns:
Type
Object