Product
Individual product/ SKU to be tracked/ monitored
POST /controllers/product.ashx
| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Name of the product - unique |
| SKU | String | Yes | SKU - unique |
| UPC | String | No | SKU - unique |
| ShortName | String | Yes | Short name of the product |
| ShortEANCode | String | No | Short EAN Code |
| ProductGTIN | String | No | Product GTIN |
| IsActive | Booelean | No | Is product active - default Yes |
| BrandId | int | No | Brand of the product |
Note
- You can use BrandName instead of BrandId
- If the brand is configured to be owned by a foreign manufacturer, product will be marked as Foreign
- There are additional attributes at product that are sparingly used and not listed at the moment. This includes
- Product category
- Product type
- Product pricing is based on the size and passed as JSON. If you are using the API to update product pricing, reach out to support for examples
🧩 Product List Summary API (Response)​
GET /Controllers/Product.ashx?action=list&start=0&limit=50&asArray=0
Product List Summary information about products, including identifiers, packaging, classification, images, and branding used for cataloging, inventory, display purposes.
| Property | Type | Description |
|---|---|---|
| ProductId | Integer | Unique identifier for the product |
| Product | String | Full name of the product |
| ShortName | String | Short display name |
| SKU | String | Stock Keeping Unit |
| UPC | String | Universal Product Code |
| ProductGTIN | String | Global Trade Item Number |
| ShortEANCode | String | Short version of the EAN |
| ExternalProductCode | String | External system product mapping code |
| ProductCategoryId | Integer | Main product category ID |
| ProductCategory | String | Name of the main category |
| ProductSecondCategoryId | Integer | Secondary category ID |
| ProductSecondCategory | String | Name of the secondary category |
| BeverageType | String | Type of beverage (e.g. Bottle, Can) |
| IsKeyProduct | Boolean | Indicates if product is a key SKU |
| IsForeign | Boolean | Product is imported |
| IsEmpty | Boolean | Represents if product is marked as empty |
| IsUnknown | Integer | Unknown flag (0 = No, 1 = Yes) |
| IsImage | Integer | Indicates if the product has images |
| BrandId | Integer | Brand ID |
| BrandName | String | Brand name |
| ManufacturerId | Integer | Manufacturer ID |
| Manufacturer | String | Manufacturer name |
| DistributorId | Integer | Distributor ID |
| DistributorName | String | Distributor name |
| DistributorGTIN | String | GTIN identifier for the distributor |
| PackagingTypeId | Integer | Packaging type ID |
| PackagingType | String | Packaging type name |
| MeasurementUnitTypeId | Integer | Measurement unit type ID |
| MeasurementUnit | String | Measurement unit label |
| Width | Float | Product width |
| Height | Float | Product height |
| PackagingHeight | Float | Height of product packaging |
| PackagingWidth | Float | Width of product packaging |
| ProductImageCount | Integer | Total product image count |
| FrontImageCount | Integer | Number of front-view images |
| BackImageCount | Integer | Number of back-view images |
| LSideImageCount | Integer | Number of left-side images |
| RSideImageCount | Integer | Number of right-side images |
| TopImageCount | Integer | Number of top-view images |
| BottomImageCount | Integer | Number of bottom-view images |
| LastImageModifiedOn | String | Timestamp of last image update |
| FontStyle | String | Font style used in UI |
| FontColor | String | Font color hex code |
| GraphColor | String | Color code used in charts/visuals |
| Tags | String | Product tags |