• Navigation
  • Welcome
  • Getting Started
  • API Methods
  • API Notifications
  • API Usage Limits
  • Sample Code
  • Recent changes
  • Help

API Notifications

From Developer's API

Revision as of 17:47, 26 May 2008 (view source) Chrisn (Talk | contribs) (→Diagram Explained) ← Older edit		Revision as of 17:49, 26 May 2008 (view source) Chrisn (Talk | contribs) (→New Orders) Newer edit →
Line 20:		Line 20:
	===New Orders===		===New Orders===
		+	New order notification is sent when a new order has been placed for your merchant account.
		+
		+	The data contained in a new order notification is as follows:
		+
		+	<NewOrder><Token>{Token Value}</Token></NewOrder>

---

Revision as of 17:49, 26 May 2008

The 1ShoppingCart notification system sends messages via https of new events ¹ that have taken place on your 1ShoppingCart merchant account. A message is created in XML and sent to a user configurable URL. The notification data can then be used to call the API and retrieve specific information, such as the details of a new order.

API Notifications Overview

The following diagram shows the typical flow of data when the 1ShoppingCart API sends a new event notification.

Diagram Explained

1. When a new event¹ is generated in your merchant account a notification token is prepared and sent over https to your notification url
2. The notification request sent from the 1ShoppingCart API contains XML in the request body and holds the event type and token within its nodes
3. Parse the event type and token values from the XML then call the API wrapper method corresponding to the event type to retrieve the detailed information
4. The API wrapper will prepare the request to the 1ShoppingCart API and send the request over http
5. The API will parse out the merchant id, merchant key and token value from the request and prepare the requested data.
6. The API will send the prepared data back over https to the API wrapper
7. The API wrapper receives the requested data back from the API as XML
8. The notification listener receives the XML data from the API wrapper where it can verify the success attribute of the response node
9. Add functionality to support your business processes. for example you can parse the ShippingInfo node and prepare shipping labels.

¹ Currently the following events support API notification:

• New orders

New Orders

New order notification is sent when a new order has been placed for your merchant account.

The data contained in a new order notification is as follows:

<NewOrder><Token>{Token Value}</Token></NewOrder>