Versions Compared

Old Version 3

changes.mady.by.user Abigail Mills

Saved on

compared with

New Version Current

changes.mady.by.user Dean Bazeley (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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>Key>

Live

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


Header

Requirement

JSON

XML

Accept

Optional. Returns XML if undefined.

Accept: application/json

Accept: application/xml

...

XML Format


Body

N/A

Example success Response Body<?xml version="1.0" encoding="utf-8"?>

<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<?xml version="1.0" encoding="utf-8"?>

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

...