JiwaAPI

<back to all web services

SH_MainQuery

Requires Authentication
SH_MainQuery Parameters:
NameParameterData TypeRequiredDescription
ShipmentIDquerystringNo
ShipmentIDStartsWithquerystringNo
ShipmentIDEndsWithquerystringNo
ShipmentIDContainsquerystringNo
ShipmentIDLikequerystringNo
ShipmentIDBetweenquerystring[]No
ShipmentIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
ShipmentNoquerystringNo
ShipmentNoStartsWithquerystringNo
ShipmentNoEndsWithquerystringNo
ShipmentNoContainsquerystringNo
ShipmentNoLikequerystringNo
ShipmentNoBetweenquerystring[]No
ShipmentNoInquerystring[]No
Statusqueryshort?No
StatusGreaterThanOrEqualToqueryshort?No
StatusGreaterThanqueryshort?No
StatusLessThanqueryshort?No
StatusLessThanOrEqualToqueryshort?No
StatusNotEqualToqueryshort?No
StatusBetweenqueryshort[]No
StatusInqueryshort[]No
ShipInitDatequeryDateTime?No
ShipInitDateGreaterThanOrEqualToqueryDateTime?No
ShipInitDateGreaterThanqueryDateTime?No
ShipInitDateLessThanqueryDateTime?No
ShipInitDateLessThanOrEqualToqueryDateTime?No
ShipInitDateNotEqualToqueryDateTime?No
ShipInitDateBetweenqueryDateTime[]No
ShipInitDateInqueryDateTime[]No
WayBillNoquerystringNo
WayBillNoStartsWithquerystringNo
WayBillNoEndsWithquerystringNo
WayBillNoContainsquerystringNo
WayBillNoLikequerystringNo
WayBillNoBetweenquerystring[]No
WayBillNoInquerystring[]No
VesselNamequerystringNo
VesselNameStartsWithquerystringNo
VesselNameEndsWithquerystringNo
VesselNameContainsquerystringNo
VesselNameLikequerystringNo
VesselNameBetweenquerystring[]No
VesselNameInquerystring[]No
ContainerNoquerystringNo
ContainerNoStartsWithquerystringNo
ContainerNoEndsWithquerystringNo
ContainerNoContainsquerystringNo
ContainerNoLikequerystringNo
ContainerNoBetweenquerystring[]No
ContainerNoInquerystring[]No
ShippingAgentquerystringNo
ShippingAgentStartsWithquerystringNo
ShippingAgentEndsWithquerystringNo
ShippingAgentContainsquerystringNo
ShippingAgentLikequerystringNo
ShippingAgentBetweenquerystring[]No
ShippingAgentInquerystring[]No
DeliveryNotesquerystringNo
DeliveryNotesStartsWithquerystringNo
DeliveryNotesEndsWithquerystringNo
DeliveryNotesContainsquerystringNo
DeliveryNotesLikequerystringNo
DeliveryNotesBetweenquerystring[]No
DeliveryNotesInquerystring[]No
DepartureDatequeryDateTime?No
DepartureDateGreaterThanOrEqualToqueryDateTime?No
DepartureDateGreaterThanqueryDateTime?No
DepartureDateLessThanqueryDateTime?No
DepartureDateLessThanOrEqualToqueryDateTime?No
DepartureDateNotEqualToqueryDateTime?No
DepartureDateBetweenqueryNullable<DateTime>[]No
DepartureDateInqueryNullable<DateTime>[]No
ArrivalDatequeryDateTime?No
ArrivalDateGreaterThanOrEqualToqueryDateTime?No
ArrivalDateGreaterThanqueryDateTime?No
ArrivalDateLessThanqueryDateTime?No
ArrivalDateLessThanOrEqualToqueryDateTime?No
ArrivalDateNotEqualToqueryDateTime?No
ArrivalDateBetweenqueryNullable<DateTime>[]No
ArrivalDateInqueryNullable<DateTime>[]No
ReceiptDatequeryDateTime?No
ReceiptDateGreaterThanOrEqualToqueryDateTime?No
ReceiptDateGreaterThanqueryDateTime?No
ReceiptDateLessThanqueryDateTime?No
ReceiptDateLessThanOrEqualToqueryDateTime?No
ReceiptDateNotEqualToqueryDateTime?No
ReceiptDateBetweenqueryNullable<DateTime>[]No
ReceiptDateInqueryNullable<DateTime>[]No
UseVOTIquerybool?No
ImportCostClearingAccountIDquerystringNo
ImportCostClearingAccountIDStartsWithquerystringNo
ImportCostClearingAccountIDEndsWithquerystringNo
ImportCostClearingAccountIDContainsquerystringNo
ImportCostClearingAccountIDLikequerystringNo
ImportCostClearingAccountIDBetweenquerystring[]No
ImportCostClearingAccountIDInquerystring[]No
ExpectedArrivalDatequeryDateTime?No
ExpectedArrivalDateGreaterThanOrEqualToqueryDateTime?No
ExpectedArrivalDateGreaterThanqueryDateTime?No
ExpectedArrivalDateLessThanqueryDateTime?No
ExpectedArrivalDateLessThanOrEqualToqueryDateTime?No
ExpectedArrivalDateNotEqualToqueryDateTime?No
ExpectedArrivalDateBetweenqueryDateTime[]No
ExpectedArrivalDateInqueryDateTime[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SH_Main Parameters:
NameParameterData TypeRequiredDescription
ShipmentIDformstringNo
LastSavedDateTimeformDateTimeNo
IN_LogicalIDformstringNo
ShipmentNoformstringNo
StatusformshortNo
ShipInitDateformDateTimeNo
WayBillNoformstringNo
VesselNameformstringNo
ContainerNoformstringNo
ShippingAgentformstringNo
DeliveryNotesformstringNo
DepartureDateformDateTime?No
ArrivalDateformDateTime?No
ReceiptDateformDateTime?No
UseVOTIformboolNo
ImportCostClearingAccountIDformstringNo
ExpectedArrivalDateformDateTimeNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/SH_MainQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ShipmentID":"String","ShipmentIDStartsWith":"String","ShipmentIDEndsWith":"String","ShipmentIDContains":"String","ShipmentIDLike":"String","ShipmentIDBetween":["String"],"ShipmentIDIn":["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"],"IN_LogicalID":"String","IN_LogicalIDStartsWith":"String","IN_LogicalIDEndsWith":"String","IN_LogicalIDContains":"String","IN_LogicalIDLike":"String","IN_LogicalIDBetween":["String"],"IN_LogicalIDIn":["String"],"ShipmentNo":"String","ShipmentNoStartsWith":"String","ShipmentNoEndsWith":"String","ShipmentNoContains":"String","ShipmentNoLike":"String","ShipmentNoBetween":["String"],"ShipmentNoIn":["String"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[0],"ShipInitDate":"0001-01-01T00:00:00.0000000","ShipInitDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ShipInitDateGreaterThan":"0001-01-01T00:00:00.0000000","ShipInitDateLessThan":"0001-01-01T00:00:00.0000000","ShipInitDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ShipInitDateNotEqualTo":"0001-01-01T00:00:00.0000000","ShipInitDateBetween":["0001-01-01T00:00:00.0000000"],"ShipInitDateIn":["0001-01-01T00:00:00.0000000"],"WayBillNo":"String","WayBillNoStartsWith":"String","WayBillNoEndsWith":"String","WayBillNoContains":"String","WayBillNoLike":"String","WayBillNoBetween":["String"],"WayBillNoIn":["String"],"VesselName":"String","VesselNameStartsWith":"String","VesselNameEndsWith":"String","VesselNameContains":"String","VesselNameLike":"String","VesselNameBetween":["String"],"VesselNameIn":["String"],"ContainerNo":"String","ContainerNoStartsWith":"String","ContainerNoEndsWith":"String","ContainerNoContains":"String","ContainerNoLike":"String","ContainerNoBetween":["String"],"ContainerNoIn":["String"],"ShippingAgent":"String","ShippingAgentStartsWith":"String","ShippingAgentEndsWith":"String","ShippingAgentContains":"String","ShippingAgentLike":"String","ShippingAgentBetween":["String"],"ShippingAgentIn":["String"],"DeliveryNotes":"String","DeliveryNotesStartsWith":"String","DeliveryNotesEndsWith":"String","DeliveryNotesContains":"String","DeliveryNotesLike":"String","DeliveryNotesBetween":["String"],"DeliveryNotesIn":["String"],"DepartureDate":"0001-01-01T00:00:00.0000000","DepartureDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DepartureDateGreaterThan":"0001-01-01T00:00:00.0000000","DepartureDateLessThan":"0001-01-01T00:00:00.0000000","DepartureDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DepartureDateNotEqualTo":"0001-01-01T00:00:00.0000000","DepartureDateBetween":["0001-01-01T00:00:00.0000000"],"DepartureDateIn":["0001-01-01T00:00:00.0000000"],"ArrivalDate":"0001-01-01T00:00:00.0000000","ArrivalDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ArrivalDateGreaterThan":"0001-01-01T00:00:00.0000000","ArrivalDateLessThan":"0001-01-01T00:00:00.0000000","ArrivalDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ArrivalDateNotEqualTo":"0001-01-01T00:00:00.0000000","ArrivalDateBetween":["0001-01-01T00:00:00.0000000"],"ArrivalDateIn":["0001-01-01T00:00:00.0000000"],"ReceiptDate":"0001-01-01T00:00:00.0000000","ReceiptDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ReceiptDateGreaterThan":"0001-01-01T00:00:00.0000000","ReceiptDateLessThan":"0001-01-01T00:00:00.0000000","ReceiptDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ReceiptDateNotEqualTo":"0001-01-01T00:00:00.0000000","ReceiptDateBetween":["0001-01-01T00:00:00.0000000"],"ReceiptDateIn":["0001-01-01T00:00:00.0000000"],"UseVOTI":false,"ImportCostClearingAccountID":"String","ImportCostClearingAccountIDStartsWith":"String","ImportCostClearingAccountIDEndsWith":"String","ImportCostClearingAccountIDContains":"String","ImportCostClearingAccountIDLike":"String","ImportCostClearingAccountIDBetween":["String"],"ImportCostClearingAccountIDIn":["String"],"ExpectedArrivalDate":"0001-01-01T00:00:00.0000000","ExpectedArrivalDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpectedArrivalDateGreaterThan":"0001-01-01T00:00:00.0000000","ExpectedArrivalDateLessThan":"0001-01-01T00:00:00.0000000","ExpectedArrivalDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ExpectedArrivalDateNotEqualTo":"0001-01-01T00:00:00.0000000","ExpectedArrivalDateBetween":["0001-01-01T00:00:00.0000000"],"ExpectedArrivalDateIn":["0001-01-01T00:00:00.0000000"],"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":[{"ShipmentID":"String","IN_LogicalID":"String","ShipmentNo":"String","WayBillNo":"String","VesselName":"String","ContainerNo":"String","ShippingAgent":"String","DeliveryNotes":"String","DepartureDate":"0001-01-01T00:00:00.0000000","ArrivalDate":"0001-01-01T00:00:00.0000000","ReceiptDate":"0001-01-01T00:00:00.0000000","ImportCostClearingAccountID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}