| 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 | |
| OnOrder | query | decimal? | No | |
| OnOrderGreaterThanOrEqualTo | query | decimal? | No | |
| OnOrderGreaterThan | query | decimal? | No | |
| OnOrderLessThan | query | decimal? | No | |
| OnOrderLessThanOrEqualTo | query | decimal? | No | |
| OnOrderNotEqualTo | query | decimal? | No | |
| OnOrderBetween | query | Nullable<Decimal>[] | No | |
| OnOrderIn | query | Nullable<Decimal>[] | No | |
| Status | query | short? | No | |
| StatusGreaterThanOrEqualTo | query | short? | No | |
| StatusGreaterThan | query | short? | No | |
| StatusLessThan | query | short? | No | |
| StatusLessThanOrEqualTo | query | short? | No | |
| StatusNotEqualTo | query | short? | No | |
| StatusBetween | query | short[] | No | |
| StatusIn | query | short[] | 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 | |
| OnOrder | form | decimal? | No | |
| Status | form | short | 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_OnOrderStatusQuery 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],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[0],"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}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}