POST api/v1/WH_ProductStock

Retrieve details of all bins containing stock of a list of supplied products

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
WarehouseID		integer	Required
IDList		string	None.
CodeList		string	None.

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "WarehouseID": 2,
  "IDList": "sample string 3",
  "CodeList": "sample string 4"
}

application/xml, text/xml

Sample:

<WH_ProductStock_Params xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <WarehouseID>2</WarehouseID>
  <IDList>sample string 3</IDList>
  <CodeList>sample string 4</CodeList>
</WH_ProductStock_Params>

Response Information

Resource Description

Returns:
200 OK Returns a collection of product stock data
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if the requested product code or product id don't exist
503 Service Unavailable

WH_ProductStocks

Name	Description	Type	Additional information
WH_ProductStock		Collection of WH_ProductStock	None.

Response Formats

application/json, text/json

Sample:

{
  "WH_ProductStock": [
    {
      "ItemNo": "sample string 1",
      "ItemID": 2,
      "WH_ProductStock_Bins": [
        {
          "BinID": 1,
          "ComputedBin": "sample string 2",
          "QtyFree": 3.0,
          "QtyRes": 4.0,
          "QtyPicked": 5.0
        },
        {
          "BinID": 1,
          "ComputedBin": "sample string 2",
          "QtyFree": 3.0,
          "QtyRes": 4.0,
          "QtyPicked": 5.0
        }
      ]
    },
    {
      "ItemNo": "sample string 1",
      "ItemID": 2,
      "WH_ProductStock_Bins": [
        {
          "BinID": 1,
          "ComputedBin": "sample string 2",
          "QtyFree": 3.0,
          "QtyRes": 4.0,
          "QtyPicked": 5.0
        },
        {
          "BinID": 1,
          "ComputedBin": "sample string 2",
          "QtyFree": 3.0,
          "QtyRes": 4.0,
          "QtyPicked": 5.0
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<WH_ProductStocks xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WH_ProductStock>
    <ItemNo>sample string 1</ItemNo>
    <ItemID>2</ItemID>
    <WH_ProductStock_Bins>
      <WH_ProductStock_Bin>
        <BinID>1</BinID>
        <ComputedBin>sample string 2</ComputedBin>
        <QtyFree>3</QtyFree>
        <QtyRes>4</QtyRes>
        <QtyPicked>5</QtyPicked>
      </WH_ProductStock_Bin>
      <WH_ProductStock_Bin>
        <BinID>1</BinID>
        <ComputedBin>sample string 2</ComputedBin>
        <QtyFree>3</QtyFree>
        <QtyRes>4</QtyRes>
        <QtyPicked>5</QtyPicked>
      </WH_ProductStock_Bin>
    </WH_ProductStock_Bins>
  </WH_ProductStock>
  <WH_ProductStock>
    <ItemNo>sample string 1</ItemNo>
    <ItemID>2</ItemID>
    <WH_ProductStock_Bins>
      <WH_ProductStock_Bin>
        <BinID>1</BinID>
        <ComputedBin>sample string 2</ComputedBin>
        <QtyFree>3</QtyFree>
        <QtyRes>4</QtyRes>
        <QtyPicked>5</QtyPicked>
      </WH_ProductStock_Bin>
      <WH_ProductStock_Bin>
        <BinID>1</BinID>
        <ComputedBin>sample string 2</ComputedBin>
        <QtyFree>3</QtyFree>
        <QtyRes>4</QtyRes>
        <QtyPicked>5</QtyPicked>
      </WH_ProductStock_Bin>
    </WH_ProductStock_Bins>
  </WH_ProductStock>
</WH_ProductStocks>