Click or drag to resize
ESDocumentSurcharge Class
Ecommerce standards document that contains a list of surcharge records
Inheritance Hierarchy
SystemObject
  EcommerceStandardsDocumentsESDocument
    EcommerceStandardsDocumentsESDocumentSurcharge

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

The ESDocumentSurcharge type exposes the following members.

Constructors
  NameDescription
Public methodESDocumentSurcharge
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 surcharge 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 Surcharge Ecommerce Standards document in its JSON serialised form
{
    "version": 1.2,
    "resultStatus": 1,
    "message":"The surcharge data has been successfully obtained.",
    "dataTransferMode": "COMPLETE",
    "totalDataRecords": 4,
    "configs":{"dataFields":"keySurchargeID,surchargeCode,surchargeLabel,description,surchargeType"},
    "dataRecords":
     [
        {
            "keySurchargeID":"123"
        },
        {
            "keySurchargeID":"456",
            "surchargeCode": "WEB_FREIGHT",
            "surchargeLabel":"Web Order Freight",
            "description": "Costs to deliver orders created through the website.",
            "surchargeType": "FREIGHT"
        },
        {
            "keySurchargeID":"765",
            "surchargeCode": "WEB_CC_SURCHARGE",
            "surchargeLabel": "Web Credit Card Surcharge",
            "description": "Transaction cost for payment made by credit card.",
            "surchargeType": "CREDITCARD"
        },
        {
            "keySurchargeID":"6765",
            "surchargeCode": "WEB_MIN_ORDER",
            "surchargeLabel": "Web Minimum Order Surcharge",
            "description": "Cost to handle orders when an order's total price is under the allowed minimum.",
            "surchargeType": "MINORDER"
        }
    ]
}
See Also