JiwaAPI

<back to all web services

INV_OnOrderQuery

Requires Authentication
INV_OnOrderQuery Parameters:
NameParameterData TypeRequiredDescription
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
OnOrderquerydecimal?No
OnOrderGreaterThanOrEqualToquerydecimal?No
OnOrderGreaterThanquerydecimal?No
OnOrderLessThanquerydecimal?No
OnOrderLessThanOrEqualToquerydecimal?No
OnOrderNotEqualToquerydecimal?No
OnOrderBetweenqueryNullable<Decimal>[]No
OnOrderInqueryNullable<Decimal>[]No
IN_logicalIDquerystringNo
IN_logicalIDStartsWithquerystringNo
IN_logicalIDEndsWithquerystringNo
IN_logicalIDContainsquerystringNo
IN_logicalIDLikequerystringNo
IN_logicalIDBetweenquerystring[]No
IN_logicalIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
INV_OnOrder Parameters:
NameParameterData TypeRequiredDescription
InventoryIDformstringNo
OnOrderformdecimal?No
IN_logicalIDformstringNo
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.

POST /csv/reply/INV_OnOrderQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"OnOrder":0,"OnOrderGreaterThanOrEqualTo":0,"OnOrderGreaterThan":0,"OnOrderLessThan":0,"OnOrderLessThanOrEqualTo":0,"OnOrderNotEqualTo":0,"OnOrderBetween":[0],"OnOrderIn":[0],"IN_logicalID":"String","IN_logicalIDStartsWith":"String","IN_logicalIDEndsWith":"String","IN_logicalIDContains":"String","IN_logicalIDLike":"String","IN_logicalIDBetween":["String"],"IN_logicalIDIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"InventoryID":"String","OnOrder":0,"IN_logicalID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}