POST v1/Warehouses/{warehouseId}/StockCount
Creates a StockCount
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| warehouseId |
ID of warehouse for which a StockCount needs to be created |
integer |
Required. |
Body Parameters
Arguments for StockCount
CreateStockCountArguments| Name | Description | Type | Additional information |
|---|---|---|---|
| StockCountGroupId |
Id of stock count group. |
integer |
None. |
| WarehouseLocationIds |
Optional list of WarehouseLocationIDs. Use this list if you don't want to create StockCounts for each WarehouseLocation of the specified warehouse |
Collection of integer |
None. |
| ProductIds |
Optional list of ProductIds. Use this list if you want to limit the products that should be count per WarehouseLocation. Because a StockCount can only be assigned to a single Product and WarehouseLocation, the number of created StockItems is number of products times number of warehouse locations |
Collection of integer |
None. |
| Notes |
Remarks about StockCount |
string |
None. |
Request Formats
application/json, text/json
{
"StockCountGroupId": 1,
"WarehouseLocationIds": [
1,
2
],
"ProductIds": [
1,
2
],
"Notes": "sample string 1"
}
application/xml, text/xml
<CreateStockCountArguments xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<StockCountGroupId>1</StockCountGroupId>
<WarehouseLocationIds>
<int>1</int>
<int>2</int>
</WarehouseLocationIds>
<ProductIds>
<int>1</int>
<int>2</int>
</ProductIds>
<Notes>sample string 1</Notes>
</CreateStockCountArguments>
Response Information
Resource Description
List of StockCounts
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.