POST api/StockBalances/{branchId}?locationId={locationId}

Gets all stockbalances for the specified articles in the body for a specific branch.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
branchId

(Required) Branchid

 integer

Required
locationId

(Required) locationId. In DD use stock number.

 integer

Required

Body Parameters

List of article numbers.

Collection of integer

Remarks

None.

Example

//Gets the stockbalance for article 1, 2 and 3 for location id 1 in branch with id 1.
http://localhost/api/stockbalances/inquiry/1
BODY: [1, 2, 3]

Request Formats

application/json, text/json

Sample: 
[
  1,
  2
]

application/xml, text/xml

Sample: 
<ArrayOflong xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <long>1</long>
  <long>2</long>
</ArrayOflong>

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 'List`1'.

Response Information

Resource Description

Stock balance for the specified articles.

Collection of StockBalanceResponse
NameDescriptionTypeAdditional information
ArticleNo

integer

Required
StockBalance

decimal(19,6)

 decimal number

Required
CentralWarehouseStockBalance

decimal(19,6)

 decimal number

Required
TotalStockBalance

decimal(19,6)

 decimal number

Required

Response Formats

application/json, text/json

Sample: 
[
  {
    "ArticleNo": 1,
    "StockBalance": 2.0,
    "CentralWarehouseStockBalance": 3.0,
    "TotalStockBalance": 4.0
  },
  {
    "ArticleNo": 1,
    "StockBalance": 2.0,
    "CentralWarehouseStockBalance": 3.0,
    "TotalStockBalance": 4.0
  }
]

application/xml, text/xml

Sample: 
<ArrayOfStockBalanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Stock">
  <StockBalanceResponse>
    <ArticleNo>1</ArticleNo>
    <CentralWarehouseStockBalance>3</CentralWarehouseStockBalance>
    <StockBalance>2</StockBalance>
    <TotalStockBalance>4</TotalStockBalance>
  </StockBalanceResponse>
  <StockBalanceResponse>
    <ArticleNo>1</ArticleNo>
    <CentralWarehouseStockBalance>3</CentralWarehouseStockBalance>
    <StockBalance>2</StockBalance>
    <TotalStockBalance>4</TotalStockBalance>
  </StockBalanceResponse>
</ArrayOfStockBalanceResponse>