ESDocument Class

Constructor that sets that initialises the document's properties

Constructor

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.

Denotes if the data being placed into document is a complete data set, or partial data being transferred containing only data changes.

Message providing details of if the data could be obtained when requesting the document. The message gives meaning to the result status.

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

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.

Version of the Ecommerce Standards Document. Verifying the version of the document is critical for systems transferring and manipulating the data.