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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfv_Jiwa_Inventory_Item_List7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
    <d2p1:v_Jiwa_Inventory_Item_List>
      <d2p1:_x003C_AvailableStock_x003E_k__BackingField>0</d2p1:_x003C_AvailableStock_x003E_k__BackingField>
      <d2p1:_x003C_Category1Description_x003E_k__BackingField>String</d2p1:_x003C_Category1Description_x003E_k__BackingField>
      <d2p1:_x003C_Category1ID_x003E_k__BackingField>String</d2p1:_x003C_Category1ID_x003E_k__BackingField>
      <d2p1:_x003C_Category2Description_x003E_k__BackingField>String</d2p1:_x003C_Category2Description_x003E_k__BackingField>
      <d2p1:_x003C_Category2ID_x003E_k__BackingField>String</d2p1:_x003C_Category2ID_x003E_k__BackingField>
      <d2p1:_x003C_Category3Description_x003E_k__BackingField>String</d2p1:_x003C_Category3Description_x003E_k__BackingField>
      <d2p1:_x003C_Category3ID_x003E_k__BackingField>String</d2p1:_x003C_Category3ID_x003E_k__BackingField>
      <d2p1:_x003C_Category4Description_x003E_k__BackingField>String</d2p1:_x003C_Category4Description_x003E_k__BackingField>
      <d2p1:_x003C_Category4ID_x003E_k__BackingField>String</d2p1:_x003C_Category4ID_x003E_k__BackingField>
      <d2p1:_x003C_Category5Description_x003E_k__BackingField>String</d2p1:_x003C_Category5Description_x003E_k__BackingField>
      <d2p1:_x003C_Category5ID_x003E_k__BackingField>String</d2p1:_x003C_Category5ID_x003E_k__BackingField>
      <d2p1:_x003C_ClassificationDescription_x003E_k__BackingField>String</d2p1:_x003C_ClassificationDescription_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>String</d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>
      <d2p1:_x003C_IN_PhysicalID_x003E_k__BackingField>String</d2p1:_x003C_IN_PhysicalID_x003E_k__BackingField>
      <d2p1:_x003C_InventoryClassificationID_x003E_k__BackingField>String</d2p1:_x003C_InventoryClassificationID_x003E_k__BackingField>
      <d2p1:_x003C_InventoryID_x003E_k__BackingField>String</d2p1:_x003C_InventoryID_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_LogicalWarehouseDescription_x003E_k__BackingField>String</d2p1:_x003C_LogicalWarehouseDescription_x003E_k__BackingField>
      <d2p1:_x003C_PartNo_x003E_k__BackingField>String</d2p1:_x003C_PartNo_x003E_k__BackingField>
      <d2p1:_x003C_PhysicalWarehouseDescription_x003E_k__BackingField>String</d2p1:_x003C_PhysicalWarehouseDescription_x003E_k__BackingField>
      <d2p1:_x003C_Picture_x003E_k__BackingField>AA==</d2p1:_x003C_Picture_x003E_k__BackingField>
      <d2p1:_x003C_RRPPrice_x003E_k__BackingField>0</d2p1:_x003C_RRPPrice_x003E_k__BackingField>
      <d2p1:_x003C_SellPrice_x003E_k__BackingField>0</d2p1:_x003C_SellPrice_x003E_k__BackingField>
    </d2p1:v_Jiwa_Inventory_Item_List>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfv_Jiwa_Inventory_Item_List7kRqkrSv>