GET api/AgentShipmentOrder/{OrderId}

Query a Shipment Order by OrderID

Request Information

URI Parameters

Name	Description	Type	Additional information
OrderId		string	Required

Body Parameters

None.

Response Information

Resource Description

ShipmentOrderClientView

Name	Description	Type	Additional information
id		integer	None.
OrderId		string	None.
MemberId		integer	None.
SubMemberId		integer	None.
BrandID		integer	None.
SenderName		string	None.
SenderPhone		string	None.
SenderCountry		string	None.
SenderProvince		string	None.
SenderCity		string	None.
SenderAddr1		string	None.
SenderPostCode		string	None.
SenderEmail		string	None.
ReceiverName		string	None.
ReceiverPhone		string	None.
ReceiverCountry		string	None.
ReceiverProvince		string	None.
ReceiverCity		string	None.
ReceiverAddr1		string	None.
ReceiverPostCode		string	None.
ReceiverEmail		string	None.
ReceiverPhotoId		string	None.
ShipmentContent		string	None.
ShipmentCustomContent		string	None.
ChargeWeight		decimal number	None.
Value		decimal number	None.
InsuranceFee		decimal number	None.
IsPaid		boolean	None.
PayTime		date	None.
Marks		string	None.
Volume		decimal number	None.
Notes		string	None.
UserNotes		string	None.
OrderTime		date	None.
ShipmentStatus		string	None.
IsPrinted		boolean	None.
PrintTime		date	None.
QueryAliasOrderId		Collection of string	None.
BrandName		string	None.
ReturnResult	Return result in string	Object	None.
Reference		string	None.
Message	Additional message of return result	string	None.
Code	Return result code	APIReturnResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Code": 0,
  "id": 1,
  "OrderId": "sample string 2",
  "MemberId": 3,
  "SubMemberId": 4,
  "BrandID": 5,
  "SenderName": "sample string 6",
  "SenderPhone": "sample string 7",
  "SenderCountry": "sample string 8",
  "SenderProvince": "sample string 9",
  "SenderCity": "sample string 10",
  "SenderAddr1": "sample string 11",
  "SenderPostCode": "sample string 12",
  "SenderEmail": "sample string 13",
  "ReceiverName": "sample string 14",
  "ReceiverPhone": "sample string 15",
  "ReceiverCountry": "sample string 16",
  "ReceiverProvince": "sample string 17",
  "ReceiverCity": "sample string 18",
  "ReceiverAddr1": "sample string 19",
  "ReceiverPostCode": "sample string 20",
  "ReceiverEmail": "sample string 21",
  "ReceiverPhotoId": "sample string 22",
  "ShipmentContent": "sample string 23",
  "ShipmentCustomContent": "sample string 24",
  "ChargeWeight": 25.0,
  "Value": 26.0,
  "InsuranceFee": 27.0,
  "IsPaid": true,
  "PayTime": "2025-04-26T17:00:59.9568038+10:00",
  "Marks": "sample string 30",
  "Volume": 31.0,
  "Notes": "sample string 32",
  "UserNotes": "sample string 33",
  "OrderTime": "2025-04-26T17:00:59.9568038+10:00",
  "ShipmentStatus": "sample string 35",
  "IsPrinted": true,
  "PrintTime": "2025-04-26T17:00:59.9568038+10:00",
  "QueryAliasOrderId": [
    "sample string 1",
    "sample string 2"
  ],
  "BrandName": "sample string 38",
  "ReturnResult": {},
  "Reference": "sample string 40",
  "Message": "sample string 41"
}