View source for AbleCommerce Gold Web Api

== AbleCommerce Web API ==

=== Introduction === 

AbleCommerce Web API allows you to interact with a subset of the store data. Currently its under development and only can be used to interact with the products data. It offers post / put / delete functionality.


The Web API includes a help documentation generator and test harness. The help documentation can be access using a URL like this:


/api/help


This will list an index of all available functions. Clicking through to one of the functions shows examples. The test buttons on the help pages can be used to specify/send formatted data and read the responses. For detailed and up to date information about API usage check the integrated api help.


For products two controllers are available, one is admin and one is for retail. The admin controller require authorization and ssl, while the retail controller works over plain http and does not require authentication. However it will only let you examine public products. Here is complete list of available functions:

=== AdminProducts : API DETAILS ===

==== GET api/AdminProducts ====
Method: GET

URI: api/AdminProducts 

Description: Gets all products.


==== GET api/AdminProducts/{id} ==== 
Method: GET

URI: api/AdminProducts/{id}

Description: Gets a specific product.


Request Information: Parameters

--

Name: id

Description: Id of the product, define this parameter in the request URI.


==== POST api/AdminProducts ==== 
Method: POST

URI: POST api/AdminProducts

Description: Creates a product


Request Information: Parameters

--

Parameter: product 	

Description: The new product. Define this parameter in the request body.

==== POST api/AdminProducts ==== 
Method: POST

URI: api/AdminProducts/{id} 

Description: Updates a product


Request Information: Parameters

--

Parameter: id 	

Description: The id of the product to update. Define this parameter in the request URI.

Parameter: product 	

Description: The updated details. Define this parameter in the request body.

==== DELETE api/AdminProducts/{id} ==== 
Method: DELETE

URI: api/AdminProducts/{id}

Description: Deletes a product.


Request Information: Parameters

--

Parameter: id 	

Description: The id of the product to delete. Define this parameter in the request URI.

=== Products : API DETAILS ===

==== GET api/Products ==== 
Method: GET

URI: api/Products

Description: Gets all products.


==== GET api/Products/{id} ==== 
Method: GET

URI: api/Products/{id}

Description: Gets a specific product.


Request Information: Parameters

--

Parameter: id 	

Description: The id of the product. Define this parameter in the request URI.

=== List of Available Fields for AdminProducts ===
<pre>
Id
Name
Price
CostOfGoods
MSRP
Weight
Length
Width
Height
Manufacturer
Sku
ModelNumber
TaxCode
Warehouse
InStock
InStockWarningLevel
InventoryMode
ThumbnailUrl
ThumbnailAltText
ImageUrl
ImageAltText
Summary
Description
ExtendedDescription
Vendor
CreatedDate
LastModifiedDate
IsFeatured
IsProhibited
AllowReviews
AllowBackorder
ExcludeFromFeed
DisablePurchase
MinQuantity
MaxQuantity
IsGiftCertificate
WrapGroup
Visibility
Shippable
</pre>

=== List of Available Fields for Retail Products ===
<pre>
Id
Name
Price
MSRP
Weight
Length
Width
Height
Manufacturer
Sku
ModelNumber
ImageUrl
ImageAltText
Summary
Description
ExtendedDescription
</pre>