JiwaAPI

<back to all web services

v_Jiwa_Inventory_Item_ListQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/InventoryItemListRetrieves a list of inventory items
v_Jiwa_Inventory_Item_ListQuery Parameters:
NameParameterData TypeRequiredDescription
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
PartNoquerystringNo
PartNoStartsWithquerystringNo
PartNoEndsWithquerystringNo
PartNoContainsquerystringNo
PartNoLikequerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
Picturequerybyte[]No
InventoryClassificationIDquerystringNo
InventoryClassificationIDStartsWithquerystringNo
InventoryClassificationIDEndsWithquerystringNo
InventoryClassificationIDContainsquerystringNo
InventoryClassificationIDLikequerystringNo
InventoryClassificationIDBetweenquerystring[]No
InventoryClassificationIDInquerystring[]No
ClassificationDescriptionquerystringNo
ClassificationDescriptionStartsWithquerystringNo
ClassificationDescriptionEndsWithquerystringNo
ClassificationDescriptionContainsquerystringNo
ClassificationDescriptionLikequerystringNo
ClassificationDescriptionBetweenquerystring[]No
ClassificationDescriptionInquerystring[]No
Category1IDquerystringNo
Category1IDStartsWithquerystringNo
Category1IDEndsWithquerystringNo
Category1IDContainsquerystringNo
Category1IDLikequerystringNo
Category1IDBetweenquerystring[]No
Category1IDInquerystring[]No
Category1DescriptionquerystringNo
Category1DescriptionStartsWithquerystringNo
Category1DescriptionEndsWithquerystringNo
Category1DescriptionContainsquerystringNo
Category1DescriptionLikequerystringNo
Category1DescriptionBetweenquerystring[]No
Category1DescriptionInquerystring[]No
Category2IDquerystringNo
Category2IDStartsWithquerystringNo
Category2IDEndsWithquerystringNo
Category2IDContainsquerystringNo
Category2IDLikequerystringNo
Category2IDBetweenquerystring[]No
Category2IDInquerystring[]No
Category2DescriptionquerystringNo
Category2DescriptionStartsWithquerystringNo
Category2DescriptionEndsWithquerystringNo
Category2DescriptionContainsquerystringNo
Category2DescriptionLikequerystringNo
Category2DescriptionBetweenquerystring[]No
Category2DescriptionInquerystring[]No
Category3IDquerystringNo
Category3IDStartsWithquerystringNo
Category3IDEndsWithquerystringNo
Category3IDContainsquerystringNo
Category3IDLikequerystringNo
Category3IDBetweenquerystring[]No
Category3IDInquerystring[]No
Category3DescriptionquerystringNo
Category3DescriptionStartsWithquerystringNo
Category3DescriptionEndsWithquerystringNo
Category3DescriptionContainsquerystringNo
Category3DescriptionLikequerystringNo
Category3DescriptionBetweenquerystring[]No
Category3DescriptionInquerystring[]No
Category4IDquerystringNo
Category4IDStartsWithquerystringNo
Category4IDEndsWithquerystringNo
Category4IDContainsquerystringNo
Category4IDLikequerystringNo
Category4IDBetweenquerystring[]No
Category4IDInquerystring[]No
Category4DescriptionquerystringNo
Category4DescriptionStartsWithquerystringNo
Category4DescriptionEndsWithquerystringNo
Category4DescriptionContainsquerystringNo
Category4DescriptionLikequerystringNo
Category4DescriptionBetweenquerystring[]No
Category4DescriptionInquerystring[]No
Category5IDquerystringNo
Category5IDStartsWithquerystringNo
Category5IDEndsWithquerystringNo
Category5IDContainsquerystringNo
Category5IDLikequerystringNo
Category5IDBetweenquerystring[]No
Category5IDInquerystring[]No
Category5DescriptionquerystringNo
Category5DescriptionStartsWithquerystringNo
Category5DescriptionEndsWithquerystringNo
Category5DescriptionContainsquerystringNo
Category5DescriptionLikequerystringNo
Category5DescriptionBetweenquerystring[]No
Category5DescriptionInquerystring[]No
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
LogicalWarehouseDescriptionquerystringNo
LogicalWarehouseDescriptionStartsWithquerystringNo
LogicalWarehouseDescriptionEndsWithquerystringNo
LogicalWarehouseDescriptionContainsquerystringNo
LogicalWarehouseDescriptionLikequerystringNo
LogicalWarehouseDescriptionBetweenquerystring[]No
LogicalWarehouseDescriptionInquerystring[]No
IN_PhysicalIDquerystringNo
IN_PhysicalIDStartsWithquerystringNo
IN_PhysicalIDEndsWithquerystringNo
IN_PhysicalIDContainsquerystringNo
IN_PhysicalIDLikequerystringNo
IN_PhysicalIDBetweenquerystring[]No
IN_PhysicalIDInquerystring[]No
PhysicalWarehouseDescriptionquerystringNo
PhysicalWarehouseDescriptionStartsWithquerystringNo
PhysicalWarehouseDescriptionEndsWithquerystringNo
PhysicalWarehouseDescriptionContainsquerystringNo
PhysicalWarehouseDescriptionLikequerystringNo
PhysicalWarehouseDescriptionBetweenquerystring[]No
PhysicalWarehouseDescriptionInquerystring[]No
AvailableStockquerydecimal?No
AvailableStockGreaterThanOrEqualToquerydecimal?No
AvailableStockGreaterThanquerydecimal?No
AvailableStockLessThanquerydecimal?No
AvailableStockLessThanOrEqualToquerydecimal?No
AvailableStockNotEqualToquerydecimal?No
AvailableStockBetweenqueryNullable<Decimal>[]No
AvailableStockInqueryNullable<Decimal>[]No
SellPricequerydecimal?No
SellPriceGreaterThanOrEqualToquerydecimal?No
SellPriceGreaterThanquerydecimal?No
SellPriceLessThanquerydecimal?No
SellPriceLessThanOrEqualToquerydecimal?No
SellPriceNotEqualToquerydecimal?No
SellPriceBetweenqueryNullable<Decimal>[]No
SellPriceInqueryNullable<Decimal>[]No
RRPPricequerydecimal?No
RRPPriceGreaterThanOrEqualToquerydecimal?No
RRPPriceGreaterThanquerydecimal?No
RRPPriceLessThanquerydecimal?No
RRPPriceLessThanOrEqualToquerydecimal?No
RRPPriceNotEqualToquerydecimal?No
RRPPriceBetweenqueryNullable<Decimal>[]No
RRPPriceInqueryNullable<Decimal>[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_Jiwa_Inventory_Item_List Parameters:
NameParameterData TypeRequiredDescription
InventoryIDformstringNo
PartNoformstringNo
DescriptionformstringNo
Pictureformbyte[]No
InventoryClassificationIDformstringNo
ClassificationDescriptionformstringNo
Category1IDformstringNo
Category1DescriptionformstringNo
Category2IDformstringNo
Category2DescriptionformstringNo
Category3IDformstringNo
Category3DescriptionformstringNo
Category4IDformstringNo
Category4DescriptionformstringNo
Category5IDformstringNo
Category5DescriptionformstringNo
IN_LogicalIDformstringNo
LogicalWarehouseDescriptionformstringNo
IN_PhysicalIDformstringNo
PhysicalWarehouseDescriptionformstringNo
AvailableStockformdecimal?No
SellPriceformdecimal?No
RRPPriceformdecimal?No
LastSavedDateTimeformDateTime?No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Queries/InventoryItemList HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"InventoryID":"String","PartNo":"String","Description":"String","Picture":"AA==","InventoryClassificationID":"String","ClassificationDescription":"String","Category1ID":"String","Category1Description":"String","Category2ID":"String","Category2Description":"String","Category3ID":"String","Category3Description":"String","Category4ID":"String","Category4Description":"String","Category5ID":"String","Category5Description":"String","IN_LogicalID":"String","LogicalWarehouseDescription":"String","IN_PhysicalID":"String","PhysicalWarehouseDescription":"String","AvailableStock":0,"SellPrice":0,"RRPPrice":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}