| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderID | query | string | No | |
| OrderIDStartsWith | query | string | No | |
| OrderIDEndsWith | query | string | No | |
| OrderIDContains | query | string | No | |
| OrderIDLike | query | string | No | |
| OrderIDBetween | query | string[] | No | |
| OrderIDIn | query | string[] | No | |
| LastSavedDateTime | query | DateTime? | No | |
| LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeGreaterThan | query | DateTime? | No | |
| LastSavedDateTimeLessThan | query | DateTime? | No | |
| LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
| LastSavedDateTimeBetween | query | DateTime[] | No | |
| LastSavedDateTimeIn | query | DateTime[] | No | |
| AddressLine1 | query | string | No | |
| AddressLine1StartsWith | query | string | No | |
| AddressLine1EndsWith | query | string | No | |
| AddressLine1Contains | query | string | No | |
| AddressLine1Like | query | string | No | |
| AddressLine1Between | query | string[] | No | |
| AddressLine1In | query | string[] | No | |
| AddressLine2 | query | string | No | |
| AddressLine2StartsWith | query | string | No | |
| AddressLine2EndsWith | query | string | No | |
| AddressLine2Contains | query | string | No | |
| AddressLine2Like | query | string | No | |
| AddressLine2Between | query | string[] | No | |
| AddressLine2In | query | string[] | No | |
| AddressLine3 | query | string | No | |
| AddressLine3StartsWith | query | string | No | |
| AddressLine3EndsWith | query | string | No | |
| AddressLine3Contains | query | string | No | |
| AddressLine3Like | query | string | No | |
| AddressLine3Between | query | string[] | No | |
| AddressLine3In | query | string[] | No | |
| AddressLine4 | query | string | No | |
| AddressLine4StartsWith | query | string | No | |
| AddressLine4EndsWith | query | string | No | |
| AddressLine4Contains | query | string | No | |
| AddressLine4Like | query | string | No | |
| AddressLine4Between | query | string[] | No | |
| AddressLine4In | query | string[] | No | |
| Country | query | string | No | |
| CountryStartsWith | query | string | No | |
| CountryEndsWith | query | string | No | |
| CountryContains | query | string | No | |
| CountryLike | query | string | No | |
| CountryBetween | query | string[] | No | |
| CountryIn | query | string[] | No | |
| Postcode | query | string | No | |
| PostcodeStartsWith | query | string | No | |
| PostcodeEndsWith | query | string | No | |
| PostcodeContains | query | string | No | |
| PostcodeLike | query | string | No | |
| PostcodeBetween | query | string[] | No | |
| PostcodeIn | query | string[] | No | |
| ContactName | query | string | No | |
| ContactNameStartsWith | query | string | No | |
| ContactNameEndsWith | query | string | No | |
| ContactNameContains | query | string | No | |
| ContactNameLike | query | string | No | |
| ContactNameBetween | query | string[] | No | |
| ContactNameIn | query | string[] | No | |
| Phone | query | string | No | |
| PhoneStartsWith | query | string | No | |
| PhoneEndsWith | query | string | No | |
| PhoneContains | query | string | No | |
| PhoneLike | query | string | No | |
| PhoneBetween | query | string[] | No | |
| PhoneIn | query | string[] | No | |
| Fax | query | string | No | |
| FaxStartsWith | query | string | No | |
| FaxEndsWith | query | string | No | |
| FaxContains | query | string | No | |
| FaxLike | query | string | No | |
| FaxBetween | query | string[] | No | |
| FaxIn | query | string[] | No | |
| Spare1 | query | string | No | |
| Spare1StartsWith | query | string | No | |
| Spare1EndsWith | query | string | No | |
| Spare1Contains | query | string | No | |
| Spare1Like | query | string | No | |
| Spare1Between | query | string[] | No | |
| Spare1In | query | string[] | No | |
| Spare2 | query | string | No | |
| Spare2StartsWith | query | string | No | |
| Spare2EndsWith | query | string | No | |
| Spare2Contains | query | string | No | |
| Spare2Like | query | string | No | |
| Spare2Between | query | string[] | No | |
| Spare2In | query | string[] | No | |
| Spare3 | query | string | No | |
| Spare3StartsWith | query | string | No | |
| Spare3EndsWith | query | string | No | |
| Spare3Contains | query | string | No | |
| Spare3Like | query | string | No | |
| Spare3Between | query | string[] | No | |
| Spare3In | query | string[] | No | |
| Spare4 | query | string | No | |
| Spare4StartsWith | query | string | No | |
| Spare4EndsWith | query | string | No | |
| Spare4Contains | query | string | No | |
| Spare4Like | query | string | No | |
| Spare4Between | query | string[] | No | |
| Spare4In | query | string[] | No | |
| Spare5 | query | string | No | |
| Spare5StartsWith | query | string | No | |
| Spare5EndsWith | query | string | No | |
| Spare5Contains | query | string | No | |
| Spare5Like | query | string | No | |
| Spare5Between | query | string[] | No | |
| Spare5In | 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 |
|---|---|---|---|---|
| OrderID | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| AddressLine1 | form | string | No | |
| AddressLine2 | form | string | No | |
| AddressLine3 | form | string | No | |
| AddressLine4 | form | string | No | |
| Country | form | string | No | |
| Postcode | form | string | No | |
| ContactName | form | string | No | |
| Phone | form | string | No | |
| Fax | form | string | No | |
| Spare1 | form | string | No | |
| Spare2 | form | string | No | |
| Spare3 | form | string | No | |
| Spare4 | form | string | No | |
| Spare5 | 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/PO_ShippingAddressQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"OrderID":"String","OrderIDStartsWith":"String","OrderIDEndsWith":"String","OrderIDContains":"String","OrderIDLike":"String","OrderIDBetween":["String"],"OrderIDIn":["String"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"AddressLine1":"String","AddressLine1StartsWith":"String","AddressLine1EndsWith":"String","AddressLine1Contains":"String","AddressLine1Like":"String","AddressLine1Between":["String"],"AddressLine1In":["String"],"AddressLine2":"String","AddressLine2StartsWith":"String","AddressLine2EndsWith":"String","AddressLine2Contains":"String","AddressLine2Like":"String","AddressLine2Between":["String"],"AddressLine2In":["String"],"AddressLine3":"String","AddressLine3StartsWith":"String","AddressLine3EndsWith":"String","AddressLine3Contains":"String","AddressLine3Like":"String","AddressLine3Between":["String"],"AddressLine3In":["String"],"AddressLine4":"String","AddressLine4StartsWith":"String","AddressLine4EndsWith":"String","AddressLine4Contains":"String","AddressLine4Like":"String","AddressLine4Between":["String"],"AddressLine4In":["String"],"Country":"String","CountryStartsWith":"String","CountryEndsWith":"String","CountryContains":"String","CountryLike":"String","CountryBetween":["String"],"CountryIn":["String"],"Postcode":"String","PostcodeStartsWith":"String","PostcodeEndsWith":"String","PostcodeContains":"String","PostcodeLike":"String","PostcodeBetween":["String"],"PostcodeIn":["String"],"ContactName":"String","ContactNameStartsWith":"String","ContactNameEndsWith":"String","ContactNameContains":"String","ContactNameLike":"String","ContactNameBetween":["String"],"ContactNameIn":["String"],"Phone":"String","PhoneStartsWith":"String","PhoneEndsWith":"String","PhoneContains":"String","PhoneLike":"String","PhoneBetween":["String"],"PhoneIn":["String"],"Fax":"String","FaxStartsWith":"String","FaxEndsWith":"String","FaxContains":"String","FaxLike":"String","FaxBetween":["String"],"FaxIn":["String"],"Spare1":"String","Spare1StartsWith":"String","Spare1EndsWith":"String","Spare1Contains":"String","Spare1Like":"String","Spare1Between":["String"],"Spare1In":["String"],"Spare2":"String","Spare2StartsWith":"String","Spare2EndsWith":"String","Spare2Contains":"String","Spare2Like":"String","Spare2Between":["String"],"Spare2In":["String"],"Spare3":"String","Spare3StartsWith":"String","Spare3EndsWith":"String","Spare3Contains":"String","Spare3Like":"String","Spare3Between":["String"],"Spare3In":["String"],"Spare4":"String","Spare4StartsWith":"String","Spare4EndsWith":"String","Spare4Contains":"String","Spare4Like":"String","Spare4Between":["String"],"Spare4In":["String"],"Spare5":"String","Spare5StartsWith":"String","Spare5EndsWith":"String","Spare5Contains":"String","Spare5Like":"String","Spare5Between":["String"],"Spare5In":["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":[{"OrderID":"String","AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressLine4":"String","Country":"String","Postcode":"String","ContactName":"String","Phone":"String","Fax":"String","Spare1":"String","Spare2":"String","Spare3":"String","Spare4":"String","Spare5":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}