POST api/Stock?companyCode={companyCode}
Get Stock List for specified products
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyCode |
Company Identifier |
string |
Required |
Body Parameters
List of Product Identifiers
Collection of stringRequest Formats
application/json, text/json
Sample:
[ "string 1", "string 2" ]
application/xml, text/xml
Sample:
<ArrayOfString xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <string>string 1</string> <string>string 2</string> </ArrayOfString>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Response message with a list of stock of all Company related Products. HttpStatusCode.Conflict when user isn't connected to Company
GetStockListMessageResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header | MessageHeader |
None. |
|
| StockList | Collection of StockListResponseItem |
None. |
|
| StockDetailList | Collection of StockListResponseDetailItem |
None. |
|
| StockAvailabilityList | Collection of StockListResponseAvailabilityItem |
None. |
|
| Footer | MessageFooter |
None. |
Response Formats
application/json, text/json
Sample:
{
"Header": {
"Version": "string 1",
"Identification": "string 2",
"Sender": "string 3"
},
"StockList": [
{
"ProductIdentifier": "string 1",
"Quantity": 2,
"BlockedQuantity": 3,
"Lot": {
"CompanyIdentifier": "string 1",
"BatchNumber": "string 2",
"LotNumber": "string 3",
"MinimalExpirationDate": "2025-12-06T04:00:26.6330844+01:00",
"MinimalExpirationDateSpecified": true,
"MaximalExpirationDate": "2025-12-06T04:00:26.6330844+01:00",
"MaximalExpirationDateSpecified": true,
"LotDate": "2025-12-06T04:00:26.6330844+01:00",
"LotDateSpecified": true
},
"SerialNumbers": [
{
"Number": "string 1"
},
{
"Number": "string 1"
}
]
},
{
"ProductIdentifier": "string 1",
"Quantity": 2,
"BlockedQuantity": 3,
"Lot": {
"CompanyIdentifier": "string 1",
"BatchNumber": "string 2",
"LotNumber": "string 3",
"MinimalExpirationDate": "2025-12-06T04:00:26.6330844+01:00",
"MinimalExpirationDateSpecified": true,
"MaximalExpirationDate": "2025-12-06T04:00:26.6330844+01:00",
"MaximalExpirationDateSpecified": true,
"LotDate": "2025-12-06T04:00:26.6330844+01:00",
"LotDateSpecified": true
},
"SerialNumbers": [
{
"Number": "string 1"
},
{
"Number": "string 1"
}
]
}
],
"StockDetailList": [
{
"ProductIdentifier": "string 1",
"WarehouseIdentifier": "string 2",
"StockLocationIdentifier": "string 3",
"StockLocationTypeIdentifier": "string 4",
"WarehouseLocationTypeIdentifier": "string 5",
"StockLocationTypeIdentifierCode": "string 6",
"WarehouseLocationTypeIdentifierCode": "string 7",
"URNIdentifier": "string 8",
"URNTypeIdentifier": "string 9",
"Quantity": 10,
"QuantityReserved": 11,
"Blocked": true,
"BlockedReason": "string 13",
"StockDateTime": "2025-12-06T04:00:26.6330844+01:00",
"Lot": {
"CompanyIdentifier": "string 1",
"BatchNumber": "string 2",
"LotNumber": "string 3",
"MinimalExpirationDate": "2025-12-06T04:00:26.6330844+01:00",
"MinimalExpirationDateSpecified": true,
"MaximalExpirationDate": "2025-12-06T04:00:26.6330844+01:00",
"MaximalExpirationDateSpecified": true,
"LotDate": "2025-12-06T04:00:26.6330844+01:00",
"LotDateSpecified": true
},
"SerialNumbers": [
{
"Number": "string 1"
},
{
"Number": "string 1"
}
]
},
{
"ProductIdentifier": "string 1",
"WarehouseIdentifier": "string 2",
"StockLocationIdentifier": "string 3",
"StockLocationTypeIdentifier": "string 4",
"WarehouseLocationTypeIdentifier": "string 5",
"StockLocationTypeIdentifierCode": "string 6",
"WarehouseLocationTypeIdentifierCode": "string 7",
"URNIdentifier": "string 8",
"URNTypeIdentifier": "string 9",
"Quantity": 10,
"QuantityReserved": 11,
"Blocked": true,
"BlockedReason": "string 13",
"StockDateTime": "2025-12-06T04:00:26.6330844+01:00",
"Lot": {
"CompanyIdentifier": "string 1",
"BatchNumber": "string 2",
"LotNumber": "string 3",
"MinimalExpirationDate": "2025-12-06T04:00:26.6330844+01:00",
"MinimalExpirationDateSpecified": true,
"MaximalExpirationDate": "2025-12-06T04:00:26.6330844+01:00",
"MaximalExpirationDateSpecified": true,
"LotDate": "2025-12-06T04:00:26.6330844+01:00",
"LotDateSpecified": true
},
"SerialNumbers": [
{
"Number": "string 1"
},
{
"Number": "string 1"
}
]
}
],
"StockAvailabilityList": [
{
"ProductIdentifier": "string 1",
"WarehouseIdentifier": "string 2",
"Quantity": 3,
"QuantityNotAvailable": 1,
"QuantityAvailable": 1,
"QuantityInTransitInbound": 1,
"QuantityInTransitOutbound": 1,
"Lot": {
"CompanyIdentifier": "string 1",
"BatchNumber": "string 2",
"LotNumber": "string 3",
"MinimalExpirationDate": "2025-12-06T04:00:26.6330844+01:00",
"MinimalExpirationDateSpecified": true,
"MaximalExpirationDate": "2025-12-06T04:00:26.6330844+01:00",
"MaximalExpirationDateSpecified": true,
"LotDate": "2025-12-06T04:00:26.6330844+01:00",
"LotDateSpecified": true
},
"StockLocationTypeIdentifier": "string 4",
"WarehouseLocationTypeIdentifier": "string 5",
"SerialNumbers": [
{
"Number": "string 1"
},
{
"Number": "string 1"
}
]
},
{
"ProductIdentifier": "string 1",
"WarehouseIdentifier": "string 2",
"Quantity": 3,
"QuantityNotAvailable": 1,
"QuantityAvailable": 1,
"QuantityInTransitInbound": 1,
"QuantityInTransitOutbound": 1,
"Lot": {
"CompanyIdentifier": "string 1",
"BatchNumber": "string 2",
"LotNumber": "string 3",
"MinimalExpirationDate": "2025-12-06T04:00:26.6330844+01:00",
"MinimalExpirationDateSpecified": true,
"MaximalExpirationDate": "2025-12-06T04:00:26.6330844+01:00",
"MaximalExpirationDateSpecified": true,
"LotDate": "2025-12-06T04:00:26.6330844+01:00",
"LotDateSpecified": true
},
"StockLocationTypeIdentifier": "string 4",
"WarehouseLocationTypeIdentifier": "string 5",
"SerialNumbers": [
{
"Number": "string 1"
},
{
"Number": "string 1"
}
]
}
],
"Footer": {
"TotalRecords": 1,
"Records": 2
}
}
application/xml, text/xml
Sample:
<GetStockListMessageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Header>
<Version>string 1</Version>
<Identification>string 2</Identification>
<Sender>string 3</Sender>
</Header>
<StockList>
<StockListResponseItem>
<ProductIdentifier>string 1</ProductIdentifier>
<Quantity>2</Quantity>
<BlockedQuantity>3</BlockedQuantity>
<Lot>
<CompanyIdentifier>string 1</CompanyIdentifier>
<BatchNumber>string 2</BatchNumber>
<LotNumber>string 3</LotNumber>
<MinimalExpirationDate>2025-12-06T04:00:26.6330844+01:00</MinimalExpirationDate>
<MinimalExpirationDateSpecified>true</MinimalExpirationDateSpecified>
<MaximalExpirationDate>2025-12-06T04:00:26.6330844+01:00</MaximalExpirationDate>
<MaximalExpirationDateSpecified>true</MaximalExpirationDateSpecified>
<LotDate>2025-12-06T04:00:26.6330844+01:00</LotDate>
<LotDateSpecified>true</LotDateSpecified>
</Lot>
<SerialNumbers>
<SerialNumber>
<Number>string 1</Number>
</SerialNumber>
<SerialNumber>
<Number>string 1</Number>
</SerialNumber>
</SerialNumbers>
</StockListResponseItem>
<StockListResponseItem>
<ProductIdentifier>string 1</ProductIdentifier>
<Quantity>2</Quantity>
<BlockedQuantity>3</BlockedQuantity>
<Lot>
<CompanyIdentifier>string 1</CompanyIdentifier>
<BatchNumber>string 2</BatchNumber>
<LotNumber>string 3</LotNumber>
<MinimalExpirationDate>2025-12-06T04:00:26.6330844+01:00</MinimalExpirationDate>
<MinimalExpirationDateSpecified>true</MinimalExpirationDateSpecified>
<MaximalExpirationDate>2025-12-06T04:00:26.6330844+01:00</MaximalExpirationDate>
<MaximalExpirationDateSpecified>true</MaximalExpirationDateSpecified>
<LotDate>2025-12-06T04:00:26.6330844+01:00</LotDate>
<LotDateSpecified>true</LotDateSpecified>
</Lot>
<SerialNumbers>
<SerialNumber>
<Number>string 1</Number>
</SerialNumber>
<SerialNumber>
<Number>string 1</Number>
</SerialNumber>
</SerialNumbers>
</StockListResponseItem>
</StockList>
<StockDetailList>
<StockListResponseDetailItem>
<ProductIdentifier>string 1</ProductIdentifier>
<WarehouseIdentifier>string 2</WarehouseIdentifier>
<StockLocationIdentifier>string 3</StockLocationIdentifier>
<StockLocationTypeIdentifier>string 4</StockLocationTypeIdentifier>
<WarehouseLocationTypeIdentifier>string 5</WarehouseLocationTypeIdentifier>
<StockLocationTypeIdentifierCode>string 6</StockLocationTypeIdentifierCode>
<WarehouseLocationTypeIdentifierCode>string 7</WarehouseLocationTypeIdentifierCode>
<URNIdentifier>string 8</URNIdentifier>
<URNTypeIdentifier>string 9</URNTypeIdentifier>
<Quantity>10</Quantity>
<QuantityReserved>11</QuantityReserved>
<Blocked>true</Blocked>
<BlockedReason>string 13</BlockedReason>
<StockDateTime>2025-12-06T04:00:26.6330844+01:00</StockDateTime>
<Lot>
<CompanyIdentifier>string 1</CompanyIdentifier>
<BatchNumber>string 2</BatchNumber>
<LotNumber>string 3</LotNumber>
<MinimalExpirationDate>2025-12-06T04:00:26.6330844+01:00</MinimalExpirationDate>
<MinimalExpirationDateSpecified>true</MinimalExpirationDateSpecified>
<MaximalExpirationDate>2025-12-06T04:00:26.6330844+01:00</MaximalExpirationDate>
<MaximalExpirationDateSpecified>true</MaximalExpirationDateSpecified>
<LotDate>2025-12-06T04:00:26.6330844+01:00</LotDate>
<LotDateSpecified>true</LotDateSpecified>
</Lot>
<SerialNumbers>
<SerialNumber>
<Number>string 1</Number>
</SerialNumber>
<SerialNumber>
<Number>string 1</Number>
</SerialNumber>
</SerialNumbers>
</StockListResponseDetailItem>
<StockListResponseDetailItem>
<ProductIdentifier>string 1</ProductIdentifier>
<WarehouseIdentifier>string 2</WarehouseIdentifier>
<StockLocationIdentifier>string 3</StockLocationIdentifier>
<StockLocationTypeIdentifier>string 4</StockLocationTypeIdentifier>
<WarehouseLocationTypeIdentifier>string 5</WarehouseLocationTypeIdentifier>
<StockLocationTypeIdentifierCode>string 6</StockLocationTypeIdentifierCode>
<WarehouseLocationTypeIdentifierCode>string 7</WarehouseLocationTypeIdentifierCode>
<URNIdentifier>string 8</URNIdentifier>
<URNTypeIdentifier>string 9</URNTypeIdentifier>
<Quantity>10</Quantity>
<QuantityReserved>11</QuantityReserved>
<Blocked>true</Blocked>
<BlockedReason>string 13</BlockedReason>
<StockDateTime>2025-12-06T04:00:26.6330844+01:00</StockDateTime>
<Lot>
<CompanyIdentifier>string 1</CompanyIdentifier>
<BatchNumber>string 2</BatchNumber>
<LotNumber>string 3</LotNumber>
<MinimalExpirationDate>2025-12-06T04:00:26.6330844+01:00</MinimalExpirationDate>
<MinimalExpirationDateSpecified>true</MinimalExpirationDateSpecified>
<MaximalExpirationDate>2025-12-06T04:00:26.6330844+01:00</MaximalExpirationDate>
<MaximalExpirationDateSpecified>true</MaximalExpirationDateSpecified>
<LotDate>2025-12-06T04:00:26.6330844+01:00</LotDate>
<LotDateSpecified>true</LotDateSpecified>
</Lot>
<SerialNumbers>
<SerialNumber>
<Number>string 1</Number>
</SerialNumber>
<SerialNumber>
<Number>string 1</Number>
</SerialNumber>
</SerialNumbers>
</StockListResponseDetailItem>
</StockDetailList>
<StockAvailabilityList>
<StockListResponseAvailabilityItem>
<ProductIdentifier>string 1</ProductIdentifier>
<WarehouseIdentifier>string 2</WarehouseIdentifier>
<Quantity>3</Quantity>
<QuantityNotAvailable>1</QuantityNotAvailable>
<QuantityAvailable>1</QuantityAvailable>
<QuantityInTransitInbound>1</QuantityInTransitInbound>
<QuantityInTransitOutbound>1</QuantityInTransitOutbound>
<Lot>
<CompanyIdentifier>string 1</CompanyIdentifier>
<BatchNumber>string 2</BatchNumber>
<LotNumber>string 3</LotNumber>
<MinimalExpirationDate>2025-12-06T04:00:26.6330844+01:00</MinimalExpirationDate>
<MinimalExpirationDateSpecified>true</MinimalExpirationDateSpecified>
<MaximalExpirationDate>2025-12-06T04:00:26.6330844+01:00</MaximalExpirationDate>
<MaximalExpirationDateSpecified>true</MaximalExpirationDateSpecified>
<LotDate>2025-12-06T04:00:26.6330844+01:00</LotDate>
<LotDateSpecified>true</LotDateSpecified>
</Lot>
<StockLocationTypeIdentifier>string 4</StockLocationTypeIdentifier>
<WarehouseLocationTypeIdentifier>string 5</WarehouseLocationTypeIdentifier>
<SerialNumbers>
<SerialNumber>
<Number>string 1</Number>
</SerialNumber>
<SerialNumber>
<Number>string 1</Number>
</SerialNumber>
</SerialNumbers>
</StockListResponseAvailabilityItem>
<StockListResponseAvailabilityItem>
<ProductIdentifier>string 1</ProductIdentifier>
<WarehouseIdentifier>string 2</WarehouseIdentifier>
<Quantity>3</Quantity>
<QuantityNotAvailable>1</QuantityNotAvailable>
<QuantityAvailable>1</QuantityAvailable>
<QuantityInTransitInbound>1</QuantityInTransitInbound>
<QuantityInTransitOutbound>1</QuantityInTransitOutbound>
<Lot>
<CompanyIdentifier>string 1</CompanyIdentifier>
<BatchNumber>string 2</BatchNumber>
<LotNumber>string 3</LotNumber>
<MinimalExpirationDate>2025-12-06T04:00:26.6330844+01:00</MinimalExpirationDate>
<MinimalExpirationDateSpecified>true</MinimalExpirationDateSpecified>
<MaximalExpirationDate>2025-12-06T04:00:26.6330844+01:00</MaximalExpirationDate>
<MaximalExpirationDateSpecified>true</MaximalExpirationDateSpecified>
<LotDate>2025-12-06T04:00:26.6330844+01:00</LotDate>
<LotDateSpecified>true</LotDateSpecified>
</Lot>
<StockLocationTypeIdentifier>string 4</StockLocationTypeIdentifier>
<WarehouseLocationTypeIdentifier>string 5</WarehouseLocationTypeIdentifier>
<SerialNumbers>
<SerialNumber>
<Number>string 1</Number>
</SerialNumber>
<SerialNumber>
<Number>string 1</Number>
</SerialNumber>
</SerialNumbers>
</StockListResponseAvailabilityItem>
</StockAvailabilityList>
<Footer>
<TotalRecords>1</TotalRecords>
<Records>2</Records>
</Footer>
</GetStockListMessageResponse>