API Retrieve Stock LotNo Quantity

Owned by Jeric De Jesus
Last updated: May 10, 2024 by James Seabrook
2 min read

Overview

The service is can be found on Swagger.

Login to the iHub.

Go to Support > REST Testing Tool > Find “Retrieve Stock LotNo Quantity”

 

Call Parameters

HTTP
Method

/<service>/<version>/<parameters>

GET

/stock/v3/lotnoquantity

 

Environment

Request URL

UAT

https://ihubuat.supplystream.com:8081/api/stock/v3/lotnoquantity?api_key=<api_Key>

Live

https://ihub.supplystream.com:8081/api/stock/v3/lotnoquantity?api_key=<api_Key>

 

Header

Requirement

JSON

XML

Accept

Optional. Returns XML if undefined.

Accept: application/json

Accept: application/xml

 

Request URL examples with parameters

Description

Parameters

Request URL

Includes multiple product codes (SKU examples: AFG_Sample_Lot1 and AFG_Sample_Lot2)

Product Codes: AFG_Sample_Lot1, AFG_Sample_Lot2

https://ihubuat.supplystream.com:8081/api/stock/v3/lotnoquantity?productCodes=AFG_Sample_Lot1%2CAFG_Sample_Lot2&api_key=i03u2dw54w0hvvx5kz5bymk2tsv2w9cz89r42kry

Includes DC Code and product code parameters

Product Codes: AFG_Sample_Lot1, AFG_Sample_Lot2
DC Code: DCCL01

https://ihubuat.supplystream.com:8081/api/stock/v3/lotnoquantity?dc=DCCL01&productCodes=AFG_Sample_Lot1%2CAFG_Sample_Lot2&api_key=i03u2dw54w0hvvx5kz5bymk2tsv2w9cz89r42kry

Notes

  • A DC must be supplied. If not supplied no results will be produced.

  • The product code is not mandatory. If no product code is supplied all products will be reported.

  • This service can only retrieve product stock quantity that was lot controlled enabled. If not, then user will receive an error message: "No results found for search criteria"

  • If the product has multiple LotNumber assigned, then the result stock quantity will be separated by LotNumber

  • All location types will be provided, both pickable and not pickable.

 

API call formatting

XML Format

 

Body

N/A

Example success Response Body

<Response>
<CallStatus>
<Success>true</Success>
<Code>0</Code>
<Message/>
</CallStatus>
<List>
<StockLotNoQuantityLineItem>
<LotNumber>22</LotNumber>
<ProductCode>AFG_Sample_Lot1</ProductCode>
<DCCode>DCCL01</DCCode>
<LocationType>Available Stock</LocationType>
<Quantity>92</Quantity>
</StockLotNoQuantityLineItem>
<StockLotNoQuantityLineItem>
<LotNumber>13</LotNumber>
<ProductCode>AFG_Sample_Lot2</ProductCode>
<DCCode>DCCL01</DCCode>
<LocationType>Available Stock</LocationType>
<Quantity>100</Quantity>
</StockLotNoQuantityLineItem>
<StockLotNoQuantityLineItem>
<LotNumber>25</LotNumber>
<ProductCode>AFG_Sample_Lot2</ProductCode>
<DCCode>DCCL01</DCCode>
<LocationType>Available Stock</LocationType>
<Quantity>10</Quantity>
</StockLotNoQuantityLineItem>
<StockLotNoQuantityLineItem>
<LotNumber>27</LotNumber>
<ProductCode>AFG_Sample_Lot2</ProductCode>
<DCCode>DCCL01</DCCode>
<LocationType>Available Stock</LocationType>
<Quantity>95</Quantity>
</StockLotNoQuantityLineItem>
<StockLotNoQuantityLineItem>
<LotNumber>28</LotNumber>
<ProductCode>AFG_Sample_Lot2</ProductCode>
<DCCode>DCCL01</DCCode>
<LocationType>Available Stock</LocationType>
<Quantity>10</Quantity>
</StockLotNoQuantityLineItem>
<StockLotNoQuantityLineItem>
<LotNumber>4</LotNumber>
<ProductCode>AFG_Sample_Lot2</ProductCode>
<DCCode>DCCL01</DCCode>
<LocationType>Available Stock</LocationType>
<Quantity>5</Quantity>
</StockLotNoQuantityLineItem>
<StockLotNoQuantityLineItem>
<LotNumber>55</LotNumber>
<ProductCode>AFG_Sample_Lot2</ProductCode>
<DCCode>DCCL01</DCCode>
<LocationType>Available Stock</LocationType>
<Quantity>10</Quantity>
</StockLotNoQuantityLineItem>
<StockLotNoQuantityLineItem>
<LotNumber>65</LotNumber>
<ProductCode>AFG_Sample_Lot2</ProductCode>
<DCCode>DCCL01</DCCode>
<LocationType>Available Stock</LocationType>
<Quantity>10</Quantity>
</StockLotNoQuantityLineItem>
</List>
</Response>

Example failure Response Body

<Response>
<CallStatus>
<Success>false</Success>
<Code>100</Code>
<Message>No results found for search criteria</Message>
</CallStatus>
</Response>

 

JSON Format

 

Body

N/A

Example success Response Body

{
"CallStatus": {
"Success": true,
"Code": 0,
"Message": ""
},
"List": {
"StockLotNoQuantityLineItem": [
{
"LotNumber": "22",
"ProductCode": "AFG_Sample_Lot1",
"DCCode": "DCCL01",
"LocationType": "Available Stock",
"Quantity": 92
},
{
"LotNumber": "13",
"ProductCode": "AFG_Sample_Lot2",
"DCCode": "DCCL01",
"LocationType": "Available Stock",
"Quantity": 100
},
{
"LotNumber": "25",
"ProductCode": "AFG_Sample_Lot2",
"DCCode": "DCCL01",
"LocationType": "Available Stock",
"Quantity": 10
},
{
"LotNumber": "27",
"ProductCode": "AFG_Sample_Lot2",
"DCCode": "DCCL01",
"LocationType": "Available Stock",
"Quantity": 95
},
{
"LotNumber": "28",
"ProductCode": "AFG_Sample_Lot2",
"DCCode": "DCCL01",
"LocationType": "Available Stock",
"Quantity": 10
},
{
"LotNumber": "4",
"ProductCode": "AFG_Sample_Lot2",
"DCCode": "DCCL01",
"LocationType": "Available Stock",
"Quantity": 5
},
{
"LotNumber": "55",
"ProductCode": "AFG_Sample_Lot2",
"DCCode": "DCCL01",
"LocationType": "Available Stock",
"Quantity": 10
},
{
"LotNumber": "65",
"ProductCode": "AFG_Sample_Lot2",
"DCCode": "DCCL01",
"LocationType": "Available Stock",
"Quantity": 10
}
]
}
}

Example failure Response Body

{
"CallStatus": {
"Success": false,
"Code": 100,
"Message": "No results found for search criteria"
}
}