EcommerceStandardsDocuments Namespace |
using System; using System.Collections.Generic; using System.Linq; using System.Text; using Newtonsoft.Json; using System.ServiceModel; using System.ServiceModel.Activation; using System.ServiceModel.Web; using EcommerceStandardsDocuments; namespace MyApp{ public class MyClass { /// <summary> Obtains a list of products records contained within an a products Ecommerce Standards Document</summary> public ESDocumentProduct getProducts() { List<ESDRecordProduct> products = new List<ESDRecord>(); Dictionary<string, string> docConfigs = new Dictionary<string, string>(); //create a new product Ecomerce Standards Document ESDocumentProduct productsDoc = new ESDocumentProduct(ESDocumentConstants.RESULT_ERROR_UNKNOWN, "Unable to get product data.", null, null); //create a record for a tea towel product ESDRecordProduct product1 = new ESDRecordProduct(); product1.keyProductID = "1"; product1.productCode = "PROD-1"; product1.name = "Tea Towels"; product1.description1 = "An assorted bundle of different coloured tea towels"; products.add(product1); //create another record for a kettle product ESDRecordProduct product2 = new ESDRecordProduct(); product2.keyProductID = "2"; product2.productCode = "PROD-2"; product2.name = "Kettle"; products.add(product2); //in the document configs list all the properties of the product records that are being set, any properties not in the list can be ignored by the system when processing the product records docConfigs.Add("dataFields","keyProductID,productCode,name,description1"); //assign the product records to the document and update document meta data productsDoc.configs = docConfigs; productsDoc.totalDataRecords = products.Count; productsDoc.dataRecords = products.ToArray(); productsDoc.resultStatus = ESDocumentConstants.RESULT_SUCCESS; productsDoc.message = "Product data has been successfully obtained."; return productsDoc; } /// <summary> /// Serializes a product Ecommerce Standards Document into a stream of JSON data. That JSON data is returned in a WCF (Windows Communication Library) message object, which would typically be set in the HTTP response to a web service endpoint GET request. /// In this example the document is being serialized using the JSON.net open source library, which is included in the Ecommerce Standards Library. /// </summary> /// <param name="productsDoc">Ecommerce Standards Document containing product record data.</param> /// <returns>WCF message containing the serialised JSON data.</returns> public System.ServiceModel.Channels.Message serializeESProductDocument(ESDocumentProduct productsDoc) { //Set HTTP response header to denote that the data will be GZipped. Note that the actual compression would occur outside this method. WebOperationContext.Current.OutgoingResponse.Headers[HttpResponseHeader.ContentEncoding] = "gzip"; //Create JSON.NET serializer that will ignore including JSON properties that contain empty values JsonSerializer serializer = new JsonSerializer(); serializer.NullValueHandling = NullValueHandling.Ignore; serializer.MissingMemberHandling = MissingMemberHandling.Ignore; //serialise the products Ecommerce Standards Document string jsonSerialized = JsonConvert.SerializeObject(productsDoc); //Place the serialised JSON data into a memory stream MemoryStream resultBody = new MemoryStream(new UTF8Encoding().GetBytes(jsonSerialized)); resultBody.Position = 0; //Resurn the serialised JSON data into WCF's response message, which can allow it to be included in the body of a HTTP response from a web service RESTful endpoint request return WebOperationContext.Current.CreateStreamResponse(resultBody, "application/json"); } } }
{ "version": 1.5, "resultStatus": 1, "message":"Product data has been successfully obtained.", "totalDataRecords": 2, "dataTransferMode": "COMPLETE", "configs": {"dataFields":"keyProductID,productCode,name,description1"}, "dataRecords": [ { "keyProductID":"1", "productCode":"PROD-1", "name":"Tea Towels", "description1":"An assorted bundle of different coloured tea towels." }, { "keyProductID":"2", "productCode":"PROD-2", "name":"Kettle" } ] }
Endpoint Name | Returned Document | Input Arguments | Description |
---|---|---|---|
getCategories | ESDocumentCategory | - | Returns a list of categories records, as well as products, labour, and downloads mappings associated to each category. |
getCustomerAccounts | ESDocumentCustomerAccount | - | Returns a list of customer account records. |
getCustomerAccountStatus | ESDocumentCustomerAccount | keyCustomerAccountID, checkOnHold, checkBalance, checkTerms | Returns a single customer account record that contains information about the account's status. This endpoint typically allows a real time request to see the status of the account. Optionally checks can be done to see if it is on hold, outside its balance limit, and that it is within its terms. |
getCustomerAccountAddresses | ESDocumentCustomerAccountAddress | - | Returns a list of customer account address records. |
getCustomerAccountContact | ESDocumentCustomerAccountContact | - | Returns a list of customer account contract records. |
getCustomerAccountEnquiryRecords | ESDocumentCustomerAccountEnquiry | keyCustomerAccountID, recordType, beginDate, endDate, pageNumber, numberOfRecords, outstandingRecords, searchType, searchString, keyRecordIDs | Returns a list of customer account enquiry records for a single customer account based on a given record type (either transactions, invoices, sales orders, back orders, payments, or credits). It can allow searching based on the account type, over a given date range. Each record does not need to contain any line data. |
getCustomerAccountEnquiryRecord | ESDocumentCustomerAccountEnquiry | keyCustomerAccountID, recordType, keyRecordID | Returns a list of customer account enquiry records that contains only one record for a customer account based on a given record type (either a transaction, invoice, sales order, back order, payment, or credit). The record contains all possible data for it, including all lines set in it. |
getCustomerAccountProductPrice | ESDocumentCustomerAccountProductPrice | -keyCustomerAccountID, keyProductID, quantity | Returns the price of a single product for a given customer account. This allows for live quering of product pricing. However it is not recommended to be used between systems over a long, slow connection. |
getDownloads | ESDocumentDownload | - | Returns a list of download records. |
getItemGroups | ESDocumentItemGroups | - | Returns a list of item group records. |
getItemRelations | ESDocumentItemRelations | - | Returns a list of item relations records. |
getLocations | ESDocumentLocation | - | Returns a list of location records. |
getPaymentTypes | ESDocumentPaymentType | - | Returns a list of payment type records. |
getPriceLevels | ESDocumentPriceLevel | - | Returns a list of price-level records. |
getProducts | ESDocumentProduct | - | Returns a list of product records. |
getProductAlternateCodes | ESDocumentAlternateCode | - | Returns a list of alternate code records associated to products. |
getProductAttachments | ESDocumentAttachment | - | Returns a list of attachment records associated to products. This can be used to locate files associated with the products. |
getProductAttributes | ESDocumentAttribute | - | Returns a list of attribute profile records, as well as attribute value records assigned to products. |
getProductCombination | ESDocumentProductCombination | - | Returns a list of product combination profile records, as well as mappings of field-value combinations between parent and child products. |
getProductFlags | ESDocumentFlag | - | Returns a list of records that assign flags to products. |
getProductImages | ESDocumentProductImage | - | Returns a list of image records associated to products. These records can be used to locate image files associated to products. |
getProductKits | ESDocumentKit | - | Returns a list of kit records which associate component products to kit products. |
getProductPriceLevelPricing | ESDocumentProductPrice | - | Returns a list of single unit pricing records for each price-level for all products. |
getProductPriceLevelQuantityPricing | ESDocumentPrice | - | Returns a list of quantity break pricing records for each price-level for all products. |
getProductCustomerAccountPricing | ESDocumentPrice | - | Returns a list of product price records that are specifically related to customer accounts, or to pricing groups that customer accounts are assigned to. This endpoint is typically used to obtain contract/special/promotional pricing related to specific accounts. It is highly recommended to use pricing groups if the same pricing rules have been applied to customer accounts. |
getProductStockQuantities | ESDocumentStockQuantity | - | Returns a list of stock quantity records. These records containg the quantity of stock available to the products. Sometimes this endpoint can be called very frequently to ensure that stock data is up to date in other systems in "near real time". |
getPurchasers | ESDocumentPurchaser | - | Returns a list of purchaser records. |
getSalesReps | ESDocumentSalesRep | - | Returns a list of sales representative records. |
getSellUnits | ESDocumentSellUnit | - | Returns a list of sell unit records. |
getSupplierAccounts | ESDocumentSupplierAccount | - | Returns a list of supplier account records. |
getSupplierAccountAddresses | ESDocumentSupplierAccountAddress | - | Returns a list of supplier account address records. |
getSupplierAccountEnquiryRecords | ESDocumentSupplierAccountEnquiry | keySupplierAccountID, recordType, beginDate, endDate, pageNumber, numberOfRecords, outstandingRecords, searchType, searchString, keyRecordIDs | Returns a list of supplier account enquiry records for a single supplier account based on a given record type (either transactions, purchase orders, payments, or credits). It can allow searching based on the account type, over a given date range. Each record does not need to contain any line data. |
getSupplierAccountEnquiryRecord | ESDocumentSupplierAccountEnquiry | keySupplierAccountID, recordType, keyRecordID | Returns a list of supplier account enquiry records that contains only one record for a supplier account based on a given record type (either a transaction, purchase order, payment, or credit). The record contains all possible data for it, including all lines set in it. |
getSurcharges | ESDocumentSurcharge | - | Returns a list of surcharge records. |
getTaxcodes | ESDocumentTaxcode | - | Returns a list of taxcode records. |
getStatus | ESDocument | - | Returns a the status of the system. |
postSaleOrders | ESDocument | ESDocumentOrderSale | Pushes a list of sales order records, allowing the records to be saved to the system. The ESDocumentOrderSale data should be placed in the body of the http request, with the returned ESDocument reporting if all sales order records were successfully processed or not. It is recommended to only place one sales order into the document if transactions are not supported when creating multiple sales orders through one request. |
postPurchaseOrders | ESDocument | ESDocumentOrderPurchase | Pushes a list of purchaser order records, allowing the records to be saved to the system. This could cause new product, download, labour, pricing, alternate code, supplier account, and supplier account address records to get created in the system. The ESDocumentOrderPurchase data should be placed in the body of the http request, with the returned ESDocument reporting if all purchase order records were successfully processed or not. It is recommended to only place one purchase order into the document if transactions are not supported when creating multiple purchase orders through one request. |
postCustomerAccounts | ESDocument | ESDocumentCustomerAccount | Pushes a list of customer account records, allowing the records to be saved to the system. This could cause new customer account records to get created in the system. The ESDocumentCustomerAccount data should be placed in the body of the http request, with the returned ESDocument reporting if all customer account records were successfully processed or not. It is recommended to only place one customer account into the document if transactions are not supported when creating multiple customer accounts through one request. |
postCustomerAccountPayments | ESDocument | ESDocumentCustomerAccountPament | Pushes a list of customer account payment records, allowing the records to be saved to the system. This allows payments to be applied against orders and invoice records for a given customer account. The ESDocumentCustomerAccountPayment data should be placed in the body of the http request, with the returned ESDocument reporting if all customer account payment records were successfully processed or not. It is recommended to only place one customer account payment into the document if transactions are not supported when creating multiple customer account payments through one request. |
Class | Description | |
---|---|---|
ESDocument | Ecommerce Standards Document that contains the base set of properties for all documents | |
ESDocumentAlternateCode |
Ecommerce standards document that contains a list of alternate code records associated with products, downloads, or labour
| |
ESDocumentAsset |
Ecommerce standards document that contains a list of asset records
| |
ESDocumentAssetComponent |
Ecommerce standards document that contains a list of asset component records, that define the relationships between assets, and the components that make up an asset.
| |
ESDocumentAttachment |
Ecommerce standards document that contains a list of attachment file records associated with products, downloads or labour
| |
ESDocumentAttribute |
Ecommerce standards document that contains a list of attribute records associated with products, download, and labour, as well as a list of attribute profile records
| |
ESDocumentCategory |
Ecommerce standards document that contains a list of category records, and a list of category tree records
| |
ESDocumentConstants |
Contains a list of variable constants that can be used in Ecommerce Standards Documents and records
| |
ESDocumentCurrencyExchangeRate |
Ecommerce standards document that holds a list of currency exchange rate records
| |
ESDocumentCustomerAccount |
Ecommerce standards document that holds a list of customer account records
| |
ESDocumentCustomerAccountAddress |
Ecommerce standards document that holds a list of address records for customer accounts
| |
ESDocumentCustomerAccountContact |
Ecommerce standards document that holds a list of contacts records that are associated to customer accounts. These are the people who are linked to each customer account.
| |
ESDocumentCustomerAccountContract |
Ecommerce standards document that holds a list of contract records for customer accounts
| |
ESDocumentCustomerAccountEnquiry | Ecommerce standards document that holds lists of invoices, transactions, sales orders, back orders, credits and payment records for customer accounts. This document can by used in many ways for enquiring about different data associated to a customer account's finances. | |
ESDocumentCustomerAccountEnquiryLine | ||
ESDocumentCustomerAccountEnquiryProductPrice | Ecommerce standards document that contains a list of pricing records applicable to a customer account for a number of products | |
ESDocumentCustomerAccountPayment |
Ecommerce standards document that holds a list of customer account payment records
| |
ESDocumentCustomerInvoice |
Ecommerce standards document that contains a list of customer invoice records
| |
ESDocumentDeliveryNotice |
Ecommerce standards document that contains a list of delivery notice records
| |
ESDocumentDownload | Ecommerce standards document that contains a list of download records. | |
ESDocumentFlag | Ecommerce standards document that contains a list of flag records and products, dowloads, or labour assigned to flags | |
ESDocumentGeneralLedgerAccount |
Ecommerce standards document that holds a list of general ledger account records
| |
ESDocumentImage |
Ecommerce standards document that contains a list of image file records associated with products, downloads, or labour
| |
ESDocumentItemGroup | Ecommerce standards document that contains a list of item group records | |
ESDocumentItemRelation | Ecommerce standards document that contains a list of item relation records | |
ESDocumentKit | Ecommerce standards document that contains a list of kit records | |
ESDocumentLabour | Ecommerce standards document that contains a list of labour records. | |
ESDocumentLocation | Ecommerce standards document that contains a list of location records | |
ESDocumentLocationContact |
Ecommerce standards document that holds a list of contacts records that are associated to locations. These are the people who are linked or can be found at the location.
| |
ESDocumentMaker |
Ecommerce standards document that contains a list of maker/manufacturer records
| |
ESDocumentMakerModel |
Ecommerce standards document that contains a list of model records associated to makers/manufacturers
| |
ESDocumentMakerModelMapping |
Ecommerce standards document that contains a list of maker model mappings records that associate product, download, or labour records to categories within models manufactured or assembled by makers/manufacturers
| |
ESDocumentOrderPurchase |
Ecommerce standards document that contains a list of purchase order records
| |
ESDocumentOrderSale |
Ecommerce standards document that contains a list of sales order records
| |
ESDocumentPaymentType | Ecommerce standards document that contains a list of payment type records | |
ESDocumentPrice |
Ecommerce standards document that contains a list of pricing records for either products, downloads, or labour
| |
ESDocumentPriceLevel |
Ecommerce standards document that contains a list of price level records
| |
ESDocumentProduct |
Ecommerce standards document that contains a list of product records
| |
ESDocumentProductCombination | Ecommerce standards document that contains a list of product combination records, and a list of product combination profile records | |
ESDocumentPurchaser |
Ecommerce standards document that contains a list of purchaser records
| |
ESDocumentSalesRep |
Ecommerce standards document that contains a list of sales representative records
| |
ESDocumentSellUnit |
Ecommerce standards document that contains a list of sell unit records
| |
ESDocumentStockQuantity | Ecommerce standards document that contains a list of stock quantity records | |
ESDocumentSupplierAccount |
Ecommerce standards document that holds a list of supplier account records
| |
ESDocumentSupplierAccountAddress |
Ecommerce standards document that holds a list of address records for supplier accounts
| |
ESDocumentSupplierAccountContact |
Ecommerce standards document that holds a list of supplier account records
| |
ESDocumentSupplierAccountEnquiry | Ecommerce standards document that holds lists of purchase orders for supplier accounts. This document can by used in many ways for enquiring about different data associated to a supplier account's finances. | |
ESDocumentSupplierInvoice |
Ecommerce standards document that contains a list of supplier invoice records
| |
ESDocumentSurcharge | Ecommerce standards document that contains a list of surcharge records | |
ESDocumentTaxcode | Ecommerce standards document that contains a list of taxcode records | |
ESDocumentType | Contains the types of Ecommerce Standards Documents (ESD) that the library contains | |
ESDRecordAccountPaymentSurcharge | Details of a surcharge assigned to an customer/supplier account payment record within a Ecommerce Standards Document | |
ESDRecordAccountPaymentSurchargeTax | Details of a tax assigned to a customer/supplier payment surcharge within a Ecommerce Standards Document | |
ESDRecordAlternateCode | Ecommerce Standards Record that holds data for a single alternate code for a product, download, or labour. An alternate code is a different code that could be used to identify a product, download, or labour. | |
ESDRecordAsset | Ecommerce Standards Record that holds data for a single asset. An asset can be single instance of a tangible or intangible product/service/resource that is created, owned, traded, and may ultimately be destroyed. | |
ESDRecordAssetComponent | Ecommerce Standards Record that holds data for a single relationship between an asset belonging to another parent asset. This allows an asset to be made of many component assets to make a single collective larger asset/resource | |
ESDRecordAttachment | Ecommerce Standards Record that holds data for a single attachment file associated to a product, download, or labour. | |
ESDRecordAttribute | Ecommerce Standards Record that holds data for a single attribute associated with products, downloads, or labour. Attributes define the fields that can have values set for products, downloads, or labour. | |
ESDRecordAttributeProfile | Ecommerce Standards Record that holds data for a single attribute profile associated with entities such as products, download, labour or models. A profile allows any number of attributes to be grouped together. | |
ESDRecordAttributeValue | Ecommerce Standards Record that holds data for a single product, download, labour or model attribute value. | |
ESDRecordCategory | Ecommerce Standards record that contains data for a single category. A category is a representation of a collection of objects, and can be linked in a hierarchical data structure. | |
ESDRecordCategoryTree | Ecommerce Standards record that contains data for a single category tree. A category tree represents an overall hierarchical collection of categories, used to navigate and find associated products, maker models etc.. assigned to each category. | |
ESDRecordCombinationProfile | Ecommerce Standards Record that holds data for a single combination profile. Each profile defines the fields and field-values that are available for any number of combination products, downloads, or labour. | |
ESDRecordCombinationProfileField | Ecommerce Standards Record for storing the field data associated to a combination profile. Each field can contain any number of field-values, which allows products, downloads, and labour to be assigned to. | |
ESDRecordContact | Ecommerce Standards record that contains data for a single contact. A contact contains information about a person on how they can be communicated with. The contact record may be linked to a customer account, or supplier account | |
ESDRecordCurrencyExchangeRate | Ecommerce Standards Record that holds data for a single currency exchange rate that reflects the cost of purchasing one currency from another. These rates may be used to influence the price of selling or buying goods and services between states or countries. | |
ESDRecordCustomerAccount | Ecommerce Standards record that contains data for a single customer account. A customer account represents an entity (such as a person or organisation) that purchases from another entity where the account exists. The customer account may also known as a "debtor". | |
ESDRecordCustomerAccountAddress | Ecommerce Standards record that contains the data of a single address associated to a customer account. | |
ESDRecordCustomerAccountContract | Ecommerce Standards record that contains the data of a single customer account contract. A contract record may be applied to a number of customer accounts and products for a given amount of time. | |
ESDRecordCustomerAccountEnquiryBackOrder | Ecommerce Standards record that contains the data of a single Back Order that can be queried for a customer account. A back order record contains information about goods ordered by a customer account that needed to be ordered from an external supplier. The account enquiry aspect denotes that the record may be queried in real time and contain additional information associated with the record. | |
ESDRecordCustomerAccountEnquiryBackOrderLine | Ecommerce Standard Record holding data for a customer account back order line | |
ESDRecordCustomerAccountEnquiryCredit | Ecommerce Standards record that contains the data of a single Credit that can be queried for a customer account. A credit record contains information about a monetary amount applied to the account's balance. The account enquiry aspect denotes that the record may be queried in real time and contain additional information associated with the record. | |
ESDRecordCustomerAccountEnquiryCreditLine | Ecommerce Standard Record holding line data for a customer account credit enquiry | |
ESDRecordCustomerAccountEnquiryInvoice | Ecommerce Standards record that contains the data of a single Invoice that can be queried for a customer account. An invoice record contains information about items ordered by a customer account. The account enquiry aspect denotes that the record may be queried in real time and contain additional information associated with the record. | |
ESDRecordCustomerAccountEnquiryInvoiceLine | Ecommerce Standard Record holding data for a customer account invoice line | |
ESDRecordCustomerAccountEnquiryOrderSale | Ecommerce Standards record that contains the data of a single Sales Order that can be queried for a customer account. A sales order record contains information about items ordered by a customer account. The account enquiry aspect denotes that the record may be queried in real time and contain additional information associated with the record. | |
ESDRecordCustomerAccountEnquiryOrderSaleLine | Ecommerce Standard Record holding data for a customer account order line | |
ESDRecordCustomerAccountEnquiryPayment | Ecommerce Standards record that contains the data of a single Payment that can be queried for a customer account. A payment record contains information about a positive monetary amount paid to the customer account's balance. The account enquiry aspect denotes that the record may be queried in real time and contain additional information associated with the record. | |
ESDRecordCustomerAccountEnquiryPaymentLine | Ecommerce Standard Record holding data for a customer account enquiry payment line | |
ESDRecordCustomerAccountEnquiryProductPrice | Holds a product's price based on a specific account price that is used for the web | |
ESDRecordCustomerAccountEnquiryQuote | Ecommerce Standards record that contains the data of a single quote that can be queried for a customer account. A quote record contains information about items that need to be confirmed and priced for a customer account. The account enquiry aspect denotes that the record may be queried in real time and contain additional information associated with the record. | |
ESDRecordCustomerAccountEnquiryQuoteLine | Ecommerce Standard Record holding data for a customer account quote line. The line stores information about a single type of product, goods or service, and the pricing quoted to purchase the item | |
ESDRecordCustomerAccountEnquiryTransaction | Ecommerce Standards record that contains the data of a single transaction that can be queried for a customer account. A transaction record contains information about a positive or negative amount applied against the customer account's balance, as well the balance after the amount was applied. The account enquiry aspect denotes that the record may be queried in real time and contain additional information associated with the record. | |
ESDRecordCustomerAccountPayment | Ecommerce Standard Document that holds details of a payment made by a customer account for a given record type | |
ESDRecordCustomerAccountPaymentRecord | Ecommerce Standard Document that holds details of a record associated to a payment made by a customer account | |
ESDRecordCustomerInvoice | Ecommerce Standards Record that holds data for a single invoice raised against a customer. A customer invoice specifies goods and/or services that have been purchased from a customer, and the monetary amount that the customer owes. | |
ESDRecordCustomerInvoiceLine | Ecommerce Standards Record that holds data for a single line in a customer's invoice. | |
ESDRecordDeliveryNotice | Ecommerce Standards Record that holds data for a single delivery notice. The delivery notice (also known as an Advanced Ship Notice (ASN)) advises of the delivery of products being made by the supplier. The notice can advise when goods are being packed, dispatched, in-transit, held in storage, delivered, lost, or cancelled | |
ESDRecordDeliveryNoticeLine | Ecommerce Standards Record that holds data for a single line in a delivery notice record. The line indicates the quantity of a product that is being delivered, or in the process thereof. | |
ESDRecordDownload | Ecommerce Standards Record that holds data for a single download. A download represents a piece of digital information, that may be stored, sold, or transferred. | |
ESDRecordFlag | Ecommerce Standards Record that holds data for a single type of flag. A flag can allow different entities (such as products) to be marked, allowing them to be highlighted, given additional meaning, or extra importance. | |
ESDRecordFlagMapping | Ecommerce Standards Record that holds data for a single mapping between a flag and either a product, download, or labour entity. | |
ESDRecordGeneralLedgerAccount | Ecommerce Standards Record that holds data for a single General Ledger Account. The account is used to record the monetary transactions against an aspect of a business, person or other entity, recorded against the General Ledger. | |
ESDRecordImage | Ecommerce Standards Record that holds data associated with a single product, download, or labour image. | |
ESDRecordInvoiceLineAttribute | Ecommerce Standards Record that holds data for a single attribute and value within an invoice line. This allows any additional fields and field values to be with the invoice line. | |
ESDRecordInvoiceLineAttributeProfile | Ecommerce Standards Record that holds data for a single attribute profile for an invoice line. This allows any additional attribute data to be set for the line. | |
ESDRecordInvoiceLineTax | Details of a tax assigned to a invoice line within a Ecommerce Standards Document | |
ESDRecordInvoicePayment | Ecommerce Standards Record that holds data for a single payment associated to an invoice. | |
ESDRecordInvoiceSurcharge | Details of a surcharge assigned to an invoice record within a Ecommerce Standards Document | |
ESDRecordItemGroup | Ecommerce Standards Record that holds data for a single item group. Each record represents a group of assigned products, downloads and/or labour. | |
ESDRecordItemRelation | Ecommerce Standards Record that holds data for a single relation between items. Each record links one product, labour, or download record to another product, labour, or download record | |
ESDRecordKitComponent | Ecommerce Standards Record that holds data for a single product, download, or labour assigned to a kit. A kit allows any number of products, downloads, or labour to be assigned it. | |
ESDRecordLabour | Ecommerce Standards Record that holds data for a single labour record. Labour describes the different kinds of effort required to perform a piece of work. | |
ESDRecordLocation | Ecommerce Standards Record that holds data for a single location. Location could be a physical geographical location or a virtual place. | |
ESDRecordMaker | Ecommerce Standards Record that holds data for a single maker/manufacturer. A maker/manufacturer builds and/or assembles models which contain a collection of products or raw materials. | |
ESDRecordMakerModel | Ecommerce Standards Record that holds data for a single model created or assembled by a maker/manufacturer. Each model is made up of a collection of products or raw materials. | |
ESDRecordMakerModelMapping | Ecommerce Standards Record that holds data for a single mapping between a maker/manufacturer's model, a category, and either a product, download, or labour entity. Each mapping may also contain any number of attribute values to contain more data about the mapped entity in relation to the model | |
ESDRecordOrderLineAttribute | Ecommerce Standards Record that holds data for a single attribute and value within a order line. This allows any additional fields and field values to be set with the order line. | |
ESDRecordOrderLineAttributeProfile | Ecommerce Standards Record that holds data for a single attribute profile set for a order line. This allows any additional attribute data to be set for the line. | |
ESDRecordOrderLineTax | Details of a tax assigned to a order line within a Ecommerce Standards Document | |
ESDRecordOrderPayment | Ecommerce Standards Record that holds data for a single payment associated to an order. | |
ESDRecordOrderProductDelivery | Ecommerce Standards Record that holds data for a single product delivery associated to an order. | |
ESDRecordOrderPurchase | Ecommerce Standards Record that holds data for a single purchase order. A purchase order indicates an intent to buy goods and services off a supplier. | |
ESDRecordOrderPurchaseLine | Ecommerce Standards Record that holds data for a single line in a purchase order. | |
ESDRecordOrderSale | Ecommerce Standards Record that holds data for a single sales order. A sales order indicates an intent of a customer account to make a purchase. | |
ESDRecordOrderSaleLine | Ecommerce Standards Record that holds data for a single line in a sales order. | |
ESDRecordOrderSurcharge | Details of a surcharge assigned to an order record within a Ecommerce Standards Document | |
ESDRecordPaymentType | Ecommerce Standards Record that holds data for a single payment type. Each payment type defines a way to purchase goods and services, or the way that goods and servies were paid for. | |
ESDRecordPrice | Ecommerce Standards Record that holds data for a single product price. The price may be assigned to a price-level, a price-group, or a customer account | |
ESDRecordPriceLevel | Ecommerce Standards Record that holds data for a single price level. A price level allows multiple prices to be set for the same product, download, or labour record | |
ESDRecordProduct | Ecommerce Standards Record that holds data for a single product. A product can be a physical or non-physical item that can be sold in quantities. | |
ESDRecordProductCombination | Ecommerce Standards record for associating a child product with a given combination of fields and values | |
ESDRecordProductCombinationParent | Ecommerce Standards record for associating a parent product with a product combination profile, and all of its associated product-field-value combinations | |
ESDRecordPurchaser | Ecommerce Standards Record that holds data for a single purchaser. A purchaser represents an entity (person or organisation) that may buy products, manage supplier accounts, and place purchase orders with suppliers. | |
ESDRecordSalesRep | Ecommerce Standards Record that holds data for a single sales representative. A sales representative represents an entity (person or organisation) that may sell products, manage customer accounts, and place sales orders on behalf of customers among other things. | |
ESDRecordSellUnit | Ecommerce Standards Record that holds data for a single sell unit. The unit defines how a product, download, or labour is sold individually. | |
ESDRecordStockQuantity | Ecommerce Standards Record that holds data for a stock unit quantity of a product, download or labour. This record typically stores stock quantity data that can updated on a frequent basis. | |
ESDRecordSupplierAccount | Ecommerce Standards record that contains data for a single supplier account. A supplier account represents an entity (such as a person or organisation) that supplies goods/services/items from another external entity. The supplier account may also known as a "creditor". | |
ESDRecordSupplierAccountAddress | Ecommerce Standards record that contains the data of a single address associated to a supplier account. | |
ESDRecordSupplierAccountEnquiryOrderPurchase | Ecommerce Standards record that contains the data of a single Purchase Order that can be queried for a supplier account. A purchase order record contains information about items ordered by a supplier account. The account enquiry aspect denotes that the record may be queried in real time and contain additional information associated with the record. | |
ESDRecordSupplierAccountEnquiryOrderPurchaseLine | Ecommerce Standard Record holding data for a supplier account order line | |
ESDRecordSupplierInvoice | Ecommerce Standards Record that holds data for a single invoice sent from a supplier. A supplier invoice specifies goods and/or services that have been purchased from a supplier, and the monetary amount owed to the supplier. | |
ESDRecordSupplierInvoiceLine | Ecommerce Standards Record that holds data for a single line in a supplier's invoice. | |
ESDRecordSurcharge | Ecommerce Standards Record that holds data for a single surcharge. Each surcharge defines a type of monetary amount that may be added or substracted which is factored into the final price of purchasing goods or services. | |
ESDRecordTaxcode | Ecommerce Standards Record that holds data for a single taxcode. Each taxcode defines a type of tax that can be calculated for any relevant monetary price. | |
ESDRecordType | Contains the types of Ecommerce Standards Document (ESD) records that the library contains |