Retrieve Stock Quantity
Description |
This method can be used to retrieve all stock quantities within a DC or retrieve stock quantities for a collection of product codes within a DC. |
System behaviours
- Will not return a SKU within a location type if the stock is 0.
- Negative quantities are not returned.
- If no ProductCodes are provided in the Request, All product codes with stock will be returned.
- You can specify parameters within the call, to return specific results.
- As the maximum length of query string is 2048, if you subtract dc and api_key from it, this provides: 2048 – 73 = 1975. For example 197 product codes can be queried if each 9 length, with a comma separator.
- The Available Quantity decrements once the order is in SupplyStream.
- When an order is uploaded, this takes approx. 5 minutes to appear in SupplyStream. In this time, Retrieve Stock Quantity will not account for this order within the stock level, though iHub will not accept orders for stock that is not available. For example, if 2 stock was available of a SKU, and an order was raised for a quantity of 2, this would mean the remaining available quantity is 0. Retrieve Stock quantity will continue to show an Available qty of 2 until the order is processed into SupplyStream (approx. 5 minutes). However, if a second order of a quantity of this SKU was attempted within this 5 minutes, the order would be rejected, as the available quantity is 0.
It is recommended for this reason to not run Retrieve Stock Quantity directly after taking orders, but limit this as a validation 1-2 times a day, and maintain the stock levels based on orders raised, as well as movement and adjustment messages.
Available formats
FTP | Manual | ||
XML | x | ||
JSON | x | ||
CSV |
Field level details
Retrieve Stock Quantity Request Item | ||||
Field | Description | Data Type | Value Limits | Requirement |
ProductCodes | Unique SKU identifier code | List<string> | separated by either , or ~ | |
DCCode | SEKO created code that uniquely identifies the DC from other SEKO DC's. This code is supplied by SEKO. | nvarchar(100) | Required if connected to multiple DC Codes |
Retrieve Stock Quantity Response Item | ||
Field | Description | Data Type |
ProductCode | Unique SKU identifier code. | nvarchar(100) |
DCCode | SEKO created code that uniquely identifies the DC from other SEKO DC's Code is supplied by SEKO. . I.e. Seko Logistics Milton Keynes DCCode: DCCL01. | nvarchar(100) |
LocationType | The location type is the type of location the stock is in, i.e. Available Stock, Quarantine, Query, QC. A list of stock service field descriptions can be found here. | nvarchar(100) |
Quantity | Quantity of stock within the specified location | int |