Difference between revisions of "AbleCommerce Gold Web Api"
(→Introduction) |
|||
| Line 1: | Line 1: | ||
| − | |||
| − | + | == 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. | 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. | ||
| Line 17: | Line 16: | ||
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: | 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 | Method: GET | ||
| Line 27: | Line 26: | ||
| − | + | === GET api/AdminProducts/{id} === | |
Method: GET | Method: GET | ||
| Line 44: | Line 43: | ||
| − | + | === POST api/AdminProducts === | |
Method: POST | Method: POST | ||
| Line 60: | Line 59: | ||
Description: The new product. Define this parameter in the request body. | Description: The new product. Define this parameter in the request body. | ||
| − | + | === POST api/AdminProducts === | |
Method: POST | Method: POST | ||
| Line 80: | Line 79: | ||
Description: The updated details. Define this parameter in the request body. | Description: The updated details. Define this parameter in the request body. | ||
| − | + | === DELETE api/AdminProducts/{id} === | |
Method: DELETE | Method: DELETE | ||
| Line 96: | Line 95: | ||
Description: The id of the product to delete. Define this parameter in the request URI. | Description: The id of the product to delete. Define this parameter in the request URI. | ||
| − | + | == Products : API DETAILS == | |
| − | + | === GET api/Products === | |
Method: GET | Method: GET | ||
| Line 106: | Line 105: | ||
| − | + | === GET api/Products/{id} === | |
Method: GET | Method: GET | ||
| Line 122: | Line 121: | ||
Description: The id of the product. Define this parameter in the request URI. | Description: The id of the product. Define this parameter in the request URI. | ||
| − | + | == List of Available Fields for AdminProducts == | |
<pre> | <pre> | ||
Id | Id | ||
| Line 165: | Line 164: | ||
</pre> | </pre> | ||
| − | + | == List of Available Fields for Retail Products == | |
<pre> | <pre> | ||
Id | Id | ||
Revision as of 11:16, 21 March 2013
Contents
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
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
List of Available Fields for Retail Products
Id Name Price MSRP Weight Length Width Height Manufacturer Sku ModelNumber ImageUrl ImageAltText Summary Description ExtendedDescription
