ESDRecordOrderSale Class |
Namespace: EcommerceStandardsDocuments
The ESDRecordOrderSale type exposes the following members.
Name | Description | |
---|---|---|
ESDRecordOrderSale | constructor |
Name | Description | |
---|---|---|
accountDiscountRate | Percentage rate discounted off the order monetary total based on the discount assigned to the order's customer account. | |
accountTerritory | Territory associated with the customer account | |
billingAddress1 | First address field associated with the billing of the order. | |
billingAddress2 | Second address field associated with the billing of the order. | |
billingAddress3 | Third address field associated with the billing of the order. | |
billingContact | Name of the contact person at the address associated with the billing of the order. | |
billingCountryCodeISO2 | Code of the country of the address associated with the billing of the order as a two digit code set by the ISO standards. | |
billingCountryCodeISO3 | Code of the country of the address associated with the billing of the order as a three digit code set by the ISO standards. | |
billingCountryName | Name of the country of the address associated with the billing of the order. | |
billingDescription | Description of the address associated with the billing of the order. | |
billingEmail | Email address at the address associated with the billing of the order. | |
billingFax | Fax number at the address associated with the billing of the order. | |
billingOrgName | Name of the organisation that the orders goods are being billing to | |
billingPhone | Phone number at the address associated with the billing of the order. | |
billingPostcode | Postcode of the address associated with the billing of the order. | |
billingRegionName | Name of the region/state/province of the address associated with the billing of the order. | |
createdDate | Date that the order was created. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone | |
currencyISOCode | Currency that all monetary amounts of the order are set with. This currency code must be the 3 digit ISO currency code. | |
customerAccountCode | Code of the customer account, may or not be a unique identifier of the account. | |
customerAccountName | Name of the customer account | |
customerAuthorityNumberLabels | list of Labels set for the customer authority numbers. Ensure that the array length is the same as the authorityNumbers property, or left empty | |
customerAuthorityNumbers | Authority numbers of the customer of the order. | |
customerAuthorityNumberTypes | list of authority number types matching the customer authority numbers. If set, must use the ESDocumentConstants that are prefixed with "AUTHORITY_NUM_". Ensure that the array length is the same as the authorityNumbers property, or left empty. | |
customerEntity | Customer entity buying the order. Set it to one of the constants in the ESDocumentConstants class prefixed with ENTITY_TYPE_ | |
customerOrgName | Name of the organisation who is the customer of the order. | |
customerPersonName | Name of the person who is the customer of the order. | |
deliveryAddress1 | First delivery address field that the ordered goods are being delivered to | |
deliveryAddress2 | Second delivery address field that the ordered goods are being delivered to | |
deliveryAddress3 | Third delivery address field that the ordered goods are being delivered to | |
deliveryContact | Name of the contact person at the address that the ordered goods are being delivered to | |
deliveryCountryCodeISO2 | Code of the country at the address that the ordered goods are being delivered to as a 2 digit code set by ISO standards. | |
deliveryCountryCodeISO3 | Code of the country at the address that the ordered goods are being delivered to as a 3 digit code set by ISO standards. | |
deliveryCountryName | Name of the country at the address that the ordered goods are being delivered to | |
deliveryDescription | Description of the address that the ordered goods are being delivered to | |
deliveryEmail | Email of the contact person at the address that the ordered goods are being delivered to | |
deliveryFax | Fax number at the address that the ordered goods are being delivered to | |
deliveryOrgName | Name of the organisation that the orders goods are being delivered to | |
deliveryPhone | Phone number at the address that the ordered goods are being delivered to | |
deliveryPostcode | Post code of the address that the ordered goods are being delivered to | |
deliveryPurchaseOrderCode | Code of the purchase order to include in the delivery information, that is contains the code of the purchase order relevant to the delivery receiver | |
deliveryRegionName | Name of the region/state/province at the address that the ordered goods are being delivered to | |
dispatchedDate | Date that the order's goods were sent out. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone | |
drop | Data Record OPeration. Denotes an operation that may need to be performed on the record when it is being processed.
Set null, or set it to one of the ESD_RECORD_OPERATION constants in the ESDocumentConstants class to allow the record to be inserted, updated, deleted, or ignored. | |
eCommerceSystemID | ID of the associated Ecommerce system where the order was created. Ideally each system sets its own unique identifier, formatted such as ORG_NAME.SYSTEM_NAME | |
eCommerceUserID | ID of the user in the associated Ecommerce system where the order was created. | |
eCommerceUserName | Name of the user in the associated Ecommerce system where the order was created. Ideally this is set to a label of the user, and not the credentials used for a user to login (since that could be a security issue passing around such information). | |
Email address set for the order. | ||
externalKeyLocationID | key of the external location where the products for the order can be found. This external location may be the location where goods are being delivered to or held at. | |
externalLocationCode | Code of the external location. This external location may be the location where goods are being delivered to or held at. | |
externalLocationName | Name of the external location. This external location may be the location where goods are being delivered to or held at. | |
freightCarrierAccountCode | Code of the account in the freight carrier's system | |
freightCarrierCode | Code of the freight carrier delivering the ordered goods | |
freightCarrierConsignCode | Consignment code issued by the freight carrier to delivery the ordered goods | |
freightCarrierName | Name of the freight carrier delivering the orders goods | |
freightCarrierServiceCode | Code of the service provided by the freight carrier to deliver the ordered goods | |
freightCarrierTrackingCode | Code to track the freight carrier delivering the ordered goods | |
freightSystemRefCode | Reference code to the system used to process the freight order | |
instructions | Text describing instructions on how to handle the order. | |
internalID | Stores an identifier that is relevant only to the system referencing and storing the record for its own needs. | |
isDropship | Either 'N'-No or
'Y'-Yes
If 'Y' then indicates that the order is being supplied by a different entity from supplier assigned to the order.
| |
isMultiLocation | Either 'N'-No or
'Y'-Yes
If 'Y' then indicates that the ordered goods are to be obtained across multiple locations.
| |
isProductsDelivered | Either 'N'-No or
'Y'-Yes
If 'Y' then indicates that all products for the order have been delivered.
| |
keyCustomerAccountID | Key of the customer account record that is assigned to the order. The customer indicates the purchaser of the order. | |
keyLocationID | key of the location where the products for the order can be found. | |
keyPaymentTypeID | Key of the payment type record that is associated to the payment. The payment type record indicates how the payment was made for the order. | |
keySalesOrderID | Key that allows the sale order record to be uniquely identified and linked to. | |
keySalesRepID | Key of the sales representative record linked to the order. | |
lines | List of lines set to the order | |
locationCode | Code of the location that the order's products are to be picked/packed/delivered/managed from by default. | |
locationName | Name of the location that the order's products are to be picked/packed/delivered/managed from by default. | |
modifiedDate | Date that the order was last modified. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone | |
paymentAmount | Monetary amount already paid for the order. | |
paymentMethod | Method on how the order is being paid for. The field must be set to one of the class's constants prefixed by PAYMENT_METHOD_ | |
paymentProprietaryCode | Code the proprietary system that is used as the payment method for the order. | |
paymentReceipt | Number that contains a reference to the payment applied against the order | |
payments | List of payments set to the order | |
paymentStatus | Status indicating how the order has been paid for. Set it to one of the constants in the class prefixed with PAYMENT_STATUS_ | |
processedDate | Date that the order was processed. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone | |
purchaseOrderNumber | Number of the purchase order that may be associated to the sales order. This may be used for referencing purposes. | |
purchaserSystemCode | Code of the system that the purchasing entity stores its data within. | |
purchaserSystemID | ID of the system that the purchasing entity stores its data within. | |
purchaserSystemName | Name of the system that the purchasing entity stores its data within. | |
receivedDate | Date that the order's goods were received by the purchaser. Date is in the form of a number in milliseconds since the 01-01-1970 12:00am Epoch in UTC time-zone | |
salesOrderCode | Code of the sales order, may or may not be a unqiue indentifier | |
salesOrderNumber | Number of the sales order, may or may not be a unique identifier | |
salesRepCode | Code of the sales representative. | |
salesRepIndividual | Either 'N'-No or
'Y'-Yes
If 'Y' then indicates that the sales representative is an individual person.
| |
salesRepName | Name of the sales representative. | |
sellerSystemCode | Code of the system that the selling entity stores its data within. | |
sellerSystemID | ID of the system that the selling entity stores its data within. | |
sellerSystemName | Name of the system that the selling entity stores its data within. | |
sentDate | Date that the order was sent | |
shippingMethod | Either 'N'-No or
'Y'-Yes
If 'Y' then indicates that the ordered goods are to be obtained across multiple locations.
| |
surcharges | List of surcharge lines set to the order | |
totalDownloads | Total number of download lines in the order | |
totalLabour | Total number of labour lines in the order | |
totalLines | Total number of lines in the order. | |
totalPriceExTax | Total monetary price of the order exclusive of tax | |
totalPriceIncTax | Total monetary price of the order inclusive of tax | |
totalPriceUndiscountedExTax | Total monetary amount of the order before discounts were applied, exclusive of taxes. This amount may be useful when showing discounts applied to an order. | |
totalPriceUndiscountedIncTax | Total monetary amount of the order before discounts were applied, inclusive of taxes. This amount may be useful when showing discounts applied to an order. | |
totalPriceUndiscountedTax | Total monetary amount of taxes applied to the order before discounts were applied. This amount may be useful when showing discounts applied to an order. | |
totalProducts | Total number of product lines in the order | |
totalSurchargeExTax | Total monetary amount of surcharges applied to the order exclusive of taxes | |
totalSurchargeIncTax | Total monetary amount of surcharges applied to the order inclusive of taxes | |
totalSurchargeItems | Total number of surcharges applied to the order | |
totalSurchargeTax | Total monetary amount of taxes applied to surcharges in the order | |
totalTax | Total monetary amount of taxes applied to the order | |
totalVolume | Total volume of the ordered goods | |
totalVolumeMeasureCode | Code of the unit of measure for the volume. Set it to a constant prefixed with UNIT_MEASURE_VOLUME_ in the ESDocumentConstants class | |
totalWeight | Total weight of the ordered goods | |
totalWeightMeasureCode | Code of the unit of measure for the weight. Set it to a constant prefixed with UNIT_MEASURE_MASS_ in the ESDocumentConstants class |
Name | Description | |
---|---|---|
convertToCustomerAccountEnquiryOrderSaleRecord | Converts the order sale record into a customer account enquiry order sale record | |
setDefaultValuesForNullMembers | sets default values for members that have no values set |
Name | Description | |
---|---|---|
invoiceNumbers | List of the invoice numbers linked to this sales order. | |
PAYMENT_METHOD_ACCOUNT | ACCOUNT - A payment will be assigned to a customer account and paid based on the agreed payment terms | |
PAYMENT_METHOD_CASHONDELIVERY | COD - Payment will be made with cash when the goods are delivered to the delivery location | |
PAYMENT_METHOD_CREDIT | CREDITCARD - A payment was made with a credit card | |
PAYMENT_METHOD_DIRECTDEPOSIT | DIRECTDEPOSIT - Payment has been made with a direct bank transfer | |
PAYMENT_METHOD_NONE | NONE - No payment was made or needed | |
PAYMENT_METHOD_PROPRIETARY | PROPRIETARY - A payment was made using a proprietary payment system. PayPal could be one example of this. | |
PAYMENT_METHOD_QUOTE | QUOTE - No payment was made as a quote was only required | |
PAYMENT_METHOD_UNPAID | UNPAID - No payment was received as yet | |
PAYMENT_STATUS_DECLINED | DECLINED - A payment failed when trying to be paid | |
PAYMENT_STATUS_NONREQUIRED | NONREQUIRED - No payment is required to pay for the order | |
PAYMENT_STATUS_PAID | PAID - The order has been paid | |
PAYMENT_STATUS_PENDING | PENDING - A payment is currently in the process of being paid for, or is waiting on a process to complete | |
PAYMENT_STATUS_UNPAID | UNPAID - The order has not been paid for |