API Methods

From Developer's API

Revision as of 13:28, 27 May 2008 by Chrisn (Talk | contribs)

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/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 Date - - • -
Limit End Date - - • -
1 Required for every API call
2 Maximum available limit count is 100
3 FirstName, LastName
4 GrandTotal
5 ASC or DESC
Retrieved from "http://api.1shoppingcart.com/index.php?title=API_Methods"