| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | string | No | |
| RecIDStartsWith | query | string | No | |
| RecIDEndsWith | query | string | No | |
| RecIDContains | query | string | No | |
| RecIDLike | query | string | No | |
| RecIDBetween | query | string[] | No | |
| RecIDIn | query | string[] | No | |
| 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 | |
| UpSellInventoryID | query | string | No | |
| UpSellInventoryIDStartsWith | query | string | No | |
| UpSellInventoryIDEndsWith | query | string | No | |
| UpSellInventoryIDContains | query | string | No | |
| UpSellInventoryIDLike | query | string | No | |
| UpSellInventoryIDBetween | query | string[] | No | |
| UpSellInventoryIDIn | query | string[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | No | |
| PrimaryCategoryID | query | string | No | |
| PrimaryCategoryIDStartsWith | query | string | No | |
| PrimaryCategoryIDEndsWith | query | string | No | |
| PrimaryCategoryIDContains | query | string | No | |
| PrimaryCategoryIDLike | query | string | No | |
| PrimaryCategoryIDBetween | query | string[] | No | |
| PrimaryCategoryIDIn | query | string[] | No | |
| SecondaryCategoryID | query | string | No | |
| SecondaryCategoryIDStartsWith | query | string | No | |
| SecondaryCategoryIDEndsWith | query | string | No | |
| SecondaryCategoryIDContains | query | string | No | |
| SecondaryCategoryIDLike | query | string | No | |
| SecondaryCategoryIDBetween | query | string[] | No | |
| SecondaryCategoryIDIn | query | string[] | No | |
| Quantity | query | decimal? | No | |
| QuantityGreaterThanOrEqualTo | query | decimal? | No | |
| QuantityGreaterThan | query | decimal? | No | |
| QuantityLessThan | query | decimal? | No | |
| QuantityLessThanOrEqualTo | query | decimal? | No | |
| QuantityNotEqualTo | query | decimal? | No | |
| QuantityBetween | query | Nullable<Decimal>[] | No | |
| QuantityIn | 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 |
|---|---|---|---|---|
| RecID | form | string | No | |
| InventoryID | form | string | No | |
| UpSellInventoryID | form | string | No | |
| Description | form | string | No | |
| PrimaryCategoryID | form | string | No | |
| SecondaryCategoryID | form | string | No | |
| Quantity | 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/IN_UpSellQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"UpSellInventoryID":"String","UpSellInventoryIDStartsWith":"String","UpSellInventoryIDEndsWith":"String","UpSellInventoryIDContains":"String","UpSellInventoryIDLike":"String","UpSellInventoryIDBetween":["String"],"UpSellInventoryIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"PrimaryCategoryID":"String","PrimaryCategoryIDStartsWith":"String","PrimaryCategoryIDEndsWith":"String","PrimaryCategoryIDContains":"String","PrimaryCategoryIDLike":"String","PrimaryCategoryIDBetween":["String"],"PrimaryCategoryIDIn":["String"],"SecondaryCategoryID":"String","SecondaryCategoryIDStartsWith":"String","SecondaryCategoryIDEndsWith":"String","SecondaryCategoryIDContains":"String","SecondaryCategoryIDLike":"String","SecondaryCategoryIDBetween":["String"],"SecondaryCategoryIDIn":["String"],"Quantity":0,"QuantityGreaterThanOrEqualTo":0,"QuantityGreaterThan":0,"QuantityLessThan":0,"QuantityLessThanOrEqualTo":0,"QuantityNotEqualTo":0,"QuantityBetween":[0],"QuantityIn":[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":[{"RecID":"String","InventoryID":"String","UpSellInventoryID":"String","Description":"String","PrimaryCategoryID":"String","SecondaryCategoryID":"String","Quantity":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}