Click or drag to resize
ESDocumentOrderSale Class
Ecommerce standards document that contains a list of sales order records
Inheritance Hierarchy
SystemObject
  EcommerceStandardsDocumentsESDocument
    EcommerceStandardsDocumentsESDocumentOrderSale

Namespace: EcommerceStandardsDocuments
Assembly: EcommerceStandardsDocuments.Library (in EcommerceStandardsDocuments.Library.dll) Version: 1.2.0.0 (1.0.0.0)

The ESDocumentOrderSale type exposes the following members.

Constructors
  NameDescription
Public methodESDocumentOrderSale
Constructor
Top
Fields
  NameDescription
Public fieldconfigs
A dictionary of additional configurations and settings to include with each Ecommerce Standard Document. Typically documents would contain the "dataFields" key that would have a comma delimited list of record properties that are expected to contain data when reading the document's records. Any records not containing data for properties in list could then have the data set to a default when saved to a database.
(Inherited from ESDocument.)
Public fielddataRecords
List of sales order records
Public fielddataTransferMode
Denotes if the data being placed into document is a complete data set, or partial data being transferred containing only data changes.
(Inherited from ESDocument.)
Public fieldmessage
Message providing details of if the data could be obtained when requesting the document. The message gives meaning to the result status.
(Inherited from ESDocument.)
Public fieldresultStatus
Code that denotes if the data could be successfully obtained for the document, and if not why. See ESDocumentConstants Class for the list of status codes
(Inherited from ESDocument.)
Public fieldtotalDataRecords
The total number of records placed within document. For documents that contain multiple record lists, please check the relevant documentation to see how this number applies.
(Inherited from ESDocument.)
Public fieldversion
Version of the Ecommerce Standards Document. Verifying the version of the document is critical for systems transferring and manipulating the data.
(Inherited from ESDocument.)
Top
Examples
An example of the Order Sale Ecommerce Standards document in its JSON serialised form
{
    "version": 1.2,
    "resultStatus": 1,
    "message":"The sales order data has been successfully obtained.",
    "dataTransferMode": "COMPLETE",
    "totalDataRecords": 2,
    "configs":{},
    "dataRecords":
     [
        {
            "keySalesOrderID":"SAL-1"
        },
        {
            "keySalesOrderID":"2231321",
            "salesOrderCode":"SALE-123",
            "salesOrderNumber":"123",
            "keyCustomerAccountID":"222",
            "customerAccountCode":"CUST004",
            "customerAccountName":"John Smith",
            "accountDiscountRate": 0,
            "accountTerritory":"",
            "sentDate": 1448132083084,
            "processedDate": 1449132083084,
            "dispatchedDate": 1450132083084,
            "receivedDate": 1451132083084,
            "modifiedDate": 1452132083084,
            "createdDate": 1447132083084,
            "keySalesRepID":"REP-2",
            "salesRepCode":"JD",
            "salesRepName": "John Doe",
            "salesRepIndividual":"Y",
            "currencyISOCode": "AUD",
            "paymentStatus": "PAID",
            "paymentMethod": "CREDITCARD",
            "paymentProprietaryCode": "",
            "paymentReceipt": "32423RES3432",
            "paymentAmount": 110.00,
            "purchaseOrderNumber":"PURCHASE-123",
            "purchaserSystemID":"ACME-123",
            "purchaserSystemName":"ACME ACCOUNTING SYSTEM",
            "purchaserSystemCode":"AAS",
            "sellerSystemID":"ERP-1",
            "sellerSystemName":"ENTERPRISE RESOURCE PLANNING SYS",
            "sellerSystemCode":"ERPS",
            "invoiceNumbers": ["INV-001","INV-002"],
            "deliveryDescription":"Primary Delivery Address",
            "deliveryContact":"John Smith",
            "deliveryOrgName":"",
            "deliveryEmail":"js@someemailaddress.comm",
            "deliveryPhone":"+6144433332222",
            "deliveryFax":"+6144433332221",
            "deliveryAddress1":"Unit 5",
            "deliveryAddress2":"22 Bourkie Street",
            "deliveryAddress3":"Melbourne",
            "deliveryPostcode":"3000",
            "deliveryRegionName":"Victoria",
            "deliveryCountryName":"Australia",
            "deliveryCountryCodeISO2":"AU",
            "deliveryCountryCodeISO3":"AUS",
            "billingDescription":"Head Office",
            "billingContact":"Mary Smith",
            "billingOrgName":"Imports Organisation",
            "billingEmail":"ms@someemailaddress.comm",
            "billingPhone":"+61445242323423",
            "billingFax":"+61445242323421",
            "billingAddress1":"15",
            "billingAddress2":"Bourkie Street",
            "billingAddress3":"Melbourne",
            "billingPostcode":"3000",
            "billingRegionName":"Victoria",
            "billingCountryName":"Australia",
            "billingCountryCodeISO2":"AU",
            "billingCountryCodeISO3":"AUS",
            "email":"hs@someemailaddress.comm",
            "totalLines": 4,
            "totalProducts": 2,
            "totalLabour": 1,
            "totalDownloads": 1,
            "totalPriceExTax": 100.00,
            "totalPriceIncTax": 110.00,
            "totalTax": 10.00,
            "totalWeight": 35,
            "totalVolume": 10,
            "totalVolumeMeasureCode": "KG",
            "totalWeightMeasureCode":"METRES-CUBED",
            "totalSurchargeItems": 1,
            "totalSurchargeExTax": 20.00,
            "totalSurchargeIncTax": 22.00,
            "totalSurchargeTax": 2.00,
            "totalPriceUndiscountedExTax": 140.00,
            "totalPriceUndiscountedIncTax": 154.00,
            "totalPriceUndiscountedTax": 14.00,
            "instructions":"Please leave the goods at the back door",
            "freightCarrierCode": "ACME-F",
            "freightCarrierName":"Acme Freight Carrier",
            "freightSystemRefCode":"334234-23423-234-343242",
            "freightCarrierConsignCode":"34423423424",
            "freightCarrierTrackingCode":"767567-56765-5676567",
            "freightCarrierServiceCode":"ROUTING-FREIGHT",
            "freightCarrierAccountCode":"FREI-1234",
            "isDropship":"N",
            "keyLocationID":"456",
            "locationCode":"LCT-456",
            "locationName":"Warehouse",
            "isMultiLocation":"N",
            "externalKeyLocationID":"111",
            "externalLocationCode":"CUSTOMERA-STORE",
            "externalLocationName":"Customer A Store",
            "shippingMethod":"N",
            "isProductsDelivered":"N",
            "lines":
            [
                {
                    "lineType":"PRODUCT"
                },
                {
                    "lineType":"PRODUCT",
                    "purchaseOrderLineCode": "SWISH-002",
                    "purchaseOrderLineNumber": "2",
                    "locationCode": "LCT-456",
                    "locationName": "Warehouse",
                    "keyLocationID": "456",
                    "language": "EN_AU",
                    "quantity": 2,
                    "priceExTax": 10.00,
                    "priceIncTax": 11.00,
                    "priceTax": 1.00,
                    "priceUndiscountedExTax": 40.00,
                    "priceUndiscountedIncTax": 44.00,
                    "priceUndiscountedTax": 4.00,
                    "priceTotalExTax": 20.00,
                    "priceTotalIncTax": 22.00,
                    "priceTotalTax": 2.00,
                    "priceTotalUndiscountedExTax": 80.00,
                    "priceTotalUndiscountedIncTax": 88.00,
                    "priceTotalUndiscountedTax": 8.00,
                    "isPriceFree": "N",
                    "entitySetPrice": "SYSTEM",
                    "unitName": "REAM",
                    "priceReferenceCode": "SALE-34",
                    "priceReferenceType": "C",
                    "isKitted": "N",
                    "kittedProductSetPrice": "N",
                    "isReserved": "N",
                    "keyProductID": "1234",
                    "productCode": "PROD-001",
                    "productName": "Swisho Green Paper",
                    "productDescription": "Swisho green coloured paper is the ultimate green paper.",
                    "purchaseOrderProductCode": "SWISH-001",
                    "width": 20.1,
                    "height": 21,
                    "depth": 29.7,
                    "volume": 10,
                    "weight": 10.00,
                    "widthUnitMeasureCode": "METRES",
                    "heightUnitMeasureCode": "METRES",
                    "depthUnitMeasureCode": "METRES",
                    "volumeUnitMeasureCode": "METRES-CUBED",
                    "weightUnitMeasureCode": "KG",
                    "taxes":
                    [
                        {
                            "keyTaxcodeID":"456",
                            "taxcode":"GST",
                            "taxcodeLabel":"Goods And Services Tax",
                            "taxRate": 10.00,
                            "language": "EN_AU",
                            "quantity": 2,
                            "priceTax": 1.00,
                            "priceTotalTax": 2.00
                        }
                    ],
                    "attributes":
                    [
                        {
                            "keyProfileID":"1234123",
                            "profileCode":"ORD-PROF-1",
                            "profileName":"Style",
                            "values":
                            [
                                {
                                    "keyAttributeID":"3423423",
                                    "attributeCode":"coating-paper-1",
                                    "attributeName":"Coating",
                                    "attributeValue":"Glossy"
                                },
                                {
                                    "keyAttributeID":"45345345",
                                    "attributeCode":"coating-paper-comment",
                                    "attributeName":"Comment",
                                    "attributeValue":"Make sure that the edges are not too sharp"
                                }
                            ]
                        }
                    ],
                    "productDeliveries":
                    [
                        {
                            "quantity":1,
                            "deliveryDate": 1447132083084,
                            "customerAccountInvoiceCode":"INV-001",
                            "customerAccountInvoiceLineCode":"2",
                            "customerAccountDeliveryCode":"DEL-1234",
                            "customerAccountDeliveryLineCode":"1"
                        },
                        {
                            "quantity":1,
                            "deliveryDate": 1448132083084,
                            "customerAccountInvoiceCode":"INV-002",
                            "customerAccountInvoiceLineCode":"1",
                            "customerAccountDeliveryCode":"DEL-1235",
                            "customerAccountDeliveryLineCode":"1"
                        }
                    ]
                },
                {
                    "lineType":"DOWNLOAD",
                    "purchaseOrderLineCode": "SWISH-003",
                    "purchaseOrderLineNumber": "3",
                    "language": "EN_AU",
                    "quantity": 1,
                    "priceExTax": 20.00,
                    "priceIncTax": 22.00,
                    "priceTax": 2.00,
                    "priceTotalExTax": 20.00,
                    "priceTotalIncTax": 22.00,
                    "priceTotalTax": 2.00,
                    "isPriceFree": "N",
                    "entitySetPrice": "SALESREP",
                    "unitName": "file",
                    "keyDownloadID": "DOW2",
                    "downloadCode": "Download 2",
                    "downloadName": "Track01 - Standards",
                    "downloadDescription": "Listen to My Rock Band's first track off their new album called Standards.",
                    "purchaseOrderDownloadCode": "DOWN-1234",
                    "taxes":
                    [
                        {
                            "keyTaxcodeID":"456",
                            "taxcode":"GST",
                            "taxcodeLabel":"Goods And Services Tax",
                            "taxRate": 10.00,
                            "language": "EN_AU",
                            "quantity": 1,
                            "priceTax": 2.00,
                            "priceTotalTax": 2.00
                        }
                    ]
                },
                {
                    "lineType":"LABOUR",
                    "purchaseOrderLineCode": "SWISH-004",
                    "purchaseOrderLineNumber": "4",
                    "language": "EN_AU",
                    "quantity": 1,
                    "priceExTax": 40.00,
                    "priceIncTax": 44.00,
                    "priceTax": 4.00,
                    "priceTotalExTax": 40.00,
                    "priceTotalIncTax": 44.00,
                    "priceTotalTax": 4.00,
                    "isPriceFree": "N",
                    "entitySetPrice": "SYSTEM",
                    "unitName": "hour",
                    "keylabourID": "LAB1",
                    "labourCode": "DELIVERY-HELP",
                    "labourName": "Paper Delivery Help",
                    "labourDescription": "Service to help deliver and place paper products internally at the delivery address",
                    "purchaseOrderLabourCode": "LAB-1234",
                    "taxes":
                    [
                        {
                            "keyTaxcodeID":"456",
                            "taxcode":"GST",
                            "taxcodeLabel":"Goods And Services Tax",
                            "taxRate": 10.00,
                            "language": "EN_AU",
                            "quantity": 1,
                            "priceTax": 4.00,
                            "priceTotalTax": 4.00
                        }
                    ]
                },
                {
                    "lineType":"TEXT",
                    "purchaseOrderLineCode": "SWISH-005",
                    "purchaseOrderLineNumber": "5",
                    "language": "EN_AU",
                    "labourDescription": "Payment for order will be placed after goods and services have been delivered."
                }
            ],
            "surcharges":
            [
                {
                    "surchargeCode":"WEB_CC_SURCHARGE"
                },
                {
                    "surchargeCode":"WEB_FREIGHT",
                    "name":"Freight Surcharge",
                    "priceExTax": 20.00,
                    "priceIncTax": 22.00,
                    "priceTax": 2.00,
                    "taxes":
                    [
                        {
                            "keyTaxcodeID":"456",
                            "taxcode":"GST",
                            "taxcodeLabel":"Goods And Services Tax",
                            "taxRate": 10.00,
                            "language": "EN_AU",
                            "quantity": 1,
                            "priceTax": 2.00,
                            "priceTotalTax": 2.00
                        }
                    ]
                }
            ]
        }
    ]
}
See Also