Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
InventoryID | query | string | No | |
InventoryIDStartsWith | query | string | No | |
InventoryIDEndsWith | query | string | No | |
InventoryIDContains | query | string | No | |
InventoryIDLike | query | string | No | |
InventoryIDBetween | query | string[] | No | |
InventoryIDIn | query | string[] | No | |
Qty | query | decimal? | No | |
QtyGreaterThanOrEqualTo | query | decimal? | No | |
QtyGreaterThan | query | decimal? | No | |
QtyLessThan | query | decimal? | No | |
QtyLessThanOrEqualTo | query | decimal? | No | |
QtyNotEqualTo | query | decimal? | No | |
QtyBetween | query | Nullable<Decimal>[] | No | |
QtyIn | query | Nullable<Decimal>[] | No | |
Price | query | decimal? | No | |
PriceGreaterThanOrEqualTo | query | decimal? | No | |
PriceGreaterThan | query | decimal? | No | |
PriceLessThan | query | decimal? | No | |
PriceLessThanOrEqualTo | query | decimal? | No | |
PriceNotEqualTo | query | decimal? | No | |
PriceBetween | query | Nullable<Decimal>[] | No | |
PriceIn | query | Nullable<Decimal>[] | No | |
EstBOValue | query | decimal? | No | |
EstBOValueGreaterThanOrEqualTo | query | decimal? | No | |
EstBOValueGreaterThan | query | decimal? | No | |
EstBOValueLessThan | query | decimal? | No | |
EstBOValueLessThanOrEqualTo | query | decimal? | No | |
EstBOValueNotEqualTo | query | decimal? | No | |
EstBOValueBetween | query | Nullable<Decimal>[] | No | |
EstBOValueIn | query | Nullable<Decimal>[] | No | |
IN_LogicalID | query | string | No | |
IN_LogicalIDStartsWith | query | string | No | |
IN_LogicalIDEndsWith | query | string | No | |
IN_LogicalIDContains | query | string | No | |
IN_LogicalIDLike | query | string | No | |
IN_LogicalIDBetween | query | string[] | No | |
IN_LogicalIDIn | query | string[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
InventoryID | form | string | No | |
Qty | form | decimal? | No | |
Price | form | decimal? | No | |
EstBOValue | form | decimal? | No | |
IN_LogicalID | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/INMGT020BOQTYQuery 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"],"Qty":0,"QtyGreaterThanOrEqualTo":0,"QtyGreaterThan":0,"QtyLessThan":0,"QtyLessThanOrEqualTo":0,"QtyNotEqualTo":0,"QtyBetween":[0],"QtyIn":[0],"Price":0,"PriceGreaterThanOrEqualTo":0,"PriceGreaterThan":0,"PriceLessThan":0,"PriceLessThanOrEqualTo":0,"PriceNotEqualTo":0,"PriceBetween":[0],"PriceIn":[0],"EstBOValue":0,"EstBOValueGreaterThanOrEqualTo":0,"EstBOValueGreaterThan":0,"EstBOValueLessThan":0,"EstBOValueLessThanOrEqualTo":0,"EstBOValueNotEqualTo":0,"EstBOValueBetween":[0],"EstBOValueIn":[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","Qty":0,"Price":0,"EstBOValue":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"}}}