POST api/AgentShipmentOrder/Search

Query Shipment Order by grouped condition.

Request Information

URI Parameters

None.

Body Parameters

Query Conditions

Name	Description	Type	Additional information
OrderId	OrderID	string	None.
TransferOrderId	Transfer OrderID	string	None.
Reference	Customer Reference	string	None.
MemberId	AuE Member ID	integer	None.
SubMemberId	AuE Sub Member ID	integer	None.
ReceiverName	Receiver Name	string	None.
ReceiverPhone	Receiver Phone	string	None.
SenderPhone	Sender Phone	string	None.
Sent	Is the cargo sent to AuE?	boolean	None.
Printed	Is Order Label printed?	boolean	None.
Packed	Is the cargo packed?	boolean	None.
DateFrom	Date From	date	None.
DateTo	Date To	date	None.
SearchByScanTime	true: Search by the PDA scan pickup time. false: Search by shipment order create time.	boolean	None.
IsPaid	Is Order Paid	boolean	None.
SenderName	Sender Name	string	None.
TransportBatchId	Transport Batch ID;	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderId": "sample string 1",
  "TransferOrderId": "sample string 2",
  "Reference": "sample string 3",
  "MemberId": 4,
  "SubMemberId": 5,
  "ReceiverName": "sample string 6",
  "ReceiverPhone": "sample string 7",
  "SenderPhone": "sample string 8",
  "Sent": true,
  "Printed": true,
  "Packed": true,
  "DateFrom": "2025-04-26T17:30:12.2772279+10:00",
  "DateTo": "2025-04-26T17:30:12.2772279+10:00",
  "SearchByScanTime": true,
  "IsPaid": true,
  "SenderName": "sample string 12",
  "TransportBatchId": 13
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of Shipment Orders

Collection of 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:30:12.2928538+10:00",
    "Marks": "sample string 30",
    "Volume": 31.0,
    "Notes": "sample string 32",
    "UserNotes": "sample string 33",
    "OrderTime": "2025-04-26T17:30:12.2928538+10:00",
    "ShipmentStatus": "sample string 35",
    "IsPrinted": true,
    "PrintTime": "2025-04-26T17:30:12.2928538+10:00",
    "QueryAliasOrderId": [
      "sample string 1",
      "sample string 2"
    ],
    "BrandName": "sample string 38",
    "ReturnResult": {},
    "Reference": "sample string 40",
    "Message": "sample string 41"
  },
  {
    "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:30:12.2928538+10:00",
    "Marks": "sample string 30",
    "Volume": 31.0,
    "Notes": "sample string 32",
    "UserNotes": "sample string 33",
    "OrderTime": "2025-04-26T17:30:12.2928538+10:00",
    "ShipmentStatus": "sample string 35",
    "IsPrinted": true,
    "PrintTime": "2025-04-26T17:30:12.2928538+10:00",
    "QueryAliasOrderId": [
      "sample string 1",
      "sample string 2"
    ],
    "BrandName": "sample string 38",
    "ReturnResult": {},
    "Reference": "sample string 40",
    "Message": "sample string 41"
  }
]