MagicScripts EDX Project

Site Map Back to Home Page Contact Us About MagicScripts    Products   Services   Store   Customer Area   Resources   Affiliate Program 

EDX Specification

Contents

What is EDX?


EDX is an acronym of Ecommerce Data eXchange - XML dialect to describe ecommerce data.
It can be used to create XML feed for
  • company information
  • products information
  • transactions information
  • customers information
MagicScripts is developing EDX vocabulary - DTD document to use in XML documents. Current version can be found here:
http://www.magicscripts.com/xml/edx-1.01.dtd

EDX document structure


Each EDX document must complain to the XML specification.

The first two lines of EDX document are:

<?xml version="1.0"?>
<!DOCTYPE edx PUBLIC "-//MagicScripts//EDX 1.01//EN" "http://www.magicscripts.com/xml/edx-1.01.dtd">

The root element of EDX document is "edx"

<edx version="1.01">

EDX elements hierarchy (required elements are in bold):
  • <edx> ( attribute version #REQUIRED )
    • <company> (?)
      • <title>
      • <url>
      • <description> (?)
      • <banner> (?)
        • <url> - url of banner image
        • <link> - url to send visitor (anchor href attribute)
        • <title> - anchor title attribute (?)
        • <width> - image width (?)
        • <height> - image height (?)
    • <category> ( attribute id #IMPLIED ) (*)
      • <title> - category title : "Computers"
      • <url> - URL of resource containing category imformation
      • <category> - recursive use to describe categories tree
      • <product> ( attribute id #IMPLIED ) (*)
        • <article> (?)
        • <title>
        • <description>
        • <price> (+)
          • <currency> - currency code
          • <amount> - value
        • <url> (?)
        • <banner> (?)
          • <url> - url of banner image
          • <link> - url to send visitor (anchor href attribute)
          • <title> - anchor title attribute (?)
          • <width> - image width (?)
          • <height> - image height (?)
        • <options> ( attribute id #IMPLIED ) (*)
          • <title>
          • <value>
          • <price> (+)
            • <currency> - currency code
            • <amount> - value
    • <transaction> ( attribute id #IMPLIED ) (*)
      • <date> - transaction datestamp
      • <description> (?) - transaction description
      • <order> ( attribute id #IMPLIED ) (?)
        • <date>
        • <item> (+)
          • <title>
          • <quantitiy>
          • <itemprice>
        • <shipping> (*)
        • <tax> (*)
          • <title>
          • <rate>
      • <amount> - transaction amount
      • <currency> - transaction currency
      • <customerid> ( attribute id #REQUIRED ) - reference to the customer element
    • <customer> ( attribute id #REQUIRED ) (*)
      • <title> (?)
      • <firstname> (?)
      • <lastname> (?)
      • <email> (?)
Legend
(+) - element may occur one or more times.
(*) - element may occur zero or more (*) times.
(?) - element may occur zero or one time.

Sample files


  • EDX v 1.01 sample - Current MagicScripts Products feed
  • EDX v 1.00 sample (Please note the different <product> element schema)

Version History


  • v 1.01 - May 11, 2004
    - Added product options and currency for product prices.
    - Added <transaction> and <customer> elements.
  • v 1.00 - May 7, 2004
    First version, only <company>, <category> and <product> elements supported. No options and currencies for product price.

Comments


EDX DTD is currently under development.
Please use Contact Us page for your comments and suggestions or if you need DTD for your specific needs.