Constructor
new Order(data) → {void}
Order Constructor.
Order Constructor.
Parameters:
Name | Type | Description |
---|---|---|
data |
Object |
Returns:
- Type
- void
Members
(static, constant) ORDER_PAYMENT_STATUS_AUTHORIZED
Constant ORDER_PAYMENT_STATUS_AUTHORIZED
.Constant ORDER_PAYMENT_STATUS_AUTHORIZED
(static, constant) ORDER_PAYMENT_STATUS_CAPTURED
Constant ORDER_PAYMENT_STATUS_CAPTURED
.Constant ORDER_PAYMENT_STATUS_CAPTURED
(static, constant) ORDER_PAYMENT_STATUS_PARTIALLY_CAPTURED
Constant ORDER_PAYMENT_STATUS_PARTIALLY_CAPTURED
.Constant ORDER_PAYMENT_STATUS_PARTIALLY_CAPTURED
(static, constant) ORDER_PAYMENT_STATUS_PENDING
Constant ORDER_PAYMENT_STATUS_PENDING
.Constant ORDER_PAYMENT_STATUS_PENDING
(static, constant) ORDER_STATUS_BACKORDERED
Constant ORDER_STATUS_BACKORDERED
.Constant ORDER_STATUS_BACKORDERED
(static, constant) ORDER_STATUS_CANCELLED
Constant ORDER_STATUS_CANCELLED
.Constant ORDER_STATUS_CANCELLED
(static, constant) ORDER_STATUS_PARTIALLY_SHIPPED
Constant ORDER_STATUS_PARTIALLY_SHIPPED
.Constant ORDER_STATUS_PARTIALLY_SHIPPED
(static, constant) ORDER_STATUS_PENDING
Constant ORDER_STATUS_PENDING
.Constant ORDER_STATUS_PENDING
(static, constant) ORDER_STATUS_PROCESSING
Constant ORDER_STATUS_PROCESSING
.Constant ORDER_STATUS_PROCESSING
(static, constant) ORDER_STATUS_RETURNED
Constant ORDER_STATUS_RETURNED
.Constant ORDER_STATUS_RETURNED
(static, constant) ORDER_STATUS_RMA_ISSUED
Constant ORDER_STATUS_RMA_ISSUED
.Constant ORDER_STATUS_RMA_ISSUED
(static, constant) ORDER_STATUS_SHIPPED
Constant ORDER_STATUS_SHIPPED
.Constant ORDER_STATUS_SHIPPED
(static, constant) ORDER_STOCK_STATUS_AVAILABLE
Constant ORDER_STOCK_STATUS_AVAILABLE
.Constant ORDER_STOCK_STATUS_AVAILABLE
(static, constant) ORDER_STOCK_STATUS_PARTIAL
Constant ORDER_STOCK_STATUS_PARTIAL
.Constant ORDER_STOCK_STATUS_PARTIAL
(static, constant) ORDER_STOCK_STATUS_UNAVAILABLE
Constant ORDER_STOCK_STATUS_UNAVAILABLE
.Constant ORDER_STOCK_STATUS_UNAVAILABLE
Methods
getBackorderCount() → {number}
Get bord_count.
Get bord_count.
Returns:
- Type
- number
getBatchId() → {number}
Get batch_id.
Get batch_id.
Returns:
- Type
- number
getBillAddress1() → {string}
Get bill_addr1.
Get bill_addr1.
Returns:
- Type
- string
getBillAddress2() → {string}
Get bill_addr2.
Get bill_addr2.
Returns:
- Type
- string
getBillCity() → {string}
Get bill_city.
Get bill_city.
Returns:
- Type
- string
getBillCompany() → {string}
Get bill_comp.
Get bill_comp.
Returns:
- Type
- string
getBillCountry() → {string}
Get bill_cntry.
Get bill_cntry.
Returns:
- Type
- string
getBillEmail() → {string}
Get bill_email.
Get bill_email.
Returns:
- Type
- string
getBillFax() → {string}
Get bill_fax.
Get bill_fax.
Returns:
- Type
- string
getBillFirstName() → {string}
Get bill_fname.
Get bill_fname.
Returns:
- Type
- string
getBillLastName() → {string}
Get bill_lname.
Get bill_lname.
Returns:
- Type
- string
getBillPhone() → {string}
Get bill_phone.
Get bill_phone.
Returns:
- Type
- string
getBillState() → {string}
Get bill_state.
Get bill_state.
Returns:
- Type
- string
getBillZip() → {string}
Get bill_zip.
Get bill_zip.
Returns:
- Type
- string
getBusinessTitle() → {string}
Get business_title.
Get business_title.
Returns:
- Type
- string
getCharges() → {Array.<OrderCharge>}
Get charges.
Get charges.
Returns:
- Type
- Array.<OrderCharge>
getCoupons() → {Array.<OrderCoupon>}
Get coupons.
Get coupons.
Returns:
- Type
- Array.<OrderCoupon>
getCustomer() → {Customer|*}
Get customer.
Get customer.
Returns:
- Type
- Customer | *
getCustomerId() → {number}
Get cust_id.
Get cust_id.
Returns:
- Type
- number
getCustomerLogin() → {string}
Get cust_login.
Get cust_login.
Returns:
- Type
- string
getCustomerPasswordEmail() → {string}
Get cust_pw_email.
Get cust_pw_email.
Returns:
- Type
- string
getCustomFieldValues() → {CustomFieldValues|*}
Get CustomField_Values.
Get CustomField_Values.
Returns:
- Type
- CustomFieldValues | *
getDateInStock() → {number}
Get dt_instock.
Get dt_instock.
Returns:
- Type
- number
getDiscounts() → {Array.<OrderDiscountTotal>}
Get discounts.
Get discounts.
Returns:
- Type
- Array.<OrderDiscountTotal>
getFormattedNetCaptured() → {string}
Get formatted_net_capt.
Get formatted_net_capt.
Returns:
- Type
- string
getFormattedTotal() → {string}
Get formatted_total.
Get formatted_total.
Returns:
- Type
- string
getFormattedTotalAuthorized() → {string}
Get formatted_total_auth.
Get formatted_total_auth.
Returns:
- Type
- string
getFormattedTotalCaptured() → {string}
Get formatted_total_capt.
Get formatted_total_capt.
Returns:
- Type
- string
getFormattedTotalRefunded() → {string}
Get formatted_total_rfnd.
Get formatted_total_rfnd.
Returns:
- Type
- string
getFormattedTotalShip() → {string}
Get formatted_total_ship.
Get formatted_total_ship.
Returns:
- Type
- string
getFormattedTotalTax() → {string}
Get formatted_total_tax.
Get formatted_total_tax.
Returns:
- Type
- string
getId() → {number}
Get id.
Get id.
Returns:
- Type
- number
getItems() → {Array.<OrderItem>}
Get items.
Get items.
Returns:
- Type
- Array.<OrderItem>
getNetCaptured() → {number}
Get net_capt.
Get net_capt.
Returns:
- Type
- number
getNoteCount() → {number}
Get note_count.
Get note_count.
Returns:
- Type
- number
getNotes() → {Array.<OrderNote>}
Get notes.
Get notes.
Returns:
- Type
- Array.<OrderNote>
getOrderDate() → {number}
Get orderdate.
Get orderdate.
Returns:
- Type
- number
getPaymentId() → {number}
Get pay_id.
Get pay_id.
Returns:
- Type
- number
getPaymentModule() → {string}
Get payment_module.
Get payment_module.
Returns:
- Type
- string
getPayments() → {Array.<OrderPayment>}
Get payments.
Get payments.
Returns:
- Type
- Array.<OrderPayment>
getPaymentStatus() → {number}
Get pay_status.
Get pay_status.
Returns:
- Type
- number
getPendingCount() → {number}
Get pend_count.
Get pend_count.
Returns:
- Type
- number
getShipAddress1() → {string}
Get ship_addr1.
Get ship_addr1.
Returns:
- Type
- string
getShipAddress2() → {string}
Get ship_addr2.
Get ship_addr2.
Returns:
- Type
- string
getShipCity() → {string}
Get ship_city.
Get ship_city.
Returns:
- Type
- string
getShipCompany() → {string}
Get ship_comp.
Get ship_comp.
Returns:
- Type
- string
getShipCountry() → {string}
Get ship_cntry.
Get ship_cntry.
Returns:
- Type
- string
getShipData() → {string}
Get ship_data.
Get ship_data.
Returns:
- Type
- string
getShipEmail() → {string}
Get ship_email.
Get ship_email.
Returns:
- Type
- string
getShipFax() → {string}
Get ship_fax.
Get ship_fax.
Returns:
- Type
- string
getShipFirstName() → {string}
Get ship_fname.
Get ship_fname.
Returns:
- Type
- string
getShipLastName() → {string}
Get ship_lname.
Get ship_lname.
Returns:
- Type
- string
getShipmentId() → {number}
Get ship_id.
Get ship_id.
Returns:
- Type
- number
getShipMethod() → {string}
Get ship_method.
Get ship_method.
Returns:
- Type
- string
getShipPhone() → {string}
Get ship_phone.
Get ship_phone.
Returns:
- Type
- string
getShipResidential() → {boolean}
Get ship_res.
Get ship_res.
Returns:
- Type
- boolean
getShipState() → {string}
Get ship_state.
Get ship_state.
Returns:
- Type
- string
getShipZip() → {string}
Get ship_zip.
Get ship_zip.
Returns:
- Type
- string
getSource() → {string}
Get source.
Get source.
Returns:
- Type
- string
getSourceId() → {number}
Get source_id.
Get source_id.
Returns:
- Type
- number
getStatus() → {number}
Get status.
Get status.
Returns:
- Type
- number
getStockStatus() → {number}
Get stk_status.
Get stk_status.
Returns:
- Type
- number
getTotal() → {number}
Get total.
Get total.
Returns:
- Type
- number
getTotalAuthorized() → {number}
Get total_auth.
Get total_auth.
Returns:
- Type
- number
getTotalCaptured() → {number}
Get total_capt.
Get total_capt.
Returns:
- Type
- number
getTotalRefunded() → {number}
Get total_rfnd.
Get total_rfnd.
Returns:
- Type
- number
getTotalShip() → {number}
Get total_ship.
Get total_ship.
Returns:
- Type
- number
getTotalTax() → {number}
Get total_tax.
Get total_tax.
Returns:
- Type
- number
setBillAddress1(billAddress1) → {Order}
Set bill_addr1.
Set bill_addr1.
Parameters:
Name | Type | Description |
---|---|---|
billAddress1 |
string |
Returns:
- Type
- Order
setBillAddress2(billAddress2) → {Order}
Set bill_addr2.
Set bill_addr2.
Parameters:
Name | Type | Description |
---|---|---|
billAddress2 |
string |
Returns:
- Type
- Order
setBillCity(billCity) → {Order}
Set bill_city.
Set bill_city.
Parameters:
Name | Type | Description |
---|---|---|
billCity |
string |
Returns:
- Type
- Order
setBillCompany(billCompany) → {Order}
Set bill_comp.
Set bill_comp.
Parameters:
Name | Type | Description |
---|---|---|
billCompany |
string |
Returns:
- Type
- Order
setBillCountry(billCountry) → {Order}
Set bill_cntry.
Set bill_cntry.
Parameters:
Name | Type | Description |
---|---|---|
billCountry |
string |
Returns:
- Type
- Order
setBillEmail(billEmail) → {Order}
Set bill_email.
Set bill_email.
Parameters:
Name | Type | Description |
---|---|---|
billEmail |
string |
Returns:
- Type
- Order
setBillFax(billFax) → {Order}
Set bill_fax.
Set bill_fax.
Parameters:
Name | Type | Description |
---|---|---|
billFax |
string |
Returns:
- Type
- Order
setBillFirstName(billFirstName) → {Order}
Set bill_fname.
Set bill_fname.
Parameters:
Name | Type | Description |
---|---|---|
billFirstName |
string |
Returns:
- Type
- Order
setBillLastName(billLastName) → {Order}
Set bill_lname.
Set bill_lname.
Parameters:
Name | Type | Description |
---|---|---|
billLastName |
string |
Returns:
- Type
- Order
setBillPhone(billPhone) → {Order}
Set bill_phone.
Set bill_phone.
Parameters:
Name | Type | Description |
---|---|---|
billPhone |
string |
Returns:
- Type
- Order
setBillState(billState) → {Order}
Set bill_state.
Set bill_state.
Parameters:
Name | Type | Description |
---|---|---|
billState |
string |
Returns:
- Type
- Order
setBillZip(billZip) → {Order}
Set bill_zip.
Set bill_zip.
Parameters:
Name | Type | Description |
---|---|---|
billZip |
string |
Returns:
- Type
- Order
setCustomerId(customerId) → {Order}
Set cust_id.
Set cust_id.
Parameters:
Name | Type | Description |
---|---|---|
customerId |
number |
Returns:
- Type
- Order
setShipAddress1(shipAddress1) → {Order}
Set ship_addr1.
Set ship_addr1.
Parameters:
Name | Type | Description |
---|---|---|
shipAddress1 |
string |
Returns:
- Type
- Order
setShipAddress2(shipAddress2) → {Order}
Set ship_addr2.
Set ship_addr2.
Parameters:
Name | Type | Description |
---|---|---|
shipAddress2 |
string |
Returns:
- Type
- Order
setShipCity(shipCity) → {Order}
Set ship_city.
Set ship_city.
Parameters:
Name | Type | Description |
---|---|---|
shipCity |
string |
Returns:
- Type
- Order
setShipCompany(shipCompany) → {Order}
Set ship_comp.
Set ship_comp.
Parameters:
Name | Type | Description |
---|---|---|
shipCompany |
string |
Returns:
- Type
- Order
setShipCountry(shipCountry) → {Order}
Set ship_cntry.
Set ship_cntry.
Parameters:
Name | Type | Description |
---|---|---|
shipCountry |
string |
Returns:
- Type
- Order
setShipEmail(shipEmail) → {Order}
Set ship_email.
Set ship_email.
Parameters:
Name | Type | Description |
---|---|---|
shipEmail |
string |
Returns:
- Type
- Order
setShipFax(shipFax) → {Order}
Set ship_fax.
Set ship_fax.
Parameters:
Name | Type | Description |
---|---|---|
shipFax |
string |
Returns:
- Type
- Order
setShipFirstName(shipFirstName) → {Order}
Set ship_fname.
Set ship_fname.
Parameters:
Name | Type | Description |
---|---|---|
shipFirstName |
string |
Returns:
- Type
- Order
setShipLastName(shipLastName) → {Order}
Set ship_lname.
Set ship_lname.
Parameters:
Name | Type | Description |
---|---|---|
shipLastName |
string |
Returns:
- Type
- Order
setShipPhone(shipPhone) → {Order}
Set ship_phone.
Set ship_phone.
Parameters:
Name | Type | Description |
---|---|---|
shipPhone |
string |
Returns:
- Type
- Order
setShipState(shipState) → {Order}
Set ship_state.
Set ship_state.
Parameters:
Name | Type | Description |
---|---|---|
shipState |
string |
Returns:
- Type
- Order
setShipZip(shipZip) → {Order}
Set ship_zip.
Set ship_zip.
Parameters:
Name | Type | Description |
---|---|---|
shipZip |
string |
Returns:
- Type
- Order