Read current stock data

You use this method to read one or more current stock values.

Request method

GET

Request url

https://ponte.venice.be/webconnect/api/{DossierId}/CurrentStock?{Key}={KeyValues}[&fields={FieldList}]

Context identification

Identification Description
DossierId The unique identifier of the dossier.

Parameters

Parameter Description
{Key} The available keys to seek one or more Current Stock:
  • ArticleNumber={ArticleNumber}: Gets the current stock by article number (all warehouses, locations, serialnumbers combined).
  • Warehouse={ArticleNumber}<tab>{Warehouse}: Gets the current stock for an article in a warehouse.
  • Location={ArticleNumber}<tab>{Warehouse}<tab>{Location}: Gets the current stock for an article in a warehouse and location.
  • LocationSerialNumber={ArticleNumber}<tab>{Warehouse}<tab>{Location}<tab>{SerialNumber}: Gets the current stock for an article with a serial number in a warehouse and location.
UseStockArticle Should the current stock of the stock article of the given article be used to fetch the current stock. (optional, default true)
Fields List of fields, containing property names of the current stock, of which the value has to be returned in the response body. (optional)
Example 1: Get the current stock fields, limited to the stock number ('StockNumber'), the stock ('Stock') and the last active year ('LastActiveYear'), for article number 'MyArticle' in dossier 'Demo'. 
https://ponte.venice.be/WebConnect/api/Demo/CurrentStock?ArticleNumber=MyArticle&fields=StockNumber,Stock,LastActiveYear
Example 2: Get the current stock in Warehouse 'WH1' for article number 'MyArticle'. 
https://ponte.venice.be/WebConnect/api/Demo/CurrentStock?Warehouse=MyArticle%09WH1
Example 3: Get the current stock in Warehouse 'WH1' in location 'ZoneA' for article number 'MyArticle', but only for this specific article and not the stock article. 
https://ponte.venice.be/WebConnect/api/Demo/CurrentStock?Location=MyArticle%09WH1%09ZoneA&UseStockArticle=False
Example 4: Get the current stock in Warehouse 'WH1' in location 'ZoneA' for article number 'MyArticle' with serial number 'Ser_001'. 
https://ponte.venice.be/WebConnect/api/Demo/CurrentStock?LocationSerialNumber=MyArticle%09WH1%09ZoneA%09Ser_001

Request header

See request header.

Request body

-

Http status

See http status.

Response body

You can receive the response in json or xml.

Structure

Response (object)
  • (array)

Examples

{
  "Response": {
    "CurrentStocks": {
      "CurrentStock": [
        {
          "ArticleNumber": "MyArticle",
          "Fields" : {
            "StockNumber": "MyStockArticle",
            "Stock": "500.0",
            "LastActiveYear": "2021"
          }
        }
      ]
    }
  }
}

{
  "Response": {
    "CurrentStocks": {
      "CurrentStock": [
        {
          "ArticleNumber": "MyArticle",
          "Fields" : {
            "Location": "- ALL -",
            "Serial": "- ALL -",
            "StockNumber": "MyStockArticle",
            "Stock": "120.0",
            "Warehouse": "WH1",
            ...
          }
        }
      ]
    }
  }
}

{
  "Response": {
    "CurrentStocks": {
      "CurrentStock": [
        {
          "ArticleNumber": "MyArticle",
          "Fields" : {
            "Location": "ZoneA",
            "Serial": "- ALL -",
            "StockNumber": "MyArticle",
            "Stock": "72.0",
            "Warehouse": "WH1",
            ...
          }
        }
      ]
    }
  }
}

{
  "Response": {
    "CurrentStocks": {
      "CurrentStock": [
        {
          "ArticleNumber": "MyArticle",
          "Fields" : {
            "Location": "ZoneA",
            "Serial": "Ser_001",
            "StockNumber": "MyStockArticle",
            "Stock": "8.0",
            "Warehouse": "WH1",
            ...
          }
        }
      ]
    }
  }
}

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <CurrentStocks>
    <CurrentStock>
      <ArticleNumber>MyArticle</ArticleNumber>
      <Fields>
        <StockNumber>MyStockArticle</StockNumber>
        <Stock>500.0</Stock>
        <LastActiveYear>2021</LastActiveYear>
      </Fields>
    </CurrentStock>
  </CurrentStocks>
</Response>

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <CurrentStocks>
    <CurrentStock>
      <ArticleNumber>MyArticle</ArticleNumber>
      <Fields>
        <Location>- ALL -</Location>
        <Serial>- ALL -</Serial>
        <StockNumber>MyStockArticle</StockNumber>
        <Stock>120.0</Stock>
        <Warehouse>WH1</Warehouse>
        ...
      </Fields>
    </CurrentStock>
  </CurrentStocks>
</Response>

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <CurrentStocks>
    <CurrentStock>
      <ArticleNumber>MyArticle</ArticleNumber>
      <Fields>
        <Location>ZoneA</Location>
        <Serial>- ALL -</Serial>
        <StockNumber>MyArticle</StockNumber>
        <Stock>72.0</Stock>
        <Warehouse>WH1</Warehouse>
        ...
      </Fields>
    </CurrentStock>
  </CurrentStocks>
</Response>

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <CurrentStocks>
    <CurrentStock>
      <ArticleNumber>MyArticle</ArticleNumber>
      <Fields>
        <Location>ZoneA</Location>
        <Serial>Ser_001</Serial>
        <StockNumber>MyStockArticle</StockNumber>
        <Stock>8.0</Stock>
        <Warehouse>WH1</Warehouse>
        ...
      </Fields>
    </CurrentStock>
  </CurrentStocks>
</Response>