Needio.Services

<back to all web services

QueryShipmentForViewRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Trans/QueryShipmentForView/
QueryShipmentForViewRequest Parameters:
NameParameterData TypeRequiredDescription
TransReturnTypequeryTransReturnTypesNo
CargoKeyquerystringNo
ShippingMethodIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
QueryShipmentForViewResponse Parameters:
NameParameterData TypeRequiredDescription
QueryShipmentformQueryShipmentDTONo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
QueryShipmentDTO Parameters:
NameParameterData TypeRequiredDescription
TransReturnTypeformTransReturnTypesNo
CargoTransactionStatusformlongNo
CargoEventIdformstringNo
CargoReasonExplanationformstringNo
CargoKeyformstringNo
CargoCompanyDocIdformstringNo
ErrCodeformlongNo
ErrMessageformstringNo
TrackingUrlformstringNo
DeliveryDateformDateTime?No
ShippedDateformDateTime?No
RejectFlagformintNo
RejectStatusformstringNo
RejectReasonExplanationformstringNo
SenderCustIdformstringNo
SenderCustNameformstringNo
SenderAddressTxtformstringNo
ReceiverCustIdformstringNo
ReceiverCustNameformstringNo
ReceiverAddressTxtformstringNo
ArrivalUnitIdformstringNo
ArrivalUnitNameformstringNo
DepartureUnitIdformstringNo
DepartureUnitNameformstringNo
DeliveryUnitIdformstringNo
DeliveryUnitNameformstringNo
CargoMovementsformList<CargoMovementDTO>No
ReceiverInfoformstringNo
TotalPriceformdecimalNo
TotalVatformdecimalNo
TotalAmountformdecimalNo
CargoProductformstringNo
TotalDesiformdecimalNo
TotalKgformdecimalNo
TotalDesiKgformdecimalNo
TotalCargoformdecimalNo
ReturnTotalPriceformdecimalNo
ReturnTotalVatformdecimalNo
ReturnTotalAmountformdecimalNo
BarcodeStringValueformstringNo
DeliveryProblemFlgformboolNo
TransReturnTypes Enum:
NameValue
Transaction1
Return2
CargoMovementDTO Parameters:
NameParameterData TypeRequiredDescription
UnitIdformstringNo
UnitNameformstringNo
EventIdformstringNo
EventNameformstringNo
ReasonIdformstringNo
ReasonNameformstringNo
EventDateformDateTime?No
CityNameformstringNo
TownNameformstringNo
QueryShipmentForViewResponse Parameters:
NameParameterData TypeRequiredDescription
QueryShipmentformQueryShipmentDTONo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /Trans/QueryShipmentForView/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"TransReturnType":1,"CargoKey":"String","ShippingMethodId":0,"start":"\/Date(1638384812191+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"QueryShipment":{"TransReturnType":1,"CargoTransactionStatus":0,"CargoEventId":"String","CargoReasonExplanation":"String","CargoKey":"String","CargoCompanyDocId":"String","ErrCode":0,"ErrMessage":"String","TrackingUrl":"String","DeliveryDate":"\/Date(-62135596800000-0000)\/","ShippedDate":"\/Date(-62135596800000-0000)\/","RejectFlag":0,"RejectStatus":"String","RejectReasonExplanation":"String","SenderCustId":"String","SenderCustName":"String","SenderAddressTxt":"String","ReceiverCustId":"String","ReceiverCustName":"String","ReceiverAddressTxt":"String","ArrivalUnitId":"String","ArrivalUnitName":"String","DepartureUnitId":"String","DepartureUnitName":"String","DeliveryUnitId":"String","DeliveryUnitName":"String","CargoMovements":[{"UnitId":"String","UnitName":"String","EventId":"String","EventName":"String","ReasonId":"String","ReasonName":"String","EventDate":"\/Date(-62135596800000-0000)\/","CityName":"String","TownName":"String"}],"ReceiverInfo":"String","TotalPrice":0,"TotalVat":0,"TotalAmount":0,"CargoProduct":"String","TotalDesi":0,"TotalKg":0,"TotalDesiKg":0,"TotalCargo":0,"ReturnTotalPrice":0,"ReturnTotalVat":0,"ReturnTotalAmount":0,"BarcodeStringValue":"String","DeliveryProblemFlg":false},"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}