API Methods

From Developer's API

(Difference between revisions)
(API Method Parameters Matrix)
Line 1: Line 1:
Something here...
+
Calling an API method is done by making a request to a method URI
  
 +
API Methods are of the form
 +
<b><nowiki>https://{host}/API/{MerchantId}[/{TableName}[/{ItemId}][/{Command}]]</nowiki></b>
 +
 +
===Examples===
 +
{| border="1" cellpadding="2"
 +
|-valign="top"
 +
| <nowiki>https://localhost/API/32012</nowiki>
 +
| Returns a list of Group Level methods available to merchant 32012
 +
|-valign="top"
 +
| <nowiki>https://localhost/API/32012/Products</nowiki>
 +
| Returns a list Product related methods
 +
|-valign="top"
 +
| <nowiki>https://localhost/API/32012/Products/LIST</nowiki>
 +
| Returns a LIST of Products
 +
|-valign="top"
 +
| <nowiki>https://localhost/API/32012/Products/173457882/READ </nowiki>
 +
| Returns Product details for ProductId 173457882
 +
|}
 +
 +
 
===Clients Methods===
 
===Clients Methods===
 
:[[List Clients]]
 
:[[List Clients]]

Revision as of 17:51, 26 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

Examples

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


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 Method Parameters Matrix

List Clients List Products List Orders List Errors
Limit Count -
Limit Offset -
Sort Column 1 - 2 -
Sort Order - -
Limit Start Date - - -
Limit End Date - - -
1 FirstName, LastName
2 GrandTotal