You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
HTTP
Method | /<service>/<version>/<parameters> |
GET | /stock/v3/quantity |
Environment | Request URL |
UAT | https://ihubuat.supplystream.com:8081/api/stock/v3/quantity?api_key=<api_Key> |
Live | https://ihub.supplystream.com:8081/api/salesorders/stock/v3/quantity?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: pmtest123 and pmtest234) | Product Codes: pmtest123, pmtest234 | https://ihubuat.supplystream.com:8081/api/stock/v3/quantity?productCodes=pmtest123,pmtest234&api_key=21121212 |
Includes DC Code and product code parameters | Product Codes: pmtest123, pmtest234
DC Code: DCIW01 | https://ihubuat.supplystream.com:8081/api/stock/v3/quantity?dc=DCIW01& productCodes=pmtest123,pmtest234&api_key=21121212 |
API call formatting
XML Format |
|
Body | N/A |
Example success Response Body | <Response>
<CallStatus>
<Success>true</Success>
<Code>0</Code>
<Message></Message>
</CallStatus>
<List>
<StockQuantityLineItem>
<ProductCode>PMTest123</ProductCode>
<DCCode>DCCL01</DCCode>
<LocationType>Available Stock</LocationType>
<Quantity>976</Quantity>
</StockQuantityLineItem>
<StockQuantityLineItem>
<ProductCode>PMTest234</ProductCode>
<DCCode>DCCL01</DCCode>
<LocationType>Available Stock</LocationType>
<Quantity>957</Quantity>
</StockQuantityLineItem>
</List>
</Response> |
Example failure Response Body | <Response>
<CallStatus>
<Success>false</Success>
<Code>100</Code>
<Message>No results found for search criteria</Message>
</CallStatus>
<List />
</Response> |
JSON Format |
|
Body | N/A |
Example success Response Body | {
"CallStatus": {
"Success": true,
"Code": 0,
"Message": ""
},
"List": {
"StockQuantityLineItem": [
{
"ProductCode": "PMTest123",
"DCCode": "DCCL01",
"LocationType": "Available Stock",
"Quantity": 976
},
{
"ProductCode": "PMTest234",
"DCCode": "DCCL01",
"LocationType": "Available Stock",
"Quantity": 957
}
]
}
} |
Example failure Response Body | {
"CallStatus": {
"Success": false,
"Code": 100,
"Message": "No results found for search criteria"
},
"List": null
} |