POST api/v1/RunningDownItemsWithStock

Returns a collection of products which are set to discontinued running down stock
Optionally the results can be restricted to just items which have physical stock

Request Information

URI Parameters

None.

Body Parameters

RDSWithStockItemsParams

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
OnlyWithStock	If true , only return items with non zero physical stock	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "OnlyWithStock": true,
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample:

<RDSWithStockItemsParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OnlyWithStock>true</OnlyWithStock>
  <apiKey>sample string 1</apiKey>
</RDSWithStockItemsParams>

Response Information

Resource Description

Returns:
200 OK Returns collection of product id's and codes
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if no products were updated or added since the date supplied

RDSWithStockItems

Name	Description	Type	Additional information
RDSWithStockItemList		Collection of RDSWithStockItem	None.

Response Formats

application/json, text/json

Sample:

{
  "RDSWithStockItemList": [
    {
      "ID": 1,
      "Code": "sample string 2",
      "Description": "sample string 3",
      "Cost_Valuation": 4.0,
      "StockQty": 5
    },
    {
      "ID": 1,
      "Code": "sample string 2",
      "Description": "sample string 3",
      "Cost_Valuation": 4.0,
      "StockQty": 5
    }
  ]
}

application/xml, text/xml

Sample:

<RDSWithStockItems xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RDSWithStockItem>
    <ID>1</ID>
    <Code>sample string 2</Code>
    <Description>sample string 3</Description>
    <Cost_Valuation>4</Cost_Valuation>
    <StockQty>5</StockQty>
  </RDSWithStockItem>
  <RDSWithStockItem>
    <ID>1</ID>
    <Code>sample string 2</Code>
    <Description>sample string 3</Description>
    <Cost_Valuation>4</Cost_Valuation>
    <StockQty>5</StockQty>
  </RDSWithStockItem>
</RDSWithStockItems>