| 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 | |
| ManualQty | query | decimal? | No | |
| ManualQtyGreaterThanOrEqualTo | query | decimal? | No | |
| ManualQtyGreaterThan | query | decimal? | No | |
| ManualQtyLessThan | query | decimal? | No | |
| ManualQtyLessThanOrEqualTo | query | decimal? | No | |
| ManualQtyNotEqualTo | query | decimal? | No | |
| ManualQtyBetween | query | Nullable<Decimal>[] | No | |
| ManualQtyIn | query | Nullable<Decimal>[] | No | |
| AutoQty | query | decimal? | No | |
| AutoQtyGreaterThanOrEqualTo | query | decimal? | No | |
| AutoQtyGreaterThan | query | decimal? | No | |
| AutoQtyLessThan | query | decimal? | No | |
| AutoQtyLessThanOrEqualTo | query | decimal? | No | |
| AutoQtyNotEqualTo | query | decimal? | No | |
| AutoQtyBetween | query | Nullable<Decimal>[] | No | |
| AutoQtyIn | 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 | |
| ManualQty | form | decimal? | No | |
| AutoQty | 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/INV_BOQTYQuery 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],"ManualQty":0,"ManualQtyGreaterThanOrEqualTo":0,"ManualQtyGreaterThan":0,"ManualQtyLessThan":0,"ManualQtyLessThanOrEqualTo":0,"ManualQtyNotEqualTo":0,"ManualQtyBetween":[0],"ManualQtyIn":[0],"AutoQty":0,"AutoQtyGreaterThanOrEqualTo":0,"AutoQtyGreaterThan":0,"AutoQtyLessThan":0,"AutoQtyLessThanOrEqualTo":0,"AutoQtyNotEqualTo":0,"AutoQtyBetween":[0],"AutoQtyIn":[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,"ManualQty":0,"AutoQty":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"}}}