Data Feeds (orders)
Here you will learn how to use order data feeds via your website administration panel. These feeds are intended for admin use only! Customers have access to their own feed via the customer dashboard.
Step-by-step guide
RSS Feed
The RSS feed is intended to provide real time updates using an rss reader and takes very little technical knowledge to use.
example rss url: admin.yourwebsiteaddress.com/orders/data-feed.html?key=bdaa6527a5gd33nuta4739375d704369330b0d26bae&group=1
Login to your administration panel admin.yourwebsiteaddress.com
Click "Common Links" at the top of any page
Click "RSS Order Feed"
Copy the url and paste into your favorite rss reader
That's it!
XML Feed (advanced use cases)
The XML feed is intended for more advanced use cases and is intended for those that have the technical ability to use the data provided from the feed.
example xml url: admin.yourwebsiteaddress.com/orders/data-feed.html?key=bdaa6527a5gd33nuta4739375d704369330b0d26bae&group=1&format=xml&max=2&offset=0
5 parameters can be accepted and are outlined below
*key – This is what allows access the system without providing admin login credentials.
*group – This is the acl role group id. You will more than likely always use “1” which is the admin role but this parameter allows the ability for flexibility…maybe you want sales reps to only see their feed...the possibilities are endless.
format (optional) – Currently accepts “rss” and “xml”. If no format is provided it will default to the rss feed.
max (optional) – Limits the returned results for pagination purposes. if not provided will default to 25
offset (optional) - Offsets the returned results for pagination purposes. if not provided will default to 0
Pagination Example &max=100&offset=25 <- will return 100 items starting at the 25th result, giving you records 25 through 125
*key and group can be obtained by following steps 1-4 outlined for the rss feed. From that point you can get the key and current group id from the url.
XML Feed Output Example
<joblist>
<jobsummary>
<jobnumber>11072017.GCDF-01</jobnumber>
<turnaround>5.5 DAYS</turnaround>
<customername>Mary Ann</customername>
<status>Pending</status>
<total>$21.07</total>
<unpaid>$21.07</unpaid>
<rep>Bart.S</rep>
<url>
http://admin.yourwebsiteaddress.com/orders/order_detail.html/2249879060?key=bdaa6527a5gd33nuta4739375d704369330b0d26bae&format=xml
</url>
<orderdate>Tue, 07 Nov 2017 19:21:45 -0500</orderdate>
</jobsummary>
<jobsummary>
<jobnumber>11072017.CJKW-02</jobnumber>
<turnaround>5.5 DAYS</turnaround>
<customername>Mary Ann</customername>
<status>Approved</status>
<total>$22.72</total>
<unpaid>$0.00</unpaid>
<rep>Bart.S</rep>
<url>
http://admin.yourwebsiteaddress.com/orders/order_detail.html/2249879060?key=bdaa6527a5gd33nuta4739375d704369330b0d26bae&format=xml
</url>
<orderdate>Tue, 07 Nov 2017 19:20:01 -0500</orderdate>
</jobsummary>
</joblist>
If the page doesnt load and you get an acl warning you may need to update the acl!