Constructor
new OrderCreate(clientnullable, customernullable)
OrderCreate Constructor.
OrderCreate Constructor.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
client |
Client |
<nullable> |
||
customer |
Customer |
<nullable> |
null |
Methods
addCharge(charge) → {OrderCreate}
Add Charges.
Add Charges.
Parameters:
Name | Type | Description |
---|---|---|
charge |
OrderCharge |
- Source:
Throws:
Returns:
- Type
- OrderCreate
addCharges(charges) → {OrderCreate}
Add many OrderCharge.
Add many OrderCharge.
Parameters:
Name | Type | Description |
---|---|---|
charges |
Array.<OrderCharge> |
- Source:
Throws:
Returns:
- Type
- OrderCreate
addItem(item) → {OrderCreate}
Add Items.
Add Items.
Parameters:
Name | Type | Description |
---|---|---|
item |
OrderItem |
- Source:
Throws:
Returns:
- Type
- OrderCreate
addItems(items) → {OrderCreate}
Add many OrderItem.
Add many OrderItem.
Parameters:
Name | Type | Description |
---|---|---|
items |
Array.<OrderItem> |
- Source:
Throws:
Returns:
- Type
- OrderCreate
addProduct(product) → {OrderCreate}
Add Products.
Add Products.
Parameters:
Name | Type | Description |
---|---|---|
product |
OrderProduct |
- Source:
Throws:
Returns:
- Type
- OrderCreate
addProducts(products) → {OrderCreate}
Add many OrderProduct.
Add many OrderProduct.
Parameters:
Name | Type | Description |
---|---|---|
products |
Array.<OrderProduct> |
- Source:
Throws:
Returns:
- Type
- OrderCreate
createResponse() → {Response}
Create a response object from the response data.
Create a response object from the response data.
- Source:
Returns:
- Type
- Response
getBillAddress1() → {string}
Get BillAddress1.
Get BillAddress1.
- Source:
Returns:
- Type
- string
getBillAddress2() → {string}
Get BillAddress2.
Get BillAddress2.
- Source:
Returns:
- Type
- string
getBillCity() → {string}
Get BillCity.
Get BillCity.
- Source:
Returns:
- Type
- string
getBillCompany() → {string}
Get BillCompany.
Get BillCompany.
- Source:
Returns:
- Type
- string
getBillCountry() → {string}
Get BillCountry.
Get BillCountry.
- Source:
Returns:
- Type
- string
getBillEmail() → {string}
Get BillEmail.
Get BillEmail.
- Source:
Returns:
- Type
- string
getBillFax() → {string}
Get BillFax.
Get BillFax.
- Source:
Returns:
- Type
- string
getBillFirstName() → {string}
Get BillFirstName.
Get BillFirstName.
- Source:
Returns:
- Type
- string
getBillLastName() → {string}
Get BillLastName.
Get BillLastName.
- Source:
Returns:
- Type
- string
getBillPhone() → {string}
Get BillPhone.
Get BillPhone.
- Source:
Returns:
- Type
- string
getBillState() → {string}
Get BillState.
Get BillState.
- Source:
Returns:
- Type
- string
getBillZip() → {string}
Get BillZip.
Get BillZip.
- Source:
Returns:
- Type
- string
getCalculateCharges() → {boolean}
Get CalculateCharges.
Get CalculateCharges.
- Source:
Returns:
- Type
- boolean
getCharges() → {Array.<OrderCharge>}
Get Charges.
Get Charges.
- Source:
Returns:
- Type
- Array.<OrderCharge>
getCustomerId() → {number}
Get Customer_ID.
Get Customer_ID.
- Source:
Returns:
- Type
- number
getCustomerLogin() → {string}
Get Customer_Login.
Get Customer_Login.
- Source:
Returns:
- Type
- string
getCustomFieldValues() → (nullable) {CustomFieldValues}
Get CustomField_Values.
Get CustomField_Values.
- Source:
Returns:
- Type
- CustomFieldValues
getItems() → {Array.<OrderItem>}
Get Items.
Get Items.
- Source:
Returns:
- Type
- Array.<OrderItem>
getProducts() → {Array.<OrderProduct>}
Get Products.
Get Products.
- Source:
Returns:
- Type
- Array.<OrderProduct>
getShipAddress1() → {string}
Get ShipAddress1.
Get ShipAddress1.
- Source:
Returns:
- Type
- string
getShipAddress2() → {string}
Get ShipAddress2.
Get ShipAddress2.
- Source:
Returns:
- Type
- string
getShipCity() → {string}
Get ShipCity.
Get ShipCity.
- Source:
Returns:
- Type
- string
getShipCompany() → {string}
Get ShipCompany.
Get ShipCompany.
- Source:
Returns:
- Type
- string
getShipCountry() → {string}
Get ShipCountry.
Get ShipCountry.
- Source:
Returns:
- Type
- string
getShipEmail() → {string}
Get ShipEmail.
Get ShipEmail.
- Source:
Returns:
- Type
- string
getShipFax() → {string}
Get ShipFax.
Get ShipFax.
- Source:
Returns:
- Type
- string
getShipFirstName() → {string}
Get ShipFirstName.
Get ShipFirstName.
- Source:
Returns:
- Type
- string
getShipLastName() → {string}
Get ShipLastName.
Get ShipLastName.
- Source:
Returns:
- Type
- string
getShipPhone() → {string}
Get ShipPhone.
Get ShipPhone.
- Source:
Returns:
- Type
- string
getShippingModuleCode() → {string}
Get Shipping_Module_Code.
Get Shipping_Module_Code.
- Source:
Returns:
- Type
- string
getShippingModuleData() → {string}
Get Shipping_Module_Data.
Get Shipping_Module_Data.
- Source:
Returns:
- Type
- string
getShipResidential() → {boolean}
Get ShipResidential.
Get ShipResidential.
- Source:
Returns:
- Type
- boolean
getShipState() → {string}
Get ShipState.
Get ShipState.
- Source:
Returns:
- Type
- string
getShipZip() → {string}
Get ShipZip.
Get ShipZip.
- Source:
Returns:
- Type
- string
getTriggerFulfillmentModules() → {boolean}
Get TriggerFulfillmentModules.
Get TriggerFulfillmentModules.
- Source:
Returns:
- Type
- boolean
setBillAddress1(billAddress1) → {OrderCreate}
Set BillAddress1.
Set BillAddress1.
Parameters:
Name | Type | Description |
---|---|---|
billAddress1 |
string |
- Source:
Returns:
- Type
- OrderCreate
setBillAddress2(billAddress2) → {OrderCreate}
Set BillAddress2.
Set BillAddress2.
Parameters:
Name | Type | Description |
---|---|---|
billAddress2 |
string |
- Source:
Returns:
- Type
- OrderCreate
setBillCity(billCity) → {OrderCreate}
Set BillCity.
Set BillCity.
Parameters:
Name | Type | Description |
---|---|---|
billCity |
string |
- Source:
Returns:
- Type
- OrderCreate
setBillCompany(billCompany) → {OrderCreate}
Set BillCompany.
Set BillCompany.
Parameters:
Name | Type | Description |
---|---|---|
billCompany |
string |
- Source:
Returns:
- Type
- OrderCreate
setBillCountry(billCountry) → {OrderCreate}
Set BillCountry.
Set BillCountry.
Parameters:
Name | Type | Description |
---|---|---|
billCountry |
string |
- Source:
Returns:
- Type
- OrderCreate
setBillEmail(billEmail) → {OrderCreate}
Set BillEmail.
Set BillEmail.
Parameters:
Name | Type | Description |
---|---|---|
billEmail |
string |
- Source:
Returns:
- Type
- OrderCreate
setBillFax(billFax) → {OrderCreate}
Set BillFax.
Set BillFax.
Parameters:
Name | Type | Description |
---|---|---|
billFax |
string |
- Source:
Returns:
- Type
- OrderCreate
setBillFirstName(billFirstName) → {OrderCreate}
Set BillFirstName.
Set BillFirstName.
Parameters:
Name | Type | Description |
---|---|---|
billFirstName |
string |
- Source:
Returns:
- Type
- OrderCreate
setBillLastName(billLastName) → {OrderCreate}
Set BillLastName.
Set BillLastName.
Parameters:
Name | Type | Description |
---|---|---|
billLastName |
string |
- Source:
Returns:
- Type
- OrderCreate
setBillPhone(billPhone) → {OrderCreate}
Set BillPhone.
Set BillPhone.
Parameters:
Name | Type | Description |
---|---|---|
billPhone |
string |
- Source:
Returns:
- Type
- OrderCreate
setBillState(billState) → {OrderCreate}
Set BillState.
Set BillState.
Parameters:
Name | Type | Description |
---|---|---|
billState |
string |
- Source:
Returns:
- Type
- OrderCreate
setBillZip(billZip) → {OrderCreate}
Set BillZip.
Set BillZip.
Parameters:
Name | Type | Description |
---|---|---|
billZip |
string |
- Source:
Returns:
- Type
- OrderCreate
setCalculateCharges(calculateCharges) → {OrderCreate}
Set CalculateCharges.
Set CalculateCharges.
Parameters:
Name | Type | Description |
---|---|---|
calculateCharges |
boolean |
- Source:
Returns:
- Type
- OrderCreate
setCharges(charges) → {OrderCreate}
Set Charges.
Set Charges.
Parameters:
Name | Type | Description |
---|---|---|
charges |
Array.<OrderCharge> |
- Source:
Throws:
Returns:
- Type
- OrderCreate
setCustomerId(customerId) → {OrderCreate}
Set Customer_ID.
Set Customer_ID.
Parameters:
Name | Type | Description |
---|---|---|
customerId |
number |
- Source:
Returns:
- Type
- OrderCreate
setCustomerLogin(customerLogin) → {OrderCreate}
Set Customer_Login.
Set Customer_Login.
Parameters:
Name | Type | Description |
---|---|---|
customerLogin |
string |
- Source:
Returns:
- Type
- OrderCreate
setCustomFieldValues(customFieldValuesnullable) → {OrderCreate}
Set CustomField_Values.
Set CustomField_Values.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
customFieldValues |
CustomFieldValues |
<nullable> |
- Source:
Throws:
Returns:
- Type
- OrderCreate
setItems(items) → {OrderCreate}
Set Items.
Set Items.
Parameters:
Name | Type | Description |
---|---|---|
items |
Array.<OrderItem> |
- Source:
Throws:
Returns:
- Type
- OrderCreate
setProducts(products) → {OrderCreate}
Set Products.
Set Products.
Parameters:
Name | Type | Description |
---|---|---|
products |
Array.<OrderProduct> |
- Source:
Throws:
Returns:
- Type
- OrderCreate
setShipAddress1(shipAddress1) → {OrderCreate}
Set ShipAddress1.
Set ShipAddress1.
Parameters:
Name | Type | Description |
---|---|---|
shipAddress1 |
string |
- Source:
Returns:
- Type
- OrderCreate
setShipAddress2(shipAddress2) → {OrderCreate}
Set ShipAddress2.
Set ShipAddress2.
Parameters:
Name | Type | Description |
---|---|---|
shipAddress2 |
string |
- Source:
Returns:
- Type
- OrderCreate
setShipCity(shipCity) → {OrderCreate}
Set ShipCity.
Set ShipCity.
Parameters:
Name | Type | Description |
---|---|---|
shipCity |
string |
- Source:
Returns:
- Type
- OrderCreate
setShipCompany(shipCompany) → {OrderCreate}
Set ShipCompany.
Set ShipCompany.
Parameters:
Name | Type | Description |
---|---|---|
shipCompany |
string |
- Source:
Returns:
- Type
- OrderCreate
setShipCountry(shipCountry) → {OrderCreate}
Set ShipCountry.
Set ShipCountry.
Parameters:
Name | Type | Description |
---|---|---|
shipCountry |
string |
- Source:
Returns:
- Type
- OrderCreate
setShipEmail(shipEmail) → {OrderCreate}
Set ShipEmail.
Set ShipEmail.
Parameters:
Name | Type | Description |
---|---|---|
shipEmail |
string |
- Source:
Returns:
- Type
- OrderCreate
setShipFax(shipFax) → {OrderCreate}
Set ShipFax.
Set ShipFax.
Parameters:
Name | Type | Description |
---|---|---|
shipFax |
string |
- Source:
Returns:
- Type
- OrderCreate
setShipFirstName(shipFirstName) → {OrderCreate}
Set ShipFirstName.
Set ShipFirstName.
Parameters:
Name | Type | Description |
---|---|---|
shipFirstName |
string |
- Source:
Returns:
- Type
- OrderCreate
setShipLastName(shipLastName) → {OrderCreate}
Set ShipLastName.
Set ShipLastName.
Parameters:
Name | Type | Description |
---|---|---|
shipLastName |
string |
- Source:
Returns:
- Type
- OrderCreate
setShipPhone(shipPhone) → {OrderCreate}
Set ShipPhone.
Set ShipPhone.
Parameters:
Name | Type | Description |
---|---|---|
shipPhone |
string |
- Source:
Returns:
- Type
- OrderCreate
setShippingModuleCode(shippingModuleCode) → {OrderCreate}
Set Shipping_Module_Code.
Set Shipping_Module_Code.
Parameters:
Name | Type | Description |
---|---|---|
shippingModuleCode |
string |
- Source:
Returns:
- Type
- OrderCreate
setShippingModuleData(shippingModuleData) → {OrderCreate}
Set Shipping_Module_Data.
Set Shipping_Module_Data.
Parameters:
Name | Type | Description |
---|---|---|
shippingModuleData |
string |
- Source:
Returns:
- Type
- OrderCreate
setShipResidential(shipResidential) → {OrderCreate}
Set ShipResidential.
Set ShipResidential.
Parameters:
Name | Type | Description |
---|---|---|
shipResidential |
boolean |
- Source:
Returns:
- Type
- OrderCreate
setShipState(shipState) → {OrderCreate}
Set ShipState.
Set ShipState.
Parameters:
Name | Type | Description |
---|---|---|
shipState |
string |
- Source:
Returns:
- Type
- OrderCreate
setShipZip(shipZip) → {OrderCreate}
Set ShipZip.
Set ShipZip.
Parameters:
Name | Type | Description |
---|---|---|
shipZip |
string |
- Source:
Returns:
- Type
- OrderCreate
setTriggerFulfillmentModules(triggerFulfillmentModules) → {OrderCreate}
Set TriggerFulfillmentModules.
Set TriggerFulfillmentModules.
Parameters:
Name | Type | Description |
---|---|---|
triggerFulfillmentModules |
boolean |
- Source:
Returns:
- Type
- OrderCreate
toObject() → {Object}
Reduce the request to a an object.
Reduce the request to a an object.
- Source:
Returns:
- Type
- Object