| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrdersPSOrdersID | query | string | No | |
| OrdersPSOrdersIDStartsWith | query | string | No | |
| OrdersPSOrdersIDEndsWith | query | string | No | |
| OrdersPSOrdersIDContains | query | string | No | |
| OrdersPSOrdersIDLike | query | string | No | |
| OrdersPSOrdersIDBetween | query | string[] | No | |
| OrdersPSOrdersIDIn | query | string[] | No | |
| PackSlipID | query | string | No | |
| PackSlipIDStartsWith | query | string | No | |
| PackSlipIDEndsWith | query | string | No | |
| PackSlipIDContains | query | string | No | |
| PackSlipIDLike | query | string | No | |
| PackSlipIDBetween | query | string[] | No | |
| PackSlipIDIn | query | string[] | No | |
| 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 | |
| TypeReceival | query | bool? | 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 |
|---|---|---|---|---|
| OrdersPSOrdersID | form | string | No | |
| PackSlipID | form | string | No | |
| OrderID | form | string | No | |
| TypeReceival | form | bool | 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/RE_OrdersUsedQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"OrdersPSOrdersID":"String","OrdersPSOrdersIDStartsWith":"String","OrdersPSOrdersIDEndsWith":"String","OrdersPSOrdersIDContains":"String","OrdersPSOrdersIDLike":"String","OrdersPSOrdersIDBetween":["String"],"OrdersPSOrdersIDIn":["String"],"PackSlipID":"String","PackSlipIDStartsWith":"String","PackSlipIDEndsWith":"String","PackSlipIDContains":"String","PackSlipIDLike":"String","PackSlipIDBetween":["String"],"PackSlipIDIn":["String"],"OrderID":"String","OrderIDStartsWith":"String","OrderIDEndsWith":"String","OrderIDContains":"String","OrderIDLike":"String","OrderIDBetween":["String"],"OrderIDIn":["String"],"TypeReceival":false,"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":[{"OrdersPSOrdersID":"String","PackSlipID":"String","OrderID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}