Merchanter API v1.1 - Stock
Discover the key features and functionalities of the Merchanter API v1.1 for efficient stock management and integration.
-
GET operations
-
/Stock/DepotStockOverviews – Retrieve stock information at a depot level for products under the current user account’s ledger
- Parameters
-
/Stock/DepotStockOverviews – Retrieve stock information at a depot level for 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 depot stock overviews and/or stock configurations (for minimum stock level) 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 this stock overview for a special product? true/false
- SellOnline – is this stock overview for an ecommerce product? true/false
- IsEcommerceDepot – is this stock overview for an ecommerce depot? true/false
-
Where – a filter expression string with ANDed filters. Available filters are
-
E.g. Where=IsSpecial==false&&SellOnline==true&&IsEcommerceDepot==true
-
page – page number. Up to 100 depot stock overviews will be returned per call when the page parameter is used e.g. page=1.
- Response schema & body (JSON)
-
page – page number. Up to 100 depot stock overviews will be returned per call when the page parameter is used e.g. page=1.
| Attribute Name | Data Type | Max Length | Notes | Response Body (JSON) |
| Free | Decimal | Available stock quantity |
[ { "Free": 0.000, "IsStockControlled": false, "ProductStockLocation": { "StockConfiguration": { "MinimumStock": 0.000 } }, "Product": { "Code": "" }, "Depot": { "Code": "" } } ] |
|
| IsStockControlled | Boolean | Stock controlled? | ||
| ProductStockLocation | ||||
| - StockConfiguration | Stock configuration info | |||
| - - MinimumStock | Decimal | Minimum stock level | ||
| Product | Product info | |||
| - Code | String | 20 | Product code | |
| Depot | Depot info | |||
| - Code | String | 2 | Depot code |