ESDocumentCustomerAccountAddress Class

Ecommerce standards document that holds a list of address records for customer accounts

Inheritance Hierarchy

SystemObject
EcommerceStandardsDocumentsESDocument
EcommerceStandardsDocumentsESDocumentCustomerAccountAddress

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

The ESDocumentCustomerAccountAddress type exposes the following members.

Constructors

	Name	Description
	ESDocumentCustomerAccountAddress	Constructor

Top

Fields

	Name	Description
	configs	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.)
	dataRecords	List of customer account address records
	dataTransferMode	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.)
	message	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.)
	resultStatus	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.)
	totalDataRecords	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.)
	version	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 Customer Account Address Ecommerce Standards document in its JSON serialised form

Copy

{
    "version": 1.5,
    "resultStatus": 1,
    "message":"The customer account address data has been successfully obtained.",
    "dataTransferMode": "COMPLETE",
    "totalDataRecords": 3,
    "configs":{"dataFields":"keyAddressID,keyCustomerAccountID,description,orgName,contact,phone,fax,address1,address2,address3,region,country,postcode,freightCode,isPrimary,isDelivery"},
    "dataRecords":
     [
        {
            "keyAddressID":"ADD-001"
        },
        {
            "keyAddressID":"ADD002",
            "keyCustomerAccountID":"10",
            "description":"Billing Address",
            "orgName":"ESD Industries",
            "contact":"John Doe",
            "phone":"+61234567890",
            "fax":"+612345678901",
            "address1":"22",
            "address2":"Bourkie Street",
            "address3":"Melbourne",
            "region":"Victoria",
            "country":"Australia",
            "postcode":"3000",
            "freightCode":"01FRE",
            "isPrimary":"Y",
            "isDelivery":"N"
        },
        {
            "keyAddressID":"ADD003",
            "keyCustomerAccountID":"10",
            "description":"Delivery Address",
            "orgName":"ESD Industries",
            "contact":"John Doe",
            "phone":"+61234567890",
            "fax":"+612345678901",
            "address1":"25",
            "address2":"Bourkie Street",
            "address3":"Melbourne",
            "region":"Victoria",
            "country":"Australia",
            "postcode":"3000",
            "freightCode":"02FRE",
            "isPrimary":"N",
            "isDelivery":"Y"
        }
    ]
}

Reference

EcommerceStandardsDocuments Namespace