POST api/v1/WH_BinStock

Retrieve details of all products with stock in a list of supplied bins

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_BinStock_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_BinStock_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
503 Service Unavailable

WH_BinStocks

Name	Description	Type	Additional information
WH_BinStock		Collection of WH_BinStock	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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