Required role: | Approved |
All Verbs | /Trans/QueryShipmentForView/ |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TransReturnType | query | TransReturnTypes | No | |
CargoKey | query | string | No | |
ShippingMethodId | query | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
start | form | DateTime | No | |
DeviceUUID | form | string | No | |
APIKey | form | string | No | |
isAdmin | form | bool | No | |
Cmd | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
QueryShipment | form | QueryShipmentDTO | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Result | form | bool | No | |
ResMessage | form | string | No | |
Error | form | Error | No | |
PageInfo | form | BasePageInfo | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ErrorYn | form | bool | No | |
ExYn | form | bool | No | |
ErrorCode | form | string | No | |
ErrorDescription | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalRecordCount | form | int | No | |
TotalPageCount | form | int | No | |
CurrentPage | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TransReturnType | form | TransReturnTypes | No | |
DeliveryStatus | form | DeliveryStatusOnline | No | |
CargoTransactionStatus | form | long | No | |
CargoEventId | form | string | No | |
CargoReasonExplanation | form | string | No | |
CargoKey | form | string | No | |
CargoCompanyDocId | form | string | No | |
ErrCode | form | long | No | |
ErrMessage | form | string | No | |
TrackingUrl | form | string | No | |
DeliveryDate | form | DateTime? | No | |
ShippedDate | form | DateTime? | No | |
RejectFlag | form | int | No | |
RejectStatus | form | string | No | |
RejectReasonExplanation | form | string | No | |
SenderCustId | form | string | No | |
SenderCustName | form | string | No | |
SenderAddressTxt | form | string | No | |
ReceiverCustId | form | string | No | |
ReceiverCustName | form | string | No | |
ReceiverAddressTxt | form | string | No | |
ArrivalUnitId | form | string | No | |
ArrivalUnitName | form | string | No | |
DepartureUnitId | form | string | No | |
DepartureUnitName | form | string | No | |
DeliveryUnitId | form | string | No | |
DeliveryUnitName | form | string | No | |
CargoMovements | form | List<CargoMovementDTO> | No | |
ReceiverInfo | form | string | No | |
TotalPrice | form | decimal | No | |
TotalVat | form | decimal | No | |
TotalAmount | form | decimal | No | |
CargoProduct | form | string | No | |
TotalDesi | form | decimal | No | |
TotalKg | form | decimal | No | |
TotalDesiKg | form | decimal | No | |
TotalCargo | form | decimal | No | |
ReturnTotalPrice | form | decimal | No | |
ReturnTotalVat | form | decimal | No | |
ReturnTotalAmount | form | decimal | No | |
BarcodeStringValue | form | string | No | |
DeliveryProblemFlg | form | bool | No | |
CargoServiceName | form | string | No | |
CargoServiceVersion | form | string | No | |
ErrorForAdmin | form | string | No |
Name | Value |
---|---|
Transaction | 1 |
Return | 2 |
CustomerToAydem | 3 |
AydemToCustomer | 4 |
Name | Value |
---|---|
None | 0 |
New | 1 |
Shipped | 2 |
Delivered | 3 |
Rejected | 4 |
DeliveryProblem | 5 |
Error | 98 |
Cancel | 99 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
UnitId | form | string | No | |
UnitName | form | string | No | |
EventId | form | string | No | |
EventName | form | string | No | |
ReasonId | form | string | No | |
ReasonName | form | string | No | |
EventDate | form | DateTime? | No | |
CityName | form | string | No | |
TownName | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
QueryShipment | form | QueryShipmentDTO | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
TransReturnType: 1,
CargoKey: String,
ShippingMethodId: 0,
start: 0001-01-01,
DeviceUUID: String,
APIKey: String,
isAdmin: False,
Cmd: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { QueryShipment: { TransReturnType: 1, DeliveryStatus: 0, CargoTransactionStatus: 0, CargoEventId: String, CargoReasonExplanation: String, CargoKey: String, CargoCompanyDocId: String, ErrCode: 0, ErrMessage: String, TrackingUrl: String, DeliveryDate: 0001-01-01, ShippedDate: 0001-01-01, 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: [ { Id: 0, UnitId: String, UnitName: String, EventId: String, EventName: String, ReasonId: String, ReasonName: String, EventDate: 0001-01-01, 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, CargoServiceName: String, CargoServiceVersion: String, ErrorForAdmin: String }, Result: False, ResMessage: String, Error: { ErrorYn: False, ExYn: False, ErrorCode: String, ErrorDescription: String }, PageInfo: { TotalRecordCount: 0, TotalPageCount: 0, CurrentPage: 0 } }