Merchanter API v1.1 - Products
Discover how to effectively utilise the Merchanter API v1.1 for managing and optimising your product offerings.
Written by Ian Oldrey
Updated at June 18th, 2026
-
GET operations
- /Products – Retrieve information relating to products under the current user account’s ledger
-
HTTP header type
- If-Modified-Since – a UTC timestamp (format ‘yyyy-MM-dd HH:mm:ss’). Only products that have been created or modified since this timestamp will be returned
-
Query type
-
Where – a filter expression string with ANDed filters. Available filters are
- IsSpecial – is the product a special (special products are usually non-stock items for one-off sales)? true/false
- SellOnline – is this an ecommerce product? true/false
- E.g. Where=IsSpecial==false&&SellOnline==true
-
includePrices – should customer price band prices be included in the response?
- _false – no (default)
- _true - yes
-
page – page number. Up to 100 products will be returned per call when the page parameter is used e.g. page=1.
- Response schema & body (JSON)
-
Where – a filter expression string with ANDed filters. Available filters are
| Attribute Name | Data Type | Max Length | Notes | Response Body (JSON) |
| ID | String | 20 | Object ID |
[ { “ID”: “”, "Code": "", "Description": "", "LiveStatus": "", "ProductType": "", "StockUoM": "", "StockDecimalPrecision": "", "BoxFactor": 0, “WeightFactor”: 0.000, “WeightFactorPer”: “”, “WeightFactorUoM”: “”, “BasePrice”: 0.00, “VATRate”: 0.00, "IsStockControlled": false, "IsSpecial": false, "SellOnline": false, "ProductGroup": { "Name": "", "ShortName": "" }, "ProductSubGroup": { "Name": "", "ShortName": "" }, "SupplierProductCodes": [ { "Code": "", "Supplier": { "Code": "" } } ], "PreferredSupplier": { "Code": "" }, “ProductPrices”: [ { “PriceBandCode”: “”, “Price”: 0.00 } ], “Species”: { “Name”: “” }, “ProductTags”: [ { “Name”: “” } ], “changedDate”: “1900-01-01T00:00:00.000Z”, "EcommerceDescription": "", “ProductCategory”: { “Name”: “”, “ShortName”: “” }, “EcommerceAttributes”: “” } ] |
| Code | String | 20 | Product code | |
| Description | String | Full product description | ||
| LiveStatus | String | See enumerated type ProductRecordStatus | ||
| ProductType | String | See enumerated type ProductTypes | ||
| StockUoM | String | Primary stock unit of measure – see enumerated type UnitOfMeasureName | ||
| StockDecimalPrecision | String | Decimal precision of stock – see enumerated type DecimalPrecision | ||
| BoxFactor | Integer | Number of units per box | ||
| WeightFactor | Decimal | |||
| WeightFactorPer | String | Weight factor per – see enumerated type UnitOfMeasureName | ||
| WeightFactorUoM | String | Weight factor unit of measure – see enumerated type UnitOfMeasureName | ||
| BasePrice | Decimal | Base selling price (per stock unit of measure) | ||
| VATRate | Decimal | VAT rate percentage | ||
| IsStockControlled | Boolean | Are stock holdings maintained for this product? | ||
| IsSpecial | Boolean | Is this a special product? | ||
| SellOnline | Boolean | Is this an ecommerce product? | ||
| ProductGroup | ||||
| - Name | String | 40 | Full name of product analysis group | |
| - ShortName | String | 20 | Shorter name of product analysis group | |
| ProductSubGroup | ||||
| - Name | String | 40 | Full name of product analysis subgroup | |
| - ShortName | String | 20 | Shorter name of product analysis subgroup | |
| SupplierProductCodes (array) | ||||
| - Code | String | 200 | Supplier product code | |
| - Supplier | ||||
| - - Code | String | 50 | Supplier account code | |
| PreferredSupplier | ||||
| - Code | String | 50 | Supplier account code | |
| ProductPrices (array) | Prices for each customer price band | |||
| - PriceBandCode | String | 2 | Price band code | |
| - Price | Decimal | Nett price (per stock unit of measure) for price band | ||
| Species | ||||
| - Name | String | 200 | ||
| ProductTags (array) | Descriptive tag(s) | |||
| - Name | String | 40 | ||
| changedDate | Datetime | Date & time of last update (UTC) | ||
| EcommerceDescription | String | Ecommerce description for product (short description) | ||
| ProductCategory | ||||
| - Name | String | 40 | Full name of product analysis category | |
| - ShortName | String | 20 | Shorter name of product analysis category | |
| EcommerceAttributes | String | Free text to specify extra webshop attributes and their values. |
-
/Products/{key} – Retrieve information relating to a specific product via its key
- Parameters
-
Path type
-
key – either the ID of the object (if preceded by ID=) or the product code
- Response schema & body – see above
-
key – either the ID of the object (if preceded by ID=) or the product code