JiwaAPI

<back to all web services

V_ShipmentQuery

Requires Authentication
V_ShipmentQuery Parameters:
NameParameterData TypeRequiredDescription
ShipmentIDquerystringNo
ShipmentIDStartsWithquerystringNo
ShipmentIDEndsWithquerystringNo
ShipmentIDContainsquerystringNo
ShipmentIDLikequerystringNo
ShipmentIDBetweenquerystring[]No
ShipmentIDInquerystring[]No
LineIDquerystringNo
LineIDStartsWithquerystringNo
LineIDEndsWithquerystringNo
LineIDContainsquerystringNo
LineIDLikequerystringNo
LineIDBetweenquerystring[]No
LineIDInquerystring[]No
OrderNoquerystringNo
OrderNoStartsWithquerystringNo
OrderNoEndsWithquerystringNo
OrderNoContainsquerystringNo
OrderNoLikequerystringNo
OrderNoBetweenquerystring[]No
OrderNoInquerystring[]No
InvoiceNoquerystringNo
InvoiceNoStartsWithquerystringNo
InvoiceNoEndsWithquerystringNo
InvoiceNoContainsquerystringNo
InvoiceNoLikequerystringNo
InvoiceNoBetweenquerystring[]No
InvoiceNoInquerystring[]No
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
PartNoquerystringNo
PartNoStartsWithquerystringNo
PartNoEndsWithquerystringNo
PartNoContainsquerystringNo
PartNoLikequerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
SuppPartNoquerystringNo
SuppPartNoStartsWithquerystringNo
SuppPartNoEndsWithquerystringNo
SuppPartNoContainsquerystringNo
SuppPartNoLikequerystringNo
SuppPartNoBetweenquerystring[]No
SuppPartNoInquerystring[]No
QtyOrderedquerydecimal?No
QtyOrderedGreaterThanOrEqualToquerydecimal?No
QtyOrderedGreaterThanquerydecimal?No
QtyOrderedLessThanquerydecimal?No
QtyOrderedLessThanOrEqualToquerydecimal?No
QtyOrderedNotEqualToquerydecimal?No
QtyOrderedBetweenqueryNullable<Decimal>[]No
QtyOrderedInqueryNullable<Decimal>[]No
QtyThisShipquerydecimal?No
QtyThisShipGreaterThanOrEqualToquerydecimal?No
QtyThisShipGreaterThanquerydecimal?No
QtyThisShipLessThanquerydecimal?No
QtyThisShipLessThanOrEqualToquerydecimal?No
QtyThisShipNotEqualToquerydecimal?No
QtyThisShipBetweenqueryNullable<Decimal>[]No
QtyThisShipInqueryNullable<Decimal>[]No
LineCostquerydecimal?No
LineCostGreaterThanOrEqualToquerydecimal?No
LineCostGreaterThanquerydecimal?No
LineCostLessThanquerydecimal?No
LineCostLessThanOrEqualToquerydecimal?No
LineCostNotEqualToquerydecimal?No
LineCostBetweenqueryNullable<Decimal>[]No
LineCostInqueryNullable<Decimal>[]No
LandedCostquerydecimal?No
LandedCostGreaterThanOrEqualToquerydecimal?No
LandedCostGreaterThanquerydecimal?No
LandedCostLessThanquerydecimal?No
LandedCostLessThanOrEqualToquerydecimal?No
LandedCostNotEqualToquerydecimal?No
LandedCostBetweenqueryNullable<Decimal>[]No
LandedCostInqueryNullable<Decimal>[]No
LandedTotalquerydecimal?No
LandedTotalGreaterThanOrEqualToquerydecimal?No
LandedTotalGreaterThanquerydecimal?No
LandedTotalLessThanquerydecimal?No
LandedTotalLessThanOrEqualToquerydecimal?No
LandedTotalNotEqualToquerydecimal?No
LandedTotalBetweenqueryNullable<Decimal>[]No
LandedTotalInqueryNullable<Decimal>[]No
CostTypequerystringNo
CostTypeStartsWithquerystringNo
CostTypeEndsWithquerystringNo
CostTypeContainsquerystringNo
CostTypeLikequerystringNo
CostTypeBetweenquerystring[]No
CostTypeInquerystring[]No
CurrencyIDquerystringNo
CurrencyIDStartsWithquerystringNo
CurrencyIDEndsWithquerystringNo
CurrencyIDContainsquerystringNo
CurrencyIDLikequerystringNo
CurrencyIDBetweenquerystring[]No
CurrencyIDInquerystring[]No
FXratequerydecimal?No
FXrateGreaterThanOrEqualToquerydecimal?No
FXrateGreaterThanquerydecimal?No
FXrateLessThanquerydecimal?No
FXrateLessThanOrEqualToquerydecimal?No
FXrateNotEqualToquerydecimal?No
FXrateBetweenqueryNullable<Decimal>[]No
FXrateInqueryNullable<Decimal>[]No
FXAmountquerydecimal?No
FXAmountGreaterThanOrEqualToquerydecimal?No
FXAmountGreaterThanquerydecimal?No
FXAmountLessThanquerydecimal?No
FXAmountLessThanOrEqualToquerydecimal?No
FXAmountNotEqualToquerydecimal?No
FXAmountBetweenqueryNullable<Decimal>[]No
FXAmountInqueryNullable<Decimal>[]No
HomeAmountquerydecimal?No
HomeAmountGreaterThanOrEqualToquerydecimal?No
HomeAmountGreaterThanquerydecimal?No
HomeAmountLessThanquerydecimal?No
HomeAmountLessThanOrEqualToquerydecimal?No
HomeAmountNotEqualToquerydecimal?No
HomeAmountBetweenqueryNullable<Decimal>[]No
HomeAmountInqueryNullable<Decimal>[]No
GSTDescquerystringNo
GSTDescStartsWithquerystringNo
GSTDescEndsWithquerystringNo
GSTDescContainsquerystringNo
GSTDescLikequerystringNo
GSTDescBetweenquerystring[]No
GSTDescInquerystring[]No
GSTAmountquerydecimal?No
GSTAmountGreaterThanOrEqualToquerydecimal?No
GSTAmountGreaterThanquerydecimal?No
GSTAmountLessThanquerydecimal?No
GSTAmountLessThanOrEqualToquerydecimal?No
GSTAmountNotEqualToquerydecimal?No
GSTAmountBetweenqueryNullable<Decimal>[]No
GSTAmountInqueryNullable<Decimal>[]No
GSTRatequerydecimal?No
GSTRateGreaterThanOrEqualToquerydecimal?No
GSTRateGreaterThanquerydecimal?No
GSTRateLessThanquerydecimal?No
GSTRateLessThanOrEqualToquerydecimal?No
GSTRateNotEqualToquerydecimal?No
GSTRateBetweenqueryNullable<Decimal>[]No
GSTRateInqueryNullable<Decimal>[]No
TotalAmountquerydecimal?No
TotalAmountGreaterThanOrEqualToquerydecimal?No
TotalAmountGreaterThanquerydecimal?No
TotalAmountLessThanquerydecimal?No
TotalAmountLessThanOrEqualToquerydecimal?No
TotalAmountNotEqualToquerydecimal?No
TotalAmountBetweenqueryNullable<Decimal>[]No
TotalAmountInqueryNullable<Decimal>[]No
ApportionedOnPOquerystringNo
ApportionedOnPOStartsWithquerystringNo
ApportionedOnPOEndsWithquerystringNo
ApportionedOnPOContainsquerystringNo
ApportionedOnPOLikequerystringNo
ApportionedOnPOBetweenquerystring[]No
ApportionedOnPOInquerystring[]No
DueDatequeryDateTime?No
DueDateGreaterThanOrEqualToqueryDateTime?No
DueDateGreaterThanqueryDateTime?No
DueDateLessThanqueryDateTime?No
DueDateLessThanOrEqualToqueryDateTime?No
DueDateNotEqualToqueryDateTime?No
DueDateBetweenqueryNullable<DateTime>[]No
DueDateInqueryNullable<DateTime>[]No
DatequeryDateTime?No
DateGreaterThanOrEqualToqueryDateTime?No
DateGreaterThanqueryDateTime?No
DateLessThanqueryDateTime?No
DateLessThanOrEqualToqueryDateTime?No
DateNotEqualToqueryDateTime?No
DateBetweenqueryDateTime[]No
DateInqueryDateTime[]No
SectionDescquerystringNo
SectionDescStartsWithquerystringNo
SectionDescEndsWithquerystringNo
SectionDescContainsquerystringNo
SectionDescLikequerystringNo
SectionDescBetweenquerystring[]No
SectionDescInquerystring[]No
TotalCostquerydecimal?No
TotalCostGreaterThanOrEqualToquerydecimal?No
TotalCostGreaterThanquerydecimal?No
TotalCostLessThanquerydecimal?No
TotalCostLessThanOrEqualToquerydecimal?No
TotalCostNotEqualToquerydecimal?No
TotalCostBetweenqueryNullable<Decimal>[]No
TotalCostInqueryNullable<Decimal>[]No
UnitCostExGSTquerydecimal?No
UnitCostExGSTGreaterThanOrEqualToquerydecimal?No
UnitCostExGSTGreaterThanquerydecimal?No
UnitCostExGSTLessThanquerydecimal?No
UnitCostExGSTLessThanOrEqualToquerydecimal?No
UnitCostExGSTNotEqualToquerydecimal?No
UnitCostExGSTBetweenqueryNullable<Decimal>[]No
UnitCostExGSTInqueryNullable<Decimal>[]No
Dutyquerydecimal?No
DutyGreaterThanOrEqualToquerydecimal?No
DutyGreaterThanquerydecimal?No
DutyLessThanquerydecimal?No
DutyLessThanOrEqualToquerydecimal?No
DutyNotEqualToquerydecimal?No
DutyBetweenqueryNullable<Decimal>[]No
DutyInqueryNullable<Decimal>[]No
Expensesquerydecimal?No
ExpensesGreaterThanOrEqualToquerydecimal?No
ExpensesGreaterThanquerydecimal?No
ExpensesLessThanquerydecimal?No
ExpensesLessThanOrEqualToquerydecimal?No
ExpensesNotEqualToquerydecimal?No
ExpensesBetweenqueryNullable<Decimal>[]No
ExpensesInqueryNullable<Decimal>[]No
FXShipUnitCostExGSTquerydecimal?No
FXShipUnitCostExGSTGreaterThanOrEqualToquerydecimal?No
FXShipUnitCostExGSTGreaterThanquerydecimal?No
FXShipUnitCostExGSTLessThanquerydecimal?No
FXShipUnitCostExGSTLessThanOrEqualToquerydecimal?No
FXShipUnitCostExGSTNotEqualToquerydecimal?No
FXShipUnitCostExGSTBetweenqueryNullable<Decimal>[]No
FXShipUnitCostExGSTInqueryNullable<Decimal>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
V_Shipment Parameters:
NameParameterData TypeRequiredDescription
ShipmentIDformstringNo
LineIDformstringNo
OrderNoformstringNo
InvoiceNoformstringNo
CreditorIDformstringNo
PartNoformstringNo
DescriptionformstringNo
SuppPartNoformstringNo
QtyOrderedformdecimal?No
QtyThisShipformdecimal?No
LineCostformdecimal?No
LandedCostformdecimal?No
LandedTotalformdecimal?No
CostTypeformstringNo
CurrencyIDformstringNo
FXrateformdecimal?No
FXAmountformdecimal?No
HomeAmountformdecimal?No
GSTDescformstringNo
GSTAmountformdecimal?No
GSTRateformdecimal?No
TotalAmountformdecimal?No
ApportionedOnPOformstringNo
DueDateformDateTime?No
DateformDateTimeNo
SectionDescformstringNo
TotalCostformdecimal?No
UnitCostExGSTformdecimal?No
Dutyformdecimal?No
Expensesformdecimal?No
FXShipUnitCostExGSTformdecimal?No
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/V_ShipmentQuery 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"],"LineID":"String","LineIDStartsWith":"String","LineIDEndsWith":"String","LineIDContains":"String","LineIDLike":"String","LineIDBetween":["String"],"LineIDIn":["String"],"OrderNo":"String","OrderNoStartsWith":"String","OrderNoEndsWith":"String","OrderNoContains":"String","OrderNoLike":"String","OrderNoBetween":["String"],"OrderNoIn":["String"],"InvoiceNo":"String","InvoiceNoStartsWith":"String","InvoiceNoEndsWith":"String","InvoiceNoContains":"String","InvoiceNoLike":"String","InvoiceNoBetween":["String"],"InvoiceNoIn":["String"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"PartNo":"String","PartNoStartsWith":"String","PartNoEndsWith":"String","PartNoContains":"String","PartNoLike":"String","PartNoBetween":["String"],"PartNoIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"SuppPartNo":"String","SuppPartNoStartsWith":"String","SuppPartNoEndsWith":"String","SuppPartNoContains":"String","SuppPartNoLike":"String","SuppPartNoBetween":["String"],"SuppPartNoIn":["String"],"QtyOrdered":0,"QtyOrderedGreaterThanOrEqualTo":0,"QtyOrderedGreaterThan":0,"QtyOrderedLessThan":0,"QtyOrderedLessThanOrEqualTo":0,"QtyOrderedNotEqualTo":0,"QtyOrderedBetween":[0],"QtyOrderedIn":[0],"QtyThisShip":0,"QtyThisShipGreaterThanOrEqualTo":0,"QtyThisShipGreaterThan":0,"QtyThisShipLessThan":0,"QtyThisShipLessThanOrEqualTo":0,"QtyThisShipNotEqualTo":0,"QtyThisShipBetween":[0],"QtyThisShipIn":[0],"LineCost":0,"LineCostGreaterThanOrEqualTo":0,"LineCostGreaterThan":0,"LineCostLessThan":0,"LineCostLessThanOrEqualTo":0,"LineCostNotEqualTo":0,"LineCostBetween":[0],"LineCostIn":[0],"LandedCost":0,"LandedCostGreaterThanOrEqualTo":0,"LandedCostGreaterThan":0,"LandedCostLessThan":0,"LandedCostLessThanOrEqualTo":0,"LandedCostNotEqualTo":0,"LandedCostBetween":[0],"LandedCostIn":[0],"LandedTotal":0,"LandedTotalGreaterThanOrEqualTo":0,"LandedTotalGreaterThan":0,"LandedTotalLessThan":0,"LandedTotalLessThanOrEqualTo":0,"LandedTotalNotEqualTo":0,"LandedTotalBetween":[0],"LandedTotalIn":[0],"CostType":"String","CostTypeStartsWith":"String","CostTypeEndsWith":"String","CostTypeContains":"String","CostTypeLike":"String","CostTypeBetween":["String"],"CostTypeIn":["String"],"CurrencyID":"String","CurrencyIDStartsWith":"String","CurrencyIDEndsWith":"String","CurrencyIDContains":"String","CurrencyIDLike":"String","CurrencyIDBetween":["String"],"CurrencyIDIn":["String"],"FXrate":0,"FXrateGreaterThanOrEqualTo":0,"FXrateGreaterThan":0,"FXrateLessThan":0,"FXrateLessThanOrEqualTo":0,"FXrateNotEqualTo":0,"FXrateBetween":[0],"FXrateIn":[0],"FXAmount":0,"FXAmountGreaterThanOrEqualTo":0,"FXAmountGreaterThan":0,"FXAmountLessThan":0,"FXAmountLessThanOrEqualTo":0,"FXAmountNotEqualTo":0,"FXAmountBetween":[0],"FXAmountIn":[0],"HomeAmount":0,"HomeAmountGreaterThanOrEqualTo":0,"HomeAmountGreaterThan":0,"HomeAmountLessThan":0,"HomeAmountLessThanOrEqualTo":0,"HomeAmountNotEqualTo":0,"HomeAmountBetween":[0],"HomeAmountIn":[0],"GSTDesc":"String","GSTDescStartsWith":"String","GSTDescEndsWith":"String","GSTDescContains":"String","GSTDescLike":"String","GSTDescBetween":["String"],"GSTDescIn":["String"],"GSTAmount":0,"GSTAmountGreaterThanOrEqualTo":0,"GSTAmountGreaterThan":0,"GSTAmountLessThan":0,"GSTAmountLessThanOrEqualTo":0,"GSTAmountNotEqualTo":0,"GSTAmountBetween":[0],"GSTAmountIn":[0],"GSTRate":0,"GSTRateGreaterThanOrEqualTo":0,"GSTRateGreaterThan":0,"GSTRateLessThan":0,"GSTRateLessThanOrEqualTo":0,"GSTRateNotEqualTo":0,"GSTRateBetween":[0],"GSTRateIn":[0],"TotalAmount":0,"TotalAmountGreaterThanOrEqualTo":0,"TotalAmountGreaterThan":0,"TotalAmountLessThan":0,"TotalAmountLessThanOrEqualTo":0,"TotalAmountNotEqualTo":0,"TotalAmountBetween":[0],"TotalAmountIn":[0],"ApportionedOnPO":"String","ApportionedOnPOStartsWith":"String","ApportionedOnPOEndsWith":"String","ApportionedOnPOContains":"String","ApportionedOnPOLike":"String","ApportionedOnPOBetween":["String"],"ApportionedOnPOIn":["String"],"DueDate":"0001-01-01T00:00:00.0000000","DueDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateGreaterThan":"0001-01-01T00:00:00.0000000","DueDateLessThan":"0001-01-01T00:00:00.0000000","DueDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateNotEqualTo":"0001-01-01T00:00:00.0000000","DueDateBetween":["0001-01-01T00:00:00.0000000"],"DueDateIn":["0001-01-01T00:00:00.0000000"],"Date":"0001-01-01T00:00:00.0000000","DateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateGreaterThan":"0001-01-01T00:00:00.0000000","DateLessThan":"0001-01-01T00:00:00.0000000","DateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateNotEqualTo":"0001-01-01T00:00:00.0000000","DateBetween":["0001-01-01T00:00:00.0000000"],"DateIn":["0001-01-01T00:00:00.0000000"],"SectionDesc":"String","SectionDescStartsWith":"String","SectionDescEndsWith":"String","SectionDescContains":"String","SectionDescLike":"String","SectionDescBetween":["String"],"SectionDescIn":["String"],"TotalCost":0,"TotalCostGreaterThanOrEqualTo":0,"TotalCostGreaterThan":0,"TotalCostLessThan":0,"TotalCostLessThanOrEqualTo":0,"TotalCostNotEqualTo":0,"TotalCostBetween":[0],"TotalCostIn":[0],"UnitCostExGST":0,"UnitCostExGSTGreaterThanOrEqualTo":0,"UnitCostExGSTGreaterThan":0,"UnitCostExGSTLessThan":0,"UnitCostExGSTLessThanOrEqualTo":0,"UnitCostExGSTNotEqualTo":0,"UnitCostExGSTBetween":[0],"UnitCostExGSTIn":[0],"Duty":0,"DutyGreaterThanOrEqualTo":0,"DutyGreaterThan":0,"DutyLessThan":0,"DutyLessThanOrEqualTo":0,"DutyNotEqualTo":0,"DutyBetween":[0],"DutyIn":[0],"Expenses":0,"ExpensesGreaterThanOrEqualTo":0,"ExpensesGreaterThan":0,"ExpensesLessThan":0,"ExpensesLessThanOrEqualTo":0,"ExpensesNotEqualTo":0,"ExpensesBetween":[0],"ExpensesIn":[0],"FXShipUnitCostExGST":0,"FXShipUnitCostExGSTGreaterThanOrEqualTo":0,"FXShipUnitCostExGSTGreaterThan":0,"FXShipUnitCostExGSTLessThan":0,"FXShipUnitCostExGSTLessThanOrEqualTo":0,"FXShipUnitCostExGSTNotEqualTo":0,"FXShipUnitCostExGSTBetween":[0],"FXShipUnitCostExGSTIn":[0],"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","LineID":"String","OrderNo":"String","InvoiceNo":"String","CreditorID":"String","PartNo":"String","Description":"String","SuppPartNo":"String","QtyOrdered":0,"QtyThisShip":0,"LineCost":0,"LandedCost":0,"LandedTotal":0,"CostType":"String","CurrencyID":"String","FXrate":0,"FXAmount":0,"HomeAmount":0,"GSTDesc":"String","GSTAmount":0,"GSTRate":0,"TotalAmount":0,"ApportionedOnPO":"String","DueDate":"0001-01-01T00:00:00.0000000","SectionDesc":"String","TotalCost":0,"UnitCostExGST":0,"Duty":0,"Expenses":0,"FXShipUnitCostExGST":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}