GET Stocktakes/v1/GetStocktakes?SiteID={SiteID}&StartDateFromUtc={StartDateFromUtc}&EndDateToUtc={EndDateToUtc}&StockLocationID={StockLocationID}

Returns the stocktake info for a given site.

Request Information

URI Parameters

Name	Type	Description	Additional information
SiteID	integer	ID of the site you want the stocktakes for
StartDateFromUtc	date	Optional: used to refine the search range of the stocktakes	None.
EndDateToUtc	date	Optional: used to refine the search range of the stocktakes	None.
StockLocationID	integer	Optional: used to refine the search range of the stocktakes	None.

Body Parameters

None.

Response Information

Resource Description

Collection of StocktakeDto

Name	Type	Additional information
StocktakeID	integer	None.
StockPeriodID	integer	None.
SiteID	integer	None.
StockLocationID	integer	None.
Name	string	None.
StockPeriod	string	None.
StockLocation	string	None.
StocktakeDateUtc	date	None.
ValidationErrorsDetected	boolean	None.
Complete	boolean	None.
LastDateTimeCompletedUtc	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "StocktakeID": 1,
    "StockPeriodID": 2,
    "SiteID": 3,
    "StockLocationID": 4,
    "Name": "sample string 5",
    "StockPeriod": "sample string 6",
    "StockLocation": "sample string 7",
    "StocktakeDateUtc": "2024-11-21T06:23:28.831827+00:00",
    "ValidationErrorsDetected": true,
    "Complete": true,
    "LastDateTimeCompletedUtc": "2024-11-21T06:23:28.831827+00:00"
  },
  {
    "StocktakeID": 1,
    "StockPeriodID": 2,
    "SiteID": 3,
    "StockLocationID": 4,
    "Name": "sample string 5",
    "StockPeriod": "sample string 6",
    "StockLocation": "sample string 7",
    "StocktakeDateUtc": "2024-11-21T06:23:28.831827+00:00",
    "ValidationErrorsDetected": true,
    "Complete": true,
    "LastDateTimeCompletedUtc": "2024-11-21T06:23:28.831827+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfStocktakeDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.StockMid.Core.Models.StockPeriods.Dto">
  <StocktakeDto>
    <Complete>true</Complete>
    <LastDateTimeCompletedUtc>2024-11-21T06:23:28.831827+00:00</LastDateTimeCompletedUtc>
    <Name>sample string 5</Name>
    <SiteID>3</SiteID>
    <StockLocation>sample string 7</StockLocation>
    <StockLocationID>4</StockLocationID>
    <StockPeriod>sample string 6</StockPeriod>
    <StockPeriodID>2</StockPeriodID>
    <StocktakeDateUtc>2024-11-21T06:23:28.831827+00:00</StocktakeDateUtc>
    <StocktakeID>1</StocktakeID>
    <ValidationErrorsDetected>true</ValidationErrorsDetected>
  </StocktakeDto>
  <StocktakeDto>
    <Complete>true</Complete>
    <LastDateTimeCompletedUtc>2024-11-21T06:23:28.831827+00:00</LastDateTimeCompletedUtc>
    <Name>sample string 5</Name>
    <SiteID>3</SiteID>
    <StockLocation>sample string 7</StockLocation>
    <StockLocationID>4</StockLocationID>
    <StockPeriod>sample string 6</StockPeriod>
    <StockPeriodID>2</StockPeriodID>
    <StocktakeDateUtc>2024-11-21T06:23:28.831827+00:00</StocktakeDateUtc>
    <StocktakeID>1</StocktakeID>
    <ValidationErrorsDetected>true</ValidationErrorsDetected>
  </StocktakeDto>
</ArrayOfStocktakeDto>