| 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 | |
| ShippingNo | query | string | No | |
| ShippingNoStartsWith | query | string | No | |
| ShippingNoEndsWith | query | string | No | |
| ShippingNoContains | query | string | No | |
| ShippingNoLike | query | string | No | |
| ShippingNoBetween | query | string[] | No | |
| ShippingNoIn | query | string[] | No | |
| RANumber | query | string | No | |
| RANumberStartsWith | query | string | No | |
| RANumberEndsWith | query | string | No | |
| RANumberContains | query | string | No | |
| RANumberLike | query | string | No | |
| RANumberBetween | query | string[] | No | |
| RANumberIn | query | string[] | No | |
| Reference | query | string | No | |
| ReferenceStartsWith | query | string | No | |
| ReferenceEndsWith | query | string | No | |
| ReferenceContains | query | string | No | |
| ReferenceLike | query | string | No | |
| ReferenceBetween | query | string[] | No | |
| ReferenceIn | query | string[] | No | |
| WarehouseID | query | string | No | |
| WarehouseIDStartsWith | query | string | No | |
| WarehouseIDEndsWith | query | string | No | |
| WarehouseIDContains | query | string | No | |
| WarehouseIDLike | query | string | No | |
| WarehouseIDBetween | query | string[] | No | |
| WarehouseIDIn | query | string[] | No | |
| Status | query | byte? | No | |
| StatusGreaterThanOrEqualTo | query | byte? | No | |
| StatusGreaterThan | query | byte? | No | |
| StatusLessThan | query | byte? | No | |
| StatusLessThanOrEqualTo | query | byte? | No | |
| StatusNotEqualTo | query | byte? | No | |
| StatusBetween | query | byte[] | No | |
| StatusIn | query | byte[] | 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 | |
| CreatedBy | query | string | No | |
| CreatedByStartsWith | query | string | No | |
| CreatedByEndsWith | query | string | No | |
| CreatedByContains | query | string | No | |
| CreatedByLike | query | string | No | |
| CreatedByBetween | query | string[] | No | |
| CreatedByIn | query | string[] | No | |
| ReturnCode | query | string | No | |
| ReturnCodeStartsWith | query | string | No | |
| ReturnCodeEndsWith | query | string | No | |
| ReturnCodeContains | query | string | No | |
| ReturnCodeLike | query | string | No | |
| ReturnCodeBetween | query | string[] | No | |
| ReturnCodeIn | query | string[] | No | |
| DeliveryStreetAddress1 | query | string | No | |
| DeliveryStreetAddress1StartsWith | query | string | No | |
| DeliveryStreetAddress1EndsWith | query | string | No | |
| DeliveryStreetAddress1Contains | query | string | No | |
| DeliveryStreetAddress1Like | query | string | No | |
| DeliveryStreetAddress1Between | query | string[] | No | |
| DeliveryStreetAddress1In | query | string[] | No | |
| DeliveryStreetAddress2 | query | string | No | |
| DeliveryStreetAddress2StartsWith | query | string | No | |
| DeliveryStreetAddress2EndsWith | query | string | No | |
| DeliveryStreetAddress2Contains | query | string | No | |
| DeliveryStreetAddress2Like | query | string | No | |
| DeliveryStreetAddress2Between | query | string[] | No | |
| DeliveryStreetAddress2In | query | string[] | No | |
| DeliveryLocality | query | string | No | |
| DeliveryLocalityStartsWith | query | string | No | |
| DeliveryLocalityEndsWith | query | string | No | |
| DeliveryLocalityContains | query | string | No | |
| DeliveryLocalityLike | query | string | No | |
| DeliveryLocalityBetween | query | string[] | No | |
| DeliveryLocalityIn | query | string[] | No | |
| DeliveryRegion | query | string | No | |
| DeliveryRegionStartsWith | query | string | No | |
| DeliveryRegionEndsWith | query | string | No | |
| DeliveryRegionContains | query | string | No | |
| DeliveryRegionLike | query | string | No | |
| DeliveryRegionBetween | query | string[] | No | |
| DeliveryRegionIn | query | string[] | No | |
| DeliveryPostCode | query | string | No | |
| DeliveryPostCodeStartsWith | query | string | No | |
| DeliveryPostCodeEndsWith | query | string | No | |
| DeliveryPostCodeContains | query | string | No | |
| DeliveryPostCodeLike | query | string | No | |
| DeliveryPostCodeBetween | query | string[] | No | |
| DeliveryPostCodeIn | 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 | |
| Note | query | string | No | |
| NoteStartsWith | query | string | No | |
| NoteEndsWith | query | string | No | |
| NoteContains | query | string | No | |
| NoteLike | query | string | No | |
| NoteBetween | query | string[] | No | |
| NoteIn | query | string[] | No | |
| CourierDetails | query | string | No | |
| CourierDetailsStartsWith | query | string | No | |
| CourierDetailsEndsWith | query | string | No | |
| CourierDetailsContains | query | string | No | |
| CourierDetailsLike | query | string | No | |
| CourierDetailsBetween | query | string[] | No | |
| CourierDetailsIn | query | string[] | No | |
| ShippingDate | query | DateTime? | No | |
| ShippingDateGreaterThanOrEqualTo | query | DateTime? | No | |
| ShippingDateGreaterThan | query | DateTime? | No | |
| ShippingDateLessThan | query | DateTime? | No | |
| ShippingDateLessThanOrEqualTo | query | DateTime? | No | |
| ShippingDateNotEqualTo | query | DateTime? | No | |
| ShippingDateBetween | query | DateTime[] | No | |
| ShippingDateIn | query | DateTime[] | No | |
| CreditorID | query | string | No | |
| CreditorIDStartsWith | query | string | No | |
| CreditorIDEndsWith | query | string | No | |
| CreditorIDContains | query | string | No | |
| CreditorIDLike | query | string | No | |
| CreditorIDBetween | query | string[] | No | |
| CreditorIDIn | query | string[] | No | |
| TransitWarehouseID | query | string | No | |
| TransitWarehouseIDStartsWith | query | string | No | |
| TransitWarehouseIDEndsWith | query | string | No | |
| TransitWarehouseIDContains | query | string | No | |
| TransitWarehouseIDLike | query | string | No | |
| TransitWarehouseIDBetween | query | string[] | No | |
| TransitWarehouseIDIn | query | string[] | No | |
| RowHash | query | byte[] | No | |
| DeliveryAddressee | query | string | No | |
| DeliveryAddresseeStartsWith | query | string | No | |
| DeliveryAddresseeEndsWith | query | string | No | |
| DeliveryAddresseeContains | query | string | No | |
| DeliveryAddresseeLike | query | string | No | |
| DeliveryAddresseeBetween | query | string[] | No | |
| DeliveryAddresseeIn | query | string[] | No | |
| DeliveryCountry | query | string | No | |
| DeliveryCountryStartsWith | query | string | No | |
| DeliveryCountryEndsWith | query | string | No | |
| DeliveryCountryContains | query | string | No | |
| DeliveryCountryLike | query | string | No | |
| DeliveryCountryBetween | query | string[] | No | |
| DeliveryCountryIn | query | string[] | No | |
| DeliveryTelephone | query | string | No | |
| DeliveryTelephoneStartsWith | query | string | No | |
| DeliveryTelephoneEndsWith | query | string | No | |
| DeliveryTelephoneContains | query | string | No | |
| DeliveryTelephoneLike | query | string | No | |
| DeliveryTelephoneBetween | query | string[] | No | |
| DeliveryTelephoneIn | query | string[] | No | |
| DeliveryFacsimile | query | string | No | |
| DeliveryFacsimileStartsWith | query | string | No | |
| DeliveryFacsimileEndsWith | query | string | No | |
| DeliveryFacsimileContains | query | string | No | |
| DeliveryFacsimileLike | query | string | No | |
| DeliveryFacsimileBetween | query | string[] | No | |
| DeliveryFacsimileIn | 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 |
|---|---|---|---|---|
| RecID | form | string | No | |
| ShippingNo | form | string | No | |
| RANumber | form | string | No | |
| Reference | form | string | No | |
| WarehouseID | form | string | No | |
| Status | form | byte | No | |
| LastSavedDateTime | form | DateTime | No | |
| CreatedBy | form | string | No | |
| ReturnCode | form | string | No | |
| DeliveryStreetAddress1 | form | string | No | |
| DeliveryStreetAddress2 | form | string | No | |
| DeliveryLocality | form | string | No | |
| DeliveryRegion | form | string | No | |
| DeliveryPostCode | form | string | No | |
| ContactName | form | string | No | |
| Note | form | string | No | |
| CourierDetails | form | string | No | |
| ShippingDate | form | DateTime | No | |
| CreditorID | form | string | No | |
| TransitWarehouseID | form | string | No | |
| RowHash | form | byte[] | No | |
| DeliveryAddressee | form | string | No | |
| DeliveryCountry | form | string | No | |
| DeliveryTelephone | form | string | No | |
| DeliveryFacsimile | 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/RA_ShipMainQuery 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"],"ShippingNo":"String","ShippingNoStartsWith":"String","ShippingNoEndsWith":"String","ShippingNoContains":"String","ShippingNoLike":"String","ShippingNoBetween":["String"],"ShippingNoIn":["String"],"RANumber":"String","RANumberStartsWith":"String","RANumberEndsWith":"String","RANumberContains":"String","RANumberLike":"String","RANumberBetween":["String"],"RANumberIn":["String"],"Reference":"String","ReferenceStartsWith":"String","ReferenceEndsWith":"String","ReferenceContains":"String","ReferenceLike":"String","ReferenceBetween":["String"],"ReferenceIn":["String"],"WarehouseID":"String","WarehouseIDStartsWith":"String","WarehouseIDEndsWith":"String","WarehouseIDContains":"String","WarehouseIDLike":"String","WarehouseIDBetween":["String"],"WarehouseIDIn":["String"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":"AA==","StatusIn":"AA==","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"],"CreatedBy":"String","CreatedByStartsWith":"String","CreatedByEndsWith":"String","CreatedByContains":"String","CreatedByLike":"String","CreatedByBetween":["String"],"CreatedByIn":["String"],"ReturnCode":"String","ReturnCodeStartsWith":"String","ReturnCodeEndsWith":"String","ReturnCodeContains":"String","ReturnCodeLike":"String","ReturnCodeBetween":["String"],"ReturnCodeIn":["String"],"DeliveryStreetAddress1":"String","DeliveryStreetAddress1StartsWith":"String","DeliveryStreetAddress1EndsWith":"String","DeliveryStreetAddress1Contains":"String","DeliveryStreetAddress1Like":"String","DeliveryStreetAddress1Between":["String"],"DeliveryStreetAddress1In":["String"],"DeliveryStreetAddress2":"String","DeliveryStreetAddress2StartsWith":"String","DeliveryStreetAddress2EndsWith":"String","DeliveryStreetAddress2Contains":"String","DeliveryStreetAddress2Like":"String","DeliveryStreetAddress2Between":["String"],"DeliveryStreetAddress2In":["String"],"DeliveryLocality":"String","DeliveryLocalityStartsWith":"String","DeliveryLocalityEndsWith":"String","DeliveryLocalityContains":"String","DeliveryLocalityLike":"String","DeliveryLocalityBetween":["String"],"DeliveryLocalityIn":["String"],"DeliveryRegion":"String","DeliveryRegionStartsWith":"String","DeliveryRegionEndsWith":"String","DeliveryRegionContains":"String","DeliveryRegionLike":"String","DeliveryRegionBetween":["String"],"DeliveryRegionIn":["String"],"DeliveryPostCode":"String","DeliveryPostCodeStartsWith":"String","DeliveryPostCodeEndsWith":"String","DeliveryPostCodeContains":"String","DeliveryPostCodeLike":"String","DeliveryPostCodeBetween":["String"],"DeliveryPostCodeIn":["String"],"ContactName":"String","ContactNameStartsWith":"String","ContactNameEndsWith":"String","ContactNameContains":"String","ContactNameLike":"String","ContactNameBetween":["String"],"ContactNameIn":["String"],"Note":"String","NoteStartsWith":"String","NoteEndsWith":"String","NoteContains":"String","NoteLike":"String","NoteBetween":["String"],"NoteIn":["String"],"CourierDetails":"String","CourierDetailsStartsWith":"String","CourierDetailsEndsWith":"String","CourierDetailsContains":"String","CourierDetailsLike":"String","CourierDetailsBetween":["String"],"CourierDetailsIn":["String"],"ShippingDate":"0001-01-01T00:00:00.0000000","ShippingDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ShippingDateGreaterThan":"0001-01-01T00:00:00.0000000","ShippingDateLessThan":"0001-01-01T00:00:00.0000000","ShippingDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ShippingDateNotEqualTo":"0001-01-01T00:00:00.0000000","ShippingDateBetween":["0001-01-01T00:00:00.0000000"],"ShippingDateIn":["0001-01-01T00:00:00.0000000"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"TransitWarehouseID":"String","TransitWarehouseIDStartsWith":"String","TransitWarehouseIDEndsWith":"String","TransitWarehouseIDContains":"String","TransitWarehouseIDLike":"String","TransitWarehouseIDBetween":["String"],"TransitWarehouseIDIn":["String"],"RowHash":"AA==","DeliveryAddressee":"String","DeliveryAddresseeStartsWith":"String","DeliveryAddresseeEndsWith":"String","DeliveryAddresseeContains":"String","DeliveryAddresseeLike":"String","DeliveryAddresseeBetween":["String"],"DeliveryAddresseeIn":["String"],"DeliveryCountry":"String","DeliveryCountryStartsWith":"String","DeliveryCountryEndsWith":"String","DeliveryCountryContains":"String","DeliveryCountryLike":"String","DeliveryCountryBetween":["String"],"DeliveryCountryIn":["String"],"DeliveryTelephone":"String","DeliveryTelephoneStartsWith":"String","DeliveryTelephoneEndsWith":"String","DeliveryTelephoneContains":"String","DeliveryTelephoneLike":"String","DeliveryTelephoneBetween":["String"],"DeliveryTelephoneIn":["String"],"DeliveryFacsimile":"String","DeliveryFacsimileStartsWith":"String","DeliveryFacsimileEndsWith":"String","DeliveryFacsimileContains":"String","DeliveryFacsimileLike":"String","DeliveryFacsimileBetween":["String"],"DeliveryFacsimileIn":["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":[{"RecID":"String","ShippingNo":"String","RANumber":"String","Reference":"String","WarehouseID":"String","CreatedBy":"String","ReturnCode":"String","DeliveryStreetAddress1":"String","DeliveryStreetAddress2":"String","DeliveryLocality":"String","DeliveryRegion":"String","DeliveryPostCode":"String","ContactName":"String","Note":"String","CourierDetails":"String","CreditorID":"String","TransitWarehouseID":"String","RowHash":"AA==","DeliveryAddressee":"String","DeliveryCountry":"String","DeliveryTelephone":"String","DeliveryFacsimile":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}