Search Help:  
 
Enter keywords to search help.

Real-Time Delivery of Orders to Your Web Server

Use this system if you have a web server and want orders received through your store delivered to you in real time over the Internet, or if you are using services you wish to make real-time order posts to. You may make real-time order posts to up to 5 URLs.

Real-time order posts may be set up using the Real-Time Links Settings page, located in the Real-Time Links section of Store Manager. Note: This feature is not available with Merchant Solutions Starter plans.

You must specify a URL (starting with https: if you wish to receive the full order information) and a format. You may select a format for each URL you make order posts to. We recommend the Yahoo! or XML formats, which are very easy to parse with a simple CGI script. The system also supports the OBI (Open Buying on the Internet) standard for transferring orders. Note: If you deliver order to a non-secure web server (not https) credit card numbers will be masked to ensure data security.

An order in the Yahoo! Format consists of key-value pairs, delivered in an HTTP POST request to the specified URL. Example keys are Ship-Name, Card-Number, and Item-Description-1. See the full documentation and example CGI script for details.

The Real-Time Delivery XML option uses the same XML format as the order-notification XML email that you can select in the Email section of your Store Manager.

In this case, however, only one order will be sent. Learn more about our XML format here: Exporting Orders as XML. Please note: The XML order delivery option currently does not provide PayPal transaction ID information.

The OBI/1.1 protocol is documented in the Open Buying specification. Orders and catalog requests are delivered as OBI Orders (not order requests) to the URLs you specify.

To configure real-time delivery:

  1. Sign in to the Store Manager
  2. Click "Real-Time Links" appearing under Order Settings.
  3. Enter the URL of your CGI script to receive orders or catalog requests in the appropriate fields. Example:
https://www.myname.com/cgi-bin/receive-yahoo-order.

  1. Select an order format from the drop down menu:
    • Yahoo! Format: consists of key-value pairs, delivered in an HTTP POST request to the specified URL. Learn more.
    • ECML: electronic commerce markup language. Learn more.
    • XML: uses the same XML format as the order-notification XML email that you can select in the Email section of your Store Manager. Learn more.
    • OBI: (Open Buying on the Internet)OBI/1.1 protocol. Learn more.
  2. Choose a delivery rate:
    • Fast Delivery in parallel: (default) select to receive up to 15 orders at once.
    • One at a time: select if you will not receive multiple orders at once or if your system has trouble handling multiple orders at once.
  3. Click "Update" when finished.
  4. Click "Publish Order Settings" to publish your changes.

The system will try to repost the order to your server every 15 minutes for up to 12 hours. If the posting fails, an error notification email will be sent to the email address entered in the Email field of the Order System Settings page accessed by clicking the "Email" link in the Order Settings column.

Note: If you require firewall restrictions on access to your web server, add the IP ranges for real-time integrations.

We will add new keys to this format as required to support new features. Software at the receiving end should ignore unrecognized keys.

Was this article helpful?

Yes   No
Click to contact Customer Care for further assistance.