JiwaAPI

<back to all web services

IN_WarehouseSOHQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/IN_WarehouseSOHRetrieves a list of inventory stock levels per warehouse.
IN_WarehouseSOHQuery Parameters:
NameParameterData TypeRequiredDescription
IN_WarehouseSOHIDquerystringNo
IN_WarehouseSOHIDStartsWithquerystringNo
IN_WarehouseSOHIDEndsWithquerystringNo
IN_WarehouseSOHIDContainsquerystringNo
IN_WarehouseSOHIDLikequerystringNo
IN_WarehouseSOHIDBetweenquerystring[]No
IN_WarehouseSOHIDInquerystring[]No
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
QuantityLeftquerydecimal?No
QuantityLeftGreaterThanOrEqualToquerydecimal?No
QuantityLeftGreaterThanquerydecimal?No
QuantityLeftLessThanquerydecimal?No
QuantityLeftLessThanOrEqualToquerydecimal?No
QuantityLeftNotEqualToquerydecimal?No
QuantityLeftBetweenqueryNullable<Decimal>[]No
QuantityLeftInqueryNullable<Decimal>[]No
QuantityAllocatedquerydecimal?No
QuantityAllocatedGreaterThanOrEqualToquerydecimal?No
QuantityAllocatedGreaterThanquerydecimal?No
QuantityAllocatedLessThanquerydecimal?No
QuantityAllocatedLessThanOrEqualToquerydecimal?No
QuantityAllocatedNotEqualToquerydecimal?No
QuantityAllocatedBetweenqueryNullable<Decimal>[]No
QuantityAllocatedInqueryNullable<Decimal>[]No
PickAllocatedquerydecimal?No
PickAllocatedGreaterThanOrEqualToquerydecimal?No
PickAllocatedGreaterThanquerydecimal?No
PickAllocatedLessThanquerydecimal?No
PickAllocatedLessThanOrEqualToquerydecimal?No
PickAllocatedNotEqualToquerydecimal?No
PickAllocatedBetweenqueryNullable<Decimal>[]No
PickAllocatedInqueryNullable<Decimal>[]No
ShipAllocatedquerydecimal?No
ShipAllocatedGreaterThanOrEqualToquerydecimal?No
ShipAllocatedGreaterThanquerydecimal?No
ShipAllocatedLessThanquerydecimal?No
ShipAllocatedLessThanOrEqualToquerydecimal?No
ShipAllocatedNotEqualToquerydecimal?No
ShipAllocatedBetweenqueryNullable<Decimal>[]No
ShipAllocatedInqueryNullable<Decimal>[]No
ForwardRequirementsquerydecimal?No
ForwardRequirementsGreaterThanOrEqualToquerydecimal?No
ForwardRequirementsGreaterThanquerydecimal?No
ForwardRequirementsLessThanquerydecimal?No
ForwardRequirementsLessThanOrEqualToquerydecimal?No
ForwardRequirementsNotEqualToquerydecimal?No
ForwardRequirementsBetweenqueryNullable<Decimal>[]No
ForwardRequirementsInqueryNullable<Decimal>[]No
TransferAllocatedquerydecimal?No
TransferAllocatedGreaterThanOrEqualToquerydecimal?No
TransferAllocatedGreaterThanquerydecimal?No
TransferAllocatedLessThanquerydecimal?No
TransferAllocatedLessThanOrEqualToquerydecimal?No
TransferAllocatedNotEqualToquerydecimal?No
TransferAllocatedBetweenqueryNullable<Decimal>[]No
TransferAllocatedInqueryNullable<Decimal>[]No
BOMAllocatedquerydecimal?No
BOMAllocatedGreaterThanOrEqualToquerydecimal?No
BOMAllocatedGreaterThanquerydecimal?No
BOMAllocatedLessThanquerydecimal?No
BOMAllocatedLessThanOrEqualToquerydecimal?No
BOMAllocatedNotEqualToquerydecimal?No
BOMAllocatedBetweenqueryNullable<Decimal>[]No
BOMAllocatedInqueryNullable<Decimal>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_WarehouseSOH Parameters:
NameParameterData TypeRequiredDescription
IN_WarehouseSOHIDformstringNo
InventoryIDformstringNo
IN_LogicalIDformstringNo
QuantityLeftformdecimal?No
QuantityAllocatedformdecimal?No
PickAllocatedformdecimal?No
ShipAllocatedformdecimal?No
ForwardRequirementsformdecimal?No
TransferAllocatedformdecimal?No
BOMAllocatedformdecimal?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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /Queries/IN_WarehouseSOH HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"IN_WarehouseSOHID":"String","InventoryID":"String","IN_LogicalID":"String","QuantityLeft":0,"QuantityAllocated":0,"PickAllocated":0,"ShipAllocated":0,"ForwardRequirements":0,"TransferAllocated":0,"BOMAllocated":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}