This API call lets you add or edit a product. The response is an XML of adding/editing a product.
Request Fields
| Field Name |
Type |
Required |
Description |
| action |
String |
Yes |
productEdit |
| accountId |
Integer |
Yes |
The Helcim Commerce account ID. |
| apiToken |
String |
Yes |
API token used for authentication and access control. |
| name |
String |
Yes |
The product name. |
| productId |
Integer |
No |
If you do not enter a product ID, you will add a product. If you do enter a product ID, you will edit an existing product. |
| categoryId |
Integer |
No |
The category ID. |
| brandId |
Integer |
No |
The brand ID. |
| description |
String |
No |
The product description. |
| SKU |
Integer |
No |
The product SKU. |
| barcode |
String |
No |
The product barcode. |
| availability |
Integer |
No |
1 or 0 - Whether the product is available for sale. |
| availabilityOnline |
Integer |
No |
1 or 0 - Whether the product is available for sale online. |
| featured |
Integer |
No |
1 or 0 - Whether the product is featured (front page) item online. |
| price |
Decimal |
No |
The product price. |
| salePrice |
Decimal |
No |
The product sale price. |
| weight |
Decimal |
No |
The product weight - based on Helcim Commerce Unit of Measurement (UoM) account settings. |
| dimensionW |
Decimal |
No |
The product width- based on Helcim Commerce Unit of Measurement (UoM) account settings. |
| dimensionL |
Decimal |
No |
The product length - based on Helcim Commerce Unit of Measurement (UoM) account settings. |
| dimensionH |
Decimal |
No |
The product height - based on Helcim Commerce Unit of Measurement (UoM) account settings. |
| shippingExempt |
Integer |
No |
1 or 0 - Whether the product is exempt from shipping fees. |
| taxExempt |
Integer |
No |
1 or 0 - Whether the product is exempt from taxes. |
| unitOfMeasure |
String |
No |
The unit of measurement. |
| commodityCode |
String |
No |
The commodity code. |
| seoURL |
String |
No |
The SEO URL location. |
| seoDescription |
String |
No |
The SEO description. |
| seoTags |
String |
No |
The SEO tags. |
Response Fields
| Field Name |
Type |
Description |
| message |
- |
XML structure |
| response |
Integer |
1 or 0. Whether the product was added/edited or not. |
| responseMessage |
String |
Confirmation of completed inventory update. |
| product |
- |
XML structure |
| id |
Integer |
The product ID. |
| name |
String |
The product name. |
| SKU |
Integer |
The product SKU. |
| stock |
Integer |
The available units of the product. |
| price |
Decimal |
The product price. |
| salePrice |
Decimal |
The product sale price. |
| availability |
Integer |
1 or 0 - Whether the product is available for sale. |
| availabilityOnline |
Integer |
1 or 0 - Whether the product is available for sale online. |
Errors
For all API requests, there are also generic API authentication and user access restriction errors.
| Response Code |
Error Code |
Message |
Description |
| 0 |
- |
Invalid Product ID |
The product ID you provided could not be found. |
| 0 |
- |
Product Limit Reached |
Cannot add a new product. |
| 0 |
- |
Missing Field - Product Name |
The product name is missing. |
| 0 |
- |
SKU Already Used by Another Product |
SKU code is already being used for another product. |
| 0 |
- |
Invalid API Token1 |
The API Token is invalid, or not entered. |
| 0 |
- |
Missing or Invalid Fields - Account ID |
The Account ID is invalid, or not entered. |
