JiwaAPI

<back to all web services

RA_ShipMainQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/RA_ShipMainRetrieves RA_ShipMain Shipment header records
RA_ShipMainQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
ShippingNoquerystringNo
ShippingNoStartsWithquerystringNo
ShippingNoEndsWithquerystringNo
ShippingNoContainsquerystringNo
ShippingNoLikequerystringNo
ShippingNoBetweenquerystring[]No
ShippingNoInquerystring[]No
RANumberquerystringNo
RANumberStartsWithquerystringNo
RANumberEndsWithquerystringNo
RANumberContainsquerystringNo
RANumberLikequerystringNo
RANumberBetweenquerystring[]No
RANumberInquerystring[]No
ReferencequerystringNo
ReferenceStartsWithquerystringNo
ReferenceEndsWithquerystringNo
ReferenceContainsquerystringNo
ReferenceLikequerystringNo
ReferenceBetweenquerystring[]No
ReferenceInquerystring[]No
WarehouseIDquerystringNo
WarehouseIDStartsWithquerystringNo
WarehouseIDEndsWithquerystringNo
WarehouseIDContainsquerystringNo
WarehouseIDLikequerystringNo
WarehouseIDBetweenquerystring[]No
WarehouseIDInquerystring[]No
Statusquerybyte?No
StatusGreaterThanOrEqualToquerybyte?No
StatusGreaterThanquerybyte?No
StatusLessThanquerybyte?No
StatusLessThanOrEqualToquerybyte?No
StatusNotEqualToquerybyte?No
StatusBetweenquerybyte[]No
StatusInquerybyte[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
CreatedByquerystringNo
CreatedByStartsWithquerystringNo
CreatedByEndsWithquerystringNo
CreatedByContainsquerystringNo
CreatedByLikequerystringNo
CreatedByBetweenquerystring[]No
CreatedByInquerystring[]No
ReturnCodequerystringNo
ReturnCodeStartsWithquerystringNo
ReturnCodeEndsWithquerystringNo
ReturnCodeContainsquerystringNo
ReturnCodeLikequerystringNo
ReturnCodeBetweenquerystring[]No
ReturnCodeInquerystring[]No
DeliveryStreetAddress1querystringNo
DeliveryStreetAddress1StartsWithquerystringNo
DeliveryStreetAddress1EndsWithquerystringNo
DeliveryStreetAddress1ContainsquerystringNo
DeliveryStreetAddress1LikequerystringNo
DeliveryStreetAddress1Betweenquerystring[]No
DeliveryStreetAddress1Inquerystring[]No
DeliveryStreetAddress2querystringNo
DeliveryStreetAddress2StartsWithquerystringNo
DeliveryStreetAddress2EndsWithquerystringNo
DeliveryStreetAddress2ContainsquerystringNo
DeliveryStreetAddress2LikequerystringNo
DeliveryStreetAddress2Betweenquerystring[]No
DeliveryStreetAddress2Inquerystring[]No
DeliveryLocalityquerystringNo
DeliveryLocalityStartsWithquerystringNo
DeliveryLocalityEndsWithquerystringNo
DeliveryLocalityContainsquerystringNo
DeliveryLocalityLikequerystringNo
DeliveryLocalityBetweenquerystring[]No
DeliveryLocalityInquerystring[]No
DeliveryRegionquerystringNo
DeliveryRegionStartsWithquerystringNo
DeliveryRegionEndsWithquerystringNo
DeliveryRegionContainsquerystringNo
DeliveryRegionLikequerystringNo
DeliveryRegionBetweenquerystring[]No
DeliveryRegionInquerystring[]No
DeliveryPostCodequerystringNo
DeliveryPostCodeStartsWithquerystringNo
DeliveryPostCodeEndsWithquerystringNo
DeliveryPostCodeContainsquerystringNo
DeliveryPostCodeLikequerystringNo
DeliveryPostCodeBetweenquerystring[]No
DeliveryPostCodeInquerystring[]No
ContactNamequerystringNo
ContactNameStartsWithquerystringNo
ContactNameEndsWithquerystringNo
ContactNameContainsquerystringNo
ContactNameLikequerystringNo
ContactNameBetweenquerystring[]No
ContactNameInquerystring[]No
NotequerystringNo
NoteStartsWithquerystringNo
NoteEndsWithquerystringNo
NoteContainsquerystringNo
NoteLikequerystringNo
NoteBetweenquerystring[]No
NoteInquerystring[]No
CourierDetailsquerystringNo
CourierDetailsStartsWithquerystringNo
CourierDetailsEndsWithquerystringNo
CourierDetailsContainsquerystringNo
CourierDetailsLikequerystringNo
CourierDetailsBetweenquerystring[]No
CourierDetailsInquerystring[]No
ShippingDatequeryDateTime?No
ShippingDateGreaterThanOrEqualToqueryDateTime?No
ShippingDateGreaterThanqueryDateTime?No
ShippingDateLessThanqueryDateTime?No
ShippingDateLessThanOrEqualToqueryDateTime?No
ShippingDateNotEqualToqueryDateTime?No
ShippingDateBetweenqueryDateTime[]No
ShippingDateInqueryDateTime[]No
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
TransitWarehouseIDquerystringNo
TransitWarehouseIDStartsWithquerystringNo
TransitWarehouseIDEndsWithquerystringNo
TransitWarehouseIDContainsquerystringNo
TransitWarehouseIDLikequerystringNo
TransitWarehouseIDBetweenquerystring[]No
TransitWarehouseIDInquerystring[]No
RowHashquerybyte[]No
DeliveryAddresseequerystringNo
DeliveryAddresseeStartsWithquerystringNo
DeliveryAddresseeEndsWithquerystringNo
DeliveryAddresseeContainsquerystringNo
DeliveryAddresseeLikequerystringNo
DeliveryAddresseeBetweenquerystring[]No
DeliveryAddresseeInquerystring[]No
DeliveryCountryquerystringNo
DeliveryCountryStartsWithquerystringNo
DeliveryCountryEndsWithquerystringNo
DeliveryCountryContainsquerystringNo
DeliveryCountryLikequerystringNo
DeliveryCountryBetweenquerystring[]No
DeliveryCountryInquerystring[]No
DeliveryTelephonequerystringNo
DeliveryTelephoneStartsWithquerystringNo
DeliveryTelephoneEndsWithquerystringNo
DeliveryTelephoneContainsquerystringNo
DeliveryTelephoneLikequerystringNo
DeliveryTelephoneBetweenquerystring[]No
DeliveryTelephoneInquerystring[]No
DeliveryFacsimilequerystringNo
DeliveryFacsimileStartsWithquerystringNo
DeliveryFacsimileEndsWithquerystringNo
DeliveryFacsimileContainsquerystringNo
DeliveryFacsimileLikequerystringNo
DeliveryFacsimileBetweenquerystring[]No
DeliveryFacsimileInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
RA_ShipMain Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
ShippingNoformstringNo
RANumberformstringNo
ReferenceformstringNo
WarehouseIDformstringNo
StatusformbyteNo
LastSavedDateTimeformDateTimeNo
CreatedByformstringNo
ReturnCodeformstringNo
DeliveryStreetAddress1formstringNo
DeliveryStreetAddress2formstringNo
DeliveryLocalityformstringNo
DeliveryRegionformstringNo
DeliveryPostCodeformstringNo
ContactNameformstringNo
NoteformstringNo
CourierDetailsformstringNo
ShippingDateformDateTimeNo
CreditorIDformstringNo
TransitWarehouseIDformstringNo
RowHashformbyte[]No
DeliveryAddresseeformstringNo
DeliveryCountryformstringNo
DeliveryTelephoneformstringNo
DeliveryFacsimileformstringNo
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.

GET /Queries/RA_ShipMain HTTP/1.1 
Host: apitrain.galipo.com.au 
Accept: text/csv
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"}}}