| 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 | |
| Delivered | query | decimal? | No | |
| DeliveredGreaterThanOrEqualTo | query | decimal? | No | |
| DeliveredGreaterThan | query | decimal? | No | |
| DeliveredLessThan | query | decimal? | No | |
| DeliveredLessThanOrEqualTo | query | decimal? | No | |
| DeliveredNotEqualTo | query | decimal? | No | |
| DeliveredBetween | query | Nullable<Decimal>[] | No | |
| DeliveredIn | query | Nullable<Decimal>[] | 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 | |
| Delivered | form | decimal? | 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/PO_OrderQtyQuery 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],"Delivered":0,"DeliveredGreaterThanOrEqualTo":0,"DeliveredGreaterThan":0,"DeliveredLessThan":0,"DeliveredLessThanOrEqualTo":0,"DeliveredNotEqualTo":0,"DeliveredBetween":[0],"DeliveredIn":[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","Qty":0,"Delivered":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}