Skip to main content (Press Enter)
Helcim Logo
Click here if you return to contents

List Products

This API call let's you retrieve a product. The response is an XML of the product's information.

Request Fields

Field Name Type Required Description
action String Yes productView
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control.

Response Fields

Field Name Type Description
products - XML structure
product - XML structure
id Integer The product ID.
name String The product name.
sku String The product SKU.
stock Integer The number of items in stock.
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.
picture String The URL location of the product picture.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.

Response Code Error Code Message Description
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.

Related Articles

View a Product
Add or Edit a Product
Update Product Inventory
View a Category
List Categories
View a Brand
List Brands

Was this article helpful?

Feedback submitted - Thank you!
Click here if you return to the content