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

API Methods

From Developer's API

Revision as of 13:30, 27 May 2008 (view source) Chrisn (Talk | contribs) (→API Method Parameters Matrix) ← Older edit		Revision as of 14:20, 27 May 2008 (view source) Chrisn (Talk | contribs) Newer edit →
Line 116:		Line 116:
	:<sup>6</sup> In the format MM/dd/yyyy [HH:mm:ss]		:<sup>6</sup> In the format MM/dd/yyyy [HH:mm:ss]
		+
		+	== API Results ==
		+
		+	The following page show examples of results that can be returned by the API
		+
		+	[[API_Results]]

---

Revision as of 14:20, 27 May 2008

Calling an API method is done by making a request to a method URI

API Methods are of the form https://{host}/API/{MerchantId}[/{TableName}[/{ItemId}][/{Command}]]

Contents 1 Examples 2 External links 2.1 Clients Methods 2.2 Products Methods 2.3 Orders Methods 2.4 Errors Methods 3 API Parameters 3.1 API Parameter Example 3.2 API Method Parameters Matrix 4 API Results

Examples

https://localhost/API/118303	Returns a list of Group Level methods available to merchant 118303
https://localhost/API/118303/Products	Returns a list Product related methods
https://localhost/API/118303/Products/LIST	Returns a LIST of Products
https://localhost/API/118303/Products/173457882/READ	Returns Product details for ProductId 173457882

External links

Clients Methods

List Clients

Read Client

Products Methods

List Products

Read Product

Orders Methods

List Orders

Count Orders

Read Order

Errors Methods

API Error Codes

API Parameters

API parameters help to specify what data will be returned from the API. Parameters sent to the API are required to be in XML format as shown below. These parameters can be used in conjunction with one another where the method allows a particular parameter. At the very minimum, your merchant key is required as an API parameter when making API calls.

API Parameter Example

<Request>

   <Key>asfa890sduasdf98...</Key>

   <LimitCount>15</LimitCount>

   <LimitOffset>15</LimitOffset>

</Request>

API Method Parameters Matrix

	List Clients	List Products	List Orders	List Errors
Key1	•	•	•	•
Limit Count2	•	•	•	-
Limit Offset	•	•	•	-
Sort Column	•3	-	•4	-
Sort Order5	•	-	•	-
Limit Start Date6	-	-	•	-
Limit End Date6	-	-	•	-

¹ Required for every API call

² Maximum available limit count is 100

³ FirstName, LastName

⁴ GrandTotal

⁵ ASC or DESC

⁶ In the format MM/dd/yyyy [HH:mm:ss]

API Results

The following page show examples of results that can be returned by the API

API_Results