Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IN_LogicalOrderID | query | string | No | |
IN_LogicalOrderIDStartsWith | query | string | No | |
IN_LogicalOrderIDEndsWith | query | string | No | |
IN_LogicalOrderIDContains | query | string | No | |
IN_LogicalOrderIDLike | query | string | No | |
IN_LogicalOrderIDBetween | query | string[] | No | |
IN_LogicalOrderIDIn | 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 | |
IN_LogicalID | query | string | No | |
IN_LogicalIDStartsWith | query | string | No | |
IN_LogicalIDEndsWith | query | string | No | |
IN_LogicalIDContains | query | string | No | |
IN_LogicalIDLike | query | string | No | |
IN_LogicalIDBetween | query | string[] | No | |
IN_LogicalIDIn | query | string[] | No | |
CentralWarehouseID | query | string | No | |
CentralWarehouseIDStartsWith | query | string | No | |
CentralWarehouseIDEndsWith | query | string | No | |
CentralWarehouseIDContains | query | string | No | |
CentralWarehouseIDLike | query | string | No | |
CentralWarehouseIDBetween | query | string[] | No | |
CentralWarehouseIDIn | 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 |
---|---|---|---|---|
IN_LogicalOrderID | form | string | No | |
InventoryID | form | string | No | |
IN_LogicalID | form | string | No | |
CentralWarehouseID | 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/IN_LogicalOrderQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"IN_LogicalOrderID":"String","IN_LogicalOrderIDStartsWith":"String","IN_LogicalOrderIDEndsWith":"String","IN_LogicalOrderIDContains":"String","IN_LogicalOrderIDLike":"String","IN_LogicalOrderIDBetween":["String"],"IN_LogicalOrderIDIn":["String"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"IN_LogicalID":"String","IN_LogicalIDStartsWith":"String","IN_LogicalIDEndsWith":"String","IN_LogicalIDContains":"String","IN_LogicalIDLike":"String","IN_LogicalIDBetween":["String"],"IN_LogicalIDIn":["String"],"CentralWarehouseID":"String","CentralWarehouseIDStartsWith":"String","CentralWarehouseIDEndsWith":"String","CentralWarehouseIDContains":"String","CentralWarehouseIDLike":"String","CentralWarehouseIDBetween":["String"],"CentralWarehouseIDIn":["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":[{"IN_LogicalOrderID":"String","InventoryID":"String","IN_LogicalID":"String","CentralWarehouseID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}