POST v{version}/OnlineOrders/GetStockCount

Retrieve current stock level for Product IDs specified.

Request Information

URI Parameters

Name Type Description Additional information
version string

None.

Body Parameters

GetStockCountApiModel
Name Type Description Additional information
SiteID integer

Required
ProductIDs Collection of integer

Leave blank for all ProductID's

Required

Request Formats

application/json, text/json

Sample: 
{
  "SiteID": 1,
  "ProductIDs": [
    1,
    2
  ]
}

application/xml, text/xml

Sample: 
<GetStockCountApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.SignalR.Commands">
  <ProductIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ProductIDs>
  <SiteID>1</SiteID>
</GetStockCountApiModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetStockCountResponseDto
Name Type Description Additional information
ProductResponseDtos Collection of GetStockCountProductResponseDto

None.

Response Formats

application/json, text/json

Sample: 
{
  "ProductResponseDtos": [
    {
      "ProductID": 1,
      "ProductName": "sample string 2",
      "Count": 3.0,
      "LowStock": true
    },
    {
      "ProductID": 1,
      "ProductName": "sample string 2",
      "Count": 3.0,
      "LowStock": true
    }
  ]
}

application/xml, text/xml

Sample: 
<GetStockCountResponseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.SignalR.Commands">
  <ProductResponseDtos>
    <GetStockCountProductResponseDto>
      <Count>3</Count>
      <LowStock>true</LowStock>
      <ProductID>1</ProductID>
      <ProductName>sample string 2</ProductName>
    </GetStockCountProductResponseDto>
    <GetStockCountProductResponseDto>
      <Count>3</Count>
      <LowStock>true</LowStock>
      <ProductID>1</ProductID>
      <ProductName>sample string 2</ProductName>
    </GetStockCountProductResponseDto>
  </ProductResponseDtos>
</GetStockCountResponseDto>