GET v1/Warehouses/{warehouseId}/StockCount?PageSize={PageSize}&PageNumber={PageNumber}&StockCountGroupId={StockCountGroupId}&IsPlanned={IsPlanned}&IsStarted={IsStarted}&IsClosed={IsClosed}&IsFinalized={IsFinalized}&IsHandover={IsHandover}
Search for stock counts
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| warehouseId |
Id of warehouse |
integer |
Required. |
| PageSize |
Specifies how many records should be returned per page |
integer |
Range: inclusive between 5 and 999 |
| PageNumber |
Page number |
integer |
Range: inclusive between 1 and 2147483647 |
| StockCountGroupId |
Optionally constraint search to a stock count group |
integer |
None. |
| IsPlanned |
Optionally constraint results to whether the stock count is planned. |
boolean |
None. |
| IsStarted |
Optionally constraint results to whether the stock count is started. |
boolean |
None. |
| IsClosed |
Optionally constraint results to whether the stock count is closed. |
boolean |
None. |
| IsFinalized |
Optionally constraint results to whether the stock count is finalized |
boolean |
None. |
| IsHandover |
Optionally constraint results to whether handover of stock count was acknowledged |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
List of stock counts
Collection of StockCount| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
If of stock count record |
integer |
None. |
| StockCountGroup |
Stock count group |
StockCountGroup |
None. |
| WarehouseLocation |
Location for which the stock count needs to be performed |
WarehouseLocationBasicInfo |
None. |
| Note |
Stock count remarks |
string |
None. |
| CreatedTimestamp |
When stock count was created |
date |
None. |
| CreatedBy |
Employee who created the stock count |
EmployeeMinimalInfo |
None. |
| HandoverTimestamp |
Date when handover of stock count was acknowledged |
date |
None. |
| PlannedTimestamp |
Date when stock count was planned |
date |
None. |
| StartTimestamp |
Date when stock count was started. Can also be set after first count. |
date |
None. |
| CloseTimestamp |
Date when stock count was closed |
date |
None. |
| FinalyzeTimestamp |
Date when stock count was finalized |
date |
None. |
| FinalizedBy |
Employee who finalized the stock count |
EmployeeMinimalInfo |
None. |
| Items |
Items that should be counted |
Collection of StockCountItem |
None. |
Response Formats
application/json, text/json
Sample not available.