Class: Order

Model~Order(data) → {void}

Order data model.

Constructor

new Order(data) → {void}

Order Constructor.

Order Constructor.

Parameters:
Name Type Description
data Object
Source:
Returns:
Type
void

Members

(static, constant) ORDER_PAYMENT_STATUS_AUTHORIZED

Constant ORDER_PAYMENT_STATUS_AUTHORIZED

.

Constant ORDER_PAYMENT_STATUS_AUTHORIZED

Source:

(static, constant) ORDER_PAYMENT_STATUS_CAPTURED

Constant ORDER_PAYMENT_STATUS_CAPTURED

.

Constant ORDER_PAYMENT_STATUS_CAPTURED

Source:

(static, constant) ORDER_PAYMENT_STATUS_PARTIALLY_CAPTURED

Constant ORDER_PAYMENT_STATUS_PARTIALLY_CAPTURED

.

Constant ORDER_PAYMENT_STATUS_PARTIALLY_CAPTURED

Source:

(static, constant) ORDER_PAYMENT_STATUS_PENDING

Constant ORDER_PAYMENT_STATUS_PENDING

.

Constant ORDER_PAYMENT_STATUS_PENDING

Source:

(static, constant) ORDER_STATUS_BACKORDERED

Constant ORDER_STATUS_BACKORDERED

.

Constant ORDER_STATUS_BACKORDERED

Source:

(static, constant) ORDER_STATUS_CANCELLED

Constant ORDER_STATUS_CANCELLED

.

Constant ORDER_STATUS_CANCELLED

Source:

(static, constant) ORDER_STATUS_PARTIALLY_SHIPPED

Constant ORDER_STATUS_PARTIALLY_SHIPPED

.

Constant ORDER_STATUS_PARTIALLY_SHIPPED

Source:

(static, constant) ORDER_STATUS_PENDING

Constant ORDER_STATUS_PENDING

.

Constant ORDER_STATUS_PENDING

Source:

(static, constant) ORDER_STATUS_PROCESSING

Constant ORDER_STATUS_PROCESSING

.

Constant ORDER_STATUS_PROCESSING

Source:

(static, constant) ORDER_STATUS_RETURNED

Constant ORDER_STATUS_RETURNED

.

Constant ORDER_STATUS_RETURNED

Source:

(static, constant) ORDER_STATUS_RMA_ISSUED

Constant ORDER_STATUS_RMA_ISSUED

.

Constant ORDER_STATUS_RMA_ISSUED

Source:

(static, constant) ORDER_STATUS_SHIPPED

Constant ORDER_STATUS_SHIPPED

.

Constant ORDER_STATUS_SHIPPED

Source:

(static, constant) ORDER_STOCK_STATUS_AVAILABLE

Constant ORDER_STOCK_STATUS_AVAILABLE

.

Constant ORDER_STOCK_STATUS_AVAILABLE

Source:

(static, constant) ORDER_STOCK_STATUS_PARTIAL

Constant ORDER_STOCK_STATUS_PARTIAL

.

Constant ORDER_STOCK_STATUS_PARTIAL

Source:

(static, constant) ORDER_STOCK_STATUS_UNAVAILABLE

Constant ORDER_STOCK_STATUS_UNAVAILABLE

.

Constant ORDER_STOCK_STATUS_UNAVAILABLE

Source:

Methods

getBackorderCount() → {number}

Get bord_count.

Get bord_count.

Source:
Returns:
Type
number

getBatchId() → {number}

Get batch_id.

Get batch_id.

Source:
Returns:
Type
number

getBillAddress1() → {string}

Get bill_addr1.

Get bill_addr1.

Source:
Returns:
Type
string

getBillAddress2() → {string}

Get bill_addr2.

Get bill_addr2.

Source:
Returns:
Type
string

getBillCity() → {string}

Get bill_city.

Get bill_city.

Source:
Returns:
Type
string

getBillCompany() → {string}

Get bill_comp.

Get bill_comp.

Source:
Returns:
Type
string

getBillCountry() → {string}

Get bill_cntry.

Get bill_cntry.

Source:
Returns:
Type
string

getBillEmail() → {string}

Get bill_email.

Get bill_email.

Source:
Returns:
Type
string

getBillFax() → {string}

Get bill_fax.

Get bill_fax.

Source:
Returns:
Type
string

getBillFirstName() → {string}

Get bill_fname.

Get bill_fname.

Source:
Returns:
Type
string

getBillLastName() → {string}

Get bill_lname.

Get bill_lname.

Source:
Returns:
Type
string

getBillPhone() → {string}

Get bill_phone.

Get bill_phone.

Source:
Returns:
Type
string

getBillState() → {string}

Get bill_state.

Get bill_state.

Source:
Returns:
Type
string

getBillZip() → {string}

Get bill_zip.

Get bill_zip.

Source:
Returns:
Type
string

getBusinessTitle() → {string}

Get business_title.

Get business_title.

Source:
Returns:
Type
string

getCharges() → {Array.<OrderCharge>}

Get charges.

Get charges.

Source:
Returns:
Type
Array.<OrderCharge>

getCoupons() → {Array.<OrderCoupon>}

Get coupons.

Get coupons.

Source:
Returns:
Type
Array.<OrderCoupon>

getCustomer() → {Customer|*}

Get customer.

Get customer.

Source:
Returns:
Type
Customer | *

getCustomerId() → {number}

Get cust_id.

Get cust_id.

Source:
Returns:
Type
number

getCustomerLogin() → {string}

Get cust_login.

Get cust_login.

Source:
Returns:
Type
string

getCustomerPasswordEmail() → {string}

Get cust_pw_email.

Get cust_pw_email.

Source:
Returns:
Type
string

getCustomFieldValues() → {CustomFieldValues|*}

Get CustomField_Values.

Get CustomField_Values.

Source:
Returns:
Type
CustomFieldValues | *

getDateInStock() → {number}

Get dt_instock.

Get dt_instock.

Source:
Returns:
Type
number

getDiscounts() → {Array.<OrderDiscountTotal>}

Get discounts.

Get discounts.

Source:
Returns:
Type
Array.<OrderDiscountTotal>

getFormattedNetCaptured() → {string}

Get formatted_net_capt.

Get formatted_net_capt.

Source:
Returns:
Type
string

getFormattedTotal() → {string}

Get formatted_total.

Get formatted_total.

Source:
Returns:
Type
string

getFormattedTotalAuthorized() → {string}

Get formatted_total_auth.

Get formatted_total_auth.

Source:
Returns:
Type
string

getFormattedTotalCaptured() → {string}

Get formatted_total_capt.

Get formatted_total_capt.

Source:
Returns:
Type
string

getFormattedTotalRefunded() → {string}

Get formatted_total_rfnd.

Get formatted_total_rfnd.

Source:
Returns:
Type
string

getFormattedTotalShip() → {string}

Get formatted_total_ship.

Get formatted_total_ship.

Source:
Returns:
Type
string

getFormattedTotalTax() → {string}

Get formatted_total_tax.

Get formatted_total_tax.

Source:
Returns:
Type
string

getId() → {number}

Get id.

Get id.

Source:
Returns:
Type
number

getItems() → {Array.<OrderItem>}

Get items.

Get items.

Source:
Returns:
Type
Array.<OrderItem>

getNetCaptured() → {number}

Get net_capt.

Get net_capt.

Source:
Returns:
Type
number

getNoteCount() → {number}

Get note_count.

Get note_count.

Source:
Returns:
Type
number

getNotes() → {Array.<OrderNote>}

Get notes.

Get notes.

Source:
Returns:
Type
Array.<OrderNote>

getOrderDate() → {number}

Get orderdate.

Get orderdate.

Source:
Returns:
Type
number

getPaymentId() → {number}

Get pay_id.

Get pay_id.

Source:
Returns:
Type
number

getPaymentModule() → {string}

Get payment_module.

Get payment_module.

Source:
Returns:
Type
string

getPayments() → {Array.<OrderPayment>}

Get payments.

Get payments.

Source:
Returns:
Type
Array.<OrderPayment>

getPaymentStatus() → {number}

Get pay_status.

Get pay_status.

Source:
Returns:
Type
number

getPendingCount() → {number}

Get pend_count.

Get pend_count.

Source:
Returns:
Type
number

getShipAddress1() → {string}

Get ship_addr1.

Get ship_addr1.

Source:
Returns:
Type
string

getShipAddress2() → {string}

Get ship_addr2.

Get ship_addr2.

Source:
Returns:
Type
string

getShipCity() → {string}

Get ship_city.

Get ship_city.

Source:
Returns:
Type
string

getShipCompany() → {string}

Get ship_comp.

Get ship_comp.

Source:
Returns:
Type
string

getShipCountry() → {string}

Get ship_cntry.

Get ship_cntry.

Source:
Returns:
Type
string

getShipData() → {string}

Get ship_data.

Get ship_data.

Source:
Returns:
Type
string

getShipEmail() → {string}

Get ship_email.

Get ship_email.

Source:
Returns:
Type
string

getShipFax() → {string}

Get ship_fax.

Get ship_fax.

Source:
Returns:
Type
string

getShipFirstName() → {string}

Get ship_fname.

Get ship_fname.

Source:
Returns:
Type
string

getShipLastName() → {string}

Get ship_lname.

Get ship_lname.

Source:
Returns:
Type
string

getShipmentId() → {number}

Get ship_id.

Get ship_id.

Source:
Returns:
Type
number

getShipMethod() → {string}

Get ship_method.

Get ship_method.

Source:
Returns:
Type
string

getShipPhone() → {string}

Get ship_phone.

Get ship_phone.

Source:
Returns:
Type
string

getShipResidential() → {boolean}

Get ship_res.

Get ship_res.

Source:
Returns:
Type
boolean

getShipState() → {string}

Get ship_state.

Get ship_state.

Source:
Returns:
Type
string

getShipZip() → {string}

Get ship_zip.

Get ship_zip.

Source:
Returns:
Type
string

getSource() → {string}

Get source.

Get source.

Source:
Returns:
Type
string

getSourceId() → {number}

Get source_id.

Get source_id.

Source:
Returns:
Type
number

getStatus() → {number}

Get status.

Get status.

Source:
Returns:
Type
number

getStockStatus() → {number}

Get stk_status.

Get stk_status.

Source:
Returns:
Type
number

getTotal() → {number}

Get total.

Get total.

Source:
Returns:
Type
number

getTotalAuthorized() → {number}

Get total_auth.

Get total_auth.

Source:
Returns:
Type
number

getTotalCaptured() → {number}

Get total_capt.

Get total_capt.

Source:
Returns:
Type
number

getTotalRefunded() → {number}

Get total_rfnd.

Get total_rfnd.

Source:
Returns:
Type
number

getTotalShip() → {number}

Get total_ship.

Get total_ship.

Source:
Returns:
Type
number

getTotalTax() → {number}

Get total_tax.

Get total_tax.

Source:
Returns:
Type
number

setBillAddress1(billAddress1) → {Order}

Set bill_addr1.

Set bill_addr1.

Parameters:
Name Type Description
billAddress1 string
Source:
Returns:
Type
Order

setBillAddress2(billAddress2) → {Order}

Set bill_addr2.

Set bill_addr2.

Parameters:
Name Type Description
billAddress2 string
Source:
Returns:
Type
Order

setBillCity(billCity) → {Order}

Set bill_city.

Set bill_city.

Parameters:
Name Type Description
billCity string
Source:
Returns:
Type
Order

setBillCompany(billCompany) → {Order}

Set bill_comp.

Set bill_comp.

Parameters:
Name Type Description
billCompany string
Source:
Returns:
Type
Order

setBillCountry(billCountry) → {Order}

Set bill_cntry.

Set bill_cntry.

Parameters:
Name Type Description
billCountry string
Source:
Returns:
Type
Order

setBillEmail(billEmail) → {Order}

Set bill_email.

Set bill_email.

Parameters:
Name Type Description
billEmail string
Source:
Returns:
Type
Order

setBillFax(billFax) → {Order}

Set bill_fax.

Set bill_fax.

Parameters:
Name Type Description
billFax string
Source:
Returns:
Type
Order

setBillFirstName(billFirstName) → {Order}

Set bill_fname.

Set bill_fname.

Parameters:
Name Type Description
billFirstName string
Source:
Returns:
Type
Order

setBillLastName(billLastName) → {Order}

Set bill_lname.

Set bill_lname.

Parameters:
Name Type Description
billLastName string
Source:
Returns:
Type
Order

setBillPhone(billPhone) → {Order}

Set bill_phone.

Set bill_phone.

Parameters:
Name Type Description
billPhone string
Source:
Returns:
Type
Order

setBillState(billState) → {Order}

Set bill_state.

Set bill_state.

Parameters:
Name Type Description
billState string
Source:
Returns:
Type
Order

setBillZip(billZip) → {Order}

Set bill_zip.

Set bill_zip.

Parameters:
Name Type Description
billZip string
Source:
Returns:
Type
Order

setCustomerId(customerId) → {Order}

Set cust_id.

Set cust_id.

Parameters:
Name Type Description
customerId number
Source:
Returns:
Type
Order

setShipAddress1(shipAddress1) → {Order}

Set ship_addr1.

Set ship_addr1.

Parameters:
Name Type Description
shipAddress1 string
Source:
Returns:
Type
Order

setShipAddress2(shipAddress2) → {Order}

Set ship_addr2.

Set ship_addr2.

Parameters:
Name Type Description
shipAddress2 string
Source:
Returns:
Type
Order

setShipCity(shipCity) → {Order}

Set ship_city.

Set ship_city.

Parameters:
Name Type Description
shipCity string
Source:
Returns:
Type
Order

setShipCompany(shipCompany) → {Order}

Set ship_comp.

Set ship_comp.

Parameters:
Name Type Description
shipCompany string
Source:
Returns:
Type
Order

setShipCountry(shipCountry) → {Order}

Set ship_cntry.

Set ship_cntry.

Parameters:
Name Type Description
shipCountry string
Source:
Returns:
Type
Order

setShipEmail(shipEmail) → {Order}

Set ship_email.

Set ship_email.

Parameters:
Name Type Description
shipEmail string
Source:
Returns:
Type
Order

setShipFax(shipFax) → {Order}

Set ship_fax.

Set ship_fax.

Parameters:
Name Type Description
shipFax string
Source:
Returns:
Type
Order

setShipFirstName(shipFirstName) → {Order}

Set ship_fname.

Set ship_fname.

Parameters:
Name Type Description
shipFirstName string
Source:
Returns:
Type
Order

setShipLastName(shipLastName) → {Order}

Set ship_lname.

Set ship_lname.

Parameters:
Name Type Description
shipLastName string
Source:
Returns:
Type
Order

setShipPhone(shipPhone) → {Order}

Set ship_phone.

Set ship_phone.

Parameters:
Name Type Description
shipPhone string
Source:
Returns:
Type
Order

setShipState(shipState) → {Order}

Set ship_state.

Set ship_state.

Parameters:
Name Type Description
shipState string
Source:
Returns:
Type
Order

setShipZip(shipZip) → {Order}

Set ship_zip.

Set ship_zip.

Parameters:
Name Type Description
shipZip string
Source:
Returns:
Type
Order

toObject()

Source: