POST api/v1/essentials/stockamounts

Gets the stock amounts

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
LocationName	The name of the storage location the data is requested. When location not exists, the result will be empty	string	None.
Limit	The amount of rows requested per page. Default 500	integer	None.
Page	The requested page related to the limit. default 1	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "LocationName": "sample string 1",
  "Limit": 2,
  "Page": 3
}

application/xml, text/xml

Sample:

<GetCurrentStockAmountsParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://promotionaloffice.promidata.com/2012/08/08">
  <Limit>2</Limit>
  <LocationName>sample string 1</LocationName>
  <Page>3</Page>
</GetCurrentStockAmountsParameter>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetCurrentStockAmountsParameter'.

Response Information

Resource Description

Collection of stock amount items.

GetCurrentStockAmountsResult

Name	Description	Type	Additional information
StockAmounts		Collection of StockAmountItem	None.

Response Formats

application/json, text/json

Sample:

{
  "StockAmounts": [
    {
      "OrderNumber": "sample string 1",
      "OwnArticleNumber": "sample string 2",
      "ProductIdentifier": "c31ba6a2-f538-4c45-8a70-4607d695ac96",
      "VariationIdentifier": "75204b2c-edaf-49b9-a7f1-a0effa14bf61",
      "Option1Key": "sample string 5",
      "Option2Key": "sample string 6",
      "StockAmountTotalAmount": 7.0,
      "StockAmountTotalUnit": "sample string 8",
      "StorageAreaName": "sample string 9",
      "HasBetterment": true
    },
    {
      "OrderNumber": "sample string 1",
      "OwnArticleNumber": "sample string 2",
      "ProductIdentifier": "c31ba6a2-f538-4c45-8a70-4607d695ac96",
      "VariationIdentifier": "75204b2c-edaf-49b9-a7f1-a0effa14bf61",
      "Option1Key": "sample string 5",
      "Option2Key": "sample string 6",
      "StockAmountTotalAmount": 7.0,
      "StockAmountTotalUnit": "sample string 8",
      "StorageAreaName": "sample string 9",
      "HasBetterment": true
    }
  ]
}

application/xml, text/xml

Sample:

<GetCurrentStockAmountsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://promotionaloffice.promidata.com/2012/08/08">
  <StockAmounts>
    <StockAmountItem>
      <HasBetterment>true</HasBetterment>
      <Option1Key>sample string 5</Option1Key>
      <Option2Key>sample string 6</Option2Key>
      <OrderNumber>sample string 1</OrderNumber>
      <OwnArticleNumber>sample string 2</OwnArticleNumber>
      <ProductIdentifier>c31ba6a2-f538-4c45-8a70-4607d695ac96</ProductIdentifier>
      <StockAmountTotalAmount>7</StockAmountTotalAmount>
      <StockAmountTotalUnit>sample string 8</StockAmountTotalUnit>
      <StorageAreaName>sample string 9</StorageAreaName>
      <VariationIdentifier>75204b2c-edaf-49b9-a7f1-a0effa14bf61</VariationIdentifier>
    </StockAmountItem>
    <StockAmountItem>
      <HasBetterment>true</HasBetterment>
      <Option1Key>sample string 5</Option1Key>
      <Option2Key>sample string 6</Option2Key>
      <OrderNumber>sample string 1</OrderNumber>
      <OwnArticleNumber>sample string 2</OwnArticleNumber>
      <ProductIdentifier>c31ba6a2-f538-4c45-8a70-4607d695ac96</ProductIdentifier>
      <StockAmountTotalAmount>7</StockAmountTotalAmount>
      <StockAmountTotalUnit>sample string 8</StockAmountTotalUnit>
      <StorageAreaName>sample string 9</StorageAreaName>
      <VariationIdentifier>75204b2c-edaf-49b9-a7f1-a0effa14bf61</VariationIdentifier>
    </StockAmountItem>
  </StockAmounts>
</GetCurrentStockAmountsResult>