JiwaAPI

<back to all web services

SalesOrderHistoryFreightItemsGETRequest

Requires Authentication
The following routes are available for this service:
GET/SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}/Carrier/FreightItems/{FreightItemID}Retrieves a freight item for a sales order history
SalesOrderHistoryFreightItemsGETRequest Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDpathstringNo
InvoiceHistoryIDpathstringNo
FreightItemIDpathstringNo
SalesOrderFreightItem Parameters:
NameParameterData TypeRequiredDescription
FreightItemIDformstringNo
NumberItemsformint?No
ItemWeightformdecimal?No
ItemCubicformdecimal?No
ItemLengthformdecimal?No
ItemWidthformdecimal?No
ItemHeightformdecimal?No
ReferenceformstringNo
FreightDescriptionformSalesOrderCarrierFreightDescriptionNo
ConsignmentNoteformSalesOrderConsignmentNoteNo
SalesOrderCarrierFreightDescription Parameters:
NameParameterData TypeRequiredDescription
CarrierFreightDescriptionIDformstringNo
DescriptionformstringNo
SalesOrderConsignmentNote Parameters:
NameParameterData TypeRequiredDescription
ConsignmentNoteIDformstringNo
ConsignmentNoteDateformDateTime?No
ExGSTAmountformdecimal?No
GSTAmountformdecimal?No
ConsignmentNoteNoformstringNo

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 /SalesOrders/{InvoiceID}/Historys/{InvoiceHistoryID}/Carrier/FreightItems/{FreightItemID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"FreightItemID":"String","NumberItems":0,"ItemWeight":0,"ItemCubic":0,"ItemLength":0,"ItemWidth":0,"ItemHeight":0,"Reference":"String","FreightDescription":{"CarrierFreightDescriptionID":"String","Description":"String"},"ConsignmentNote":{"ConsignmentNoteID":"String","ConsignmentNoteDate":"0001-01-01T00:00:00.0000000","ExGSTAmount":0,"GSTAmount":0,"ConsignmentNoteNo":"String"}}