POST api/Courier

Use to search for couriers

Request Information

URI Parameters

None.

Body Parameters

Search parameters

Name	Description	Type	Additional information
auth	Unique authorization identifier	string	None.
Name	Name of the courier (use of wildcard % is permitted)	string	None.
OfficeID	Office of the courier	integer	None.
CourierType	Courier type ('A'=agent, 'E'=employee, 'C'=contactor, 'F'=freight cartage agent, 'O'=onboard courier)	string	None.
CourierKey	Courier user select identifier	string	None.
Status	Status (PD=pending, AC=active, IA=temporary off service, DL=deleted	string	None.
AirportID	Airport identifer that courier services	string	None.
CountryID	Country that courier services (2 character)	string	None.
StateProvID	State/provence/region of courier	string	None.
CityName	City name of courier	string	None.
PostalCode	Postal code of courier	string	None.
ShowDeleted	When searching show couriers that have been deleted (default to false)	boolean	None.
IsTSAApproved	Search only for courier that is TSA approved	string	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "Name": "sample string 2",
  "OfficeID": 1,
  "CourierType": "sample string 3",
  "CourierKey": "sample string 4",
  "Status": "sample string 5",
  "AirportID": "sample string 6",
  "CountryID": "sample string 7",
  "StateProvID": "sample string 8",
  "CityName": "sample string 9",
  "PostalCode": "sample string 10",
  "ShowDeleted": true,
  "IsTSAApproved": "sample string 12"
}

application/xml, text/xml

Sample:

<CourierSearchParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <AirportID>sample string 6</AirportID>
  <CityName>sample string 9</CityName>
  <CountryID>sample string 7</CountryID>
  <CourierKey>sample string 4</CourierKey>
  <CourierType>sample string 3</CourierType>
  <IsTSAApproved>sample string 12</IsTSAApproved>
  <Name>sample string 2</Name>
  <OfficeID>1</OfficeID>
  <PostalCode>sample string 10</PostalCode>
  <ShowDeleted>true</ShowDeleted>
  <StateProvID>sample string 8</StateProvID>
  <Status>sample string 5</Status>
  <auth>sample string 1</auth>
</CourierSearchParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of courier based on search critiera

CourierSearchResp

Name	Description	Type	Additional information
Couriers		Collection of CourierItem	None.
IsSuccessful	Set to true if method was successful	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Couriers": [
    {
      "CourierID": 1,
      "CourierGUID": "sample string 2",
      "CompanyID": 3,
      "OfficeID": 1,
      "CourierType": "sample string 4",
      "CourierKey": "sample string 5",
      "Status": "sample string 6",
      "StatusIcon": "sample string 7",
      "Name": "sample string 8",
      "NameAndPhoneNumber": "sample string 9",
      "Address1": "sample string 10",
      "Address2": "sample string 11",
      "Address3": "sample string 12",
      "CityName": "sample string 13",
      "StateProvID": "sample string 14",
      "PostalCode": "sample string 15",
      "CountryID": "sample string 16",
      "PhoneNumber": "sample string 17",
      "AfterHoursNumber": "sample string 18",
      "FaxNumber": "sample string 19",
      "EmailAddress": "sample string 20",
      "EmailAddressUrl": "sample string 21",
      "EDISpecification": "sample string 22",
      "AltPhoneNumber": "sample string 23",
      "AltAfterHoursNumber": "sample string 24",
      "AltFaxNumber": "sample string 25",
      "AltEmailAddress": "sample string 26",
      "AltEDISpecification": "sample string 27",
      "PrefCommunication": "sample string 28",
      "PrefCommunicationValue": "sample string 29",
      "PrefAvailablity": "sample string 30",
      "QualityScore": 31,
      "CurrencyID": "sample string 32",
      "VendorID": 1,
      "VendorName": "sample string 33",
      "VendorExternalVendorNum": "sample string 34",
      "IsGlobal": true,
      "IsTSAApproved": true,
      "LegacyCourierID": "sample string 37",
      "LegacyVendorID": "sample string 38",
      "DeletedUserID": 1,
      "DeletedDateTime": "2024-09-24T05:32:21.1459821-07:00",
      "InsertUserID": 39,
      "InsertDateTime": "2024-09-24T05:32:21.1459821-07:00",
      "DefaultCourierServiceID": 1,
      "DefaultCourierServiceName": "sample string 41",
      "Intercompany": true,
      "SendData_Enabled": true,
      "SendData_Method": "sample string 44",
      "SendData_Server": "sample string 45",
      "SendData_UserID": "sample string 46",
      "SendData_Password": "sample string 47",
      "SendData_FileNameFormat": "sample string 48",
      "SendData_FtpDirectory": "sample string 49",
      "SendData_FtpUsePassive": true,
      "SendData_FtpUseBinary": true,
      "SendData_FtpKeepAlive": true,
      "SendData_Format": "sample string 53",
      "SendData_ExportMasterID": 1,
      "WarehouseGUID": "sample string 54",
      "STANumber": "sample string 55",
      "FirstName": "sample string 56",
      "MiddleName": "sample string 57",
      "LastName": "sample string 58",
      "DateOfBirth": "2024-09-24T05:32:21.1459821-07:00",
      "IdExpireDate": "2024-09-24T05:32:21.1459821-07:00",
      "IdBackgroundColor": "sample string 59",
      "IntegrationPartnerGUID": "sample string 60"
    },
    {
      "CourierID": 1,
      "CourierGUID": "sample string 2",
      "CompanyID": 3,
      "OfficeID": 1,
      "CourierType": "sample string 4",
      "CourierKey": "sample string 5",
      "Status": "sample string 6",
      "StatusIcon": "sample string 7",
      "Name": "sample string 8",
      "NameAndPhoneNumber": "sample string 9",
      "Address1": "sample string 10",
      "Address2": "sample string 11",
      "Address3": "sample string 12",
      "CityName": "sample string 13",
      "StateProvID": "sample string 14",
      "PostalCode": "sample string 15",
      "CountryID": "sample string 16",
      "PhoneNumber": "sample string 17",
      "AfterHoursNumber": "sample string 18",
      "FaxNumber": "sample string 19",
      "EmailAddress": "sample string 20",
      "EmailAddressUrl": "sample string 21",
      "EDISpecification": "sample string 22",
      "AltPhoneNumber": "sample string 23",
      "AltAfterHoursNumber": "sample string 24",
      "AltFaxNumber": "sample string 25",
      "AltEmailAddress": "sample string 26",
      "AltEDISpecification": "sample string 27",
      "PrefCommunication": "sample string 28",
      "PrefCommunicationValue": "sample string 29",
      "PrefAvailablity": "sample string 30",
      "QualityScore": 31,
      "CurrencyID": "sample string 32",
      "VendorID": 1,
      "VendorName": "sample string 33",
      "VendorExternalVendorNum": "sample string 34",
      "IsGlobal": true,
      "IsTSAApproved": true,
      "LegacyCourierID": "sample string 37",
      "LegacyVendorID": "sample string 38",
      "DeletedUserID": 1,
      "DeletedDateTime": "2024-09-24T05:32:21.1459821-07:00",
      "InsertUserID": 39,
      "InsertDateTime": "2024-09-24T05:32:21.1459821-07:00",
      "DefaultCourierServiceID": 1,
      "DefaultCourierServiceName": "sample string 41",
      "Intercompany": true,
      "SendData_Enabled": true,
      "SendData_Method": "sample string 44",
      "SendData_Server": "sample string 45",
      "SendData_UserID": "sample string 46",
      "SendData_Password": "sample string 47",
      "SendData_FileNameFormat": "sample string 48",
      "SendData_FtpDirectory": "sample string 49",
      "SendData_FtpUsePassive": true,
      "SendData_FtpUseBinary": true,
      "SendData_FtpKeepAlive": true,
      "SendData_Format": "sample string 53",
      "SendData_ExportMasterID": 1,
      "WarehouseGUID": "sample string 54",
      "STANumber": "sample string 55",
      "FirstName": "sample string 56",
      "MiddleName": "sample string 57",
      "LastName": "sample string 58",
      "DateOfBirth": "2024-09-24T05:32:21.1459821-07:00",
      "IdExpireDate": "2024-09-24T05:32:21.1459821-07:00",
      "IdBackgroundColor": "sample string 59",
      "IntegrationPartnerGUID": "sample string 60"
    }
  ],
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<CourierSearchResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Couriers>
    <CourierItem>
      <Address1>sample string 10</Address1>
      <Address2>sample string 11</Address2>
      <Address3>sample string 12</Address3>
      <AfterHoursNumber>sample string 18</AfterHoursNumber>
      <AltAfterHoursNumber>sample string 24</AltAfterHoursNumber>
      <AltEDISpecification>sample string 27</AltEDISpecification>
      <AltEmailAddress>sample string 26</AltEmailAddress>
      <AltFaxNumber>sample string 25</AltFaxNumber>
      <AltPhoneNumber>sample string 23</AltPhoneNumber>
      <CityName>sample string 13</CityName>
      <CompanyID>3</CompanyID>
      <CountryID>sample string 16</CountryID>
      <CourierGUID>sample string 2</CourierGUID>
      <CourierID>1</CourierID>
      <CourierKey>sample string 5</CourierKey>
      <CourierType>sample string 4</CourierType>
      <CurrencyID>sample string 32</CurrencyID>
      <DateOfBirth>2024-09-24T05:32:21.1459821-07:00</DateOfBirth>
      <DefaultCourierServiceID>1</DefaultCourierServiceID>
      <DefaultCourierServiceName>sample string 41</DefaultCourierServiceName>
      <DeletedDateTime>2024-09-24T05:32:21.1459821-07:00</DeletedDateTime>
      <DeletedUserID>1</DeletedUserID>
      <EDISpecification>sample string 22</EDISpecification>
      <EmailAddress>sample string 20</EmailAddress>
      <EmailAddressUrl>sample string 21</EmailAddressUrl>
      <FaxNumber>sample string 19</FaxNumber>
      <FirstName>sample string 56</FirstName>
      <IdBackgroundColor>sample string 59</IdBackgroundColor>
      <IdExpireDate>2024-09-24T05:32:21.1459821-07:00</IdExpireDate>
      <InsertDateTime>2024-09-24T05:32:21.1459821-07:00</InsertDateTime>
      <InsertUserID>39</InsertUserID>
      <IntegrationPartnerGUID>sample string 60</IntegrationPartnerGUID>
      <Intercompany>true</Intercompany>
      <IsGlobal>true</IsGlobal>
      <IsTSAApproved>true</IsTSAApproved>
      <LastName>sample string 58</LastName>
      <LegacyCourierID>sample string 37</LegacyCourierID>
      <LegacyVendorID>sample string 38</LegacyVendorID>
      <MiddleName>sample string 57</MiddleName>
      <Name>sample string 8</Name>
      <NameAndPhoneNumber>sample string 9</NameAndPhoneNumber>
      <OfficeID>1</OfficeID>
      <PhoneNumber>sample string 17</PhoneNumber>
      <PostalCode>sample string 15</PostalCode>
      <PrefAvailablity>sample string 30</PrefAvailablity>
      <PrefCommunication>sample string 28</PrefCommunication>
      <PrefCommunicationValue>sample string 29</PrefCommunicationValue>
      <QualityScore>31</QualityScore>
      <STANumber>sample string 55</STANumber>
      <SendData_Enabled>true</SendData_Enabled>
      <SendData_ExportMasterID>1</SendData_ExportMasterID>
      <SendData_FileNameFormat>sample string 48</SendData_FileNameFormat>
      <SendData_Format>sample string 53</SendData_Format>
      <SendData_FtpDirectory>sample string 49</SendData_FtpDirectory>
      <SendData_FtpKeepAlive>true</SendData_FtpKeepAlive>
      <SendData_FtpUseBinary>true</SendData_FtpUseBinary>
      <SendData_FtpUsePassive>true</SendData_FtpUsePassive>
      <SendData_Method>sample string 44</SendData_Method>
      <SendData_Password>sample string 47</SendData_Password>
      <SendData_Server>sample string 45</SendData_Server>
      <SendData_UserID>sample string 46</SendData_UserID>
      <StateProvID>sample string 14</StateProvID>
      <Status>sample string 6</Status>
      <StatusIcon>sample string 7</StatusIcon>
      <VendorExternalVendorNum>sample string 34</VendorExternalVendorNum>
      <VendorID>1</VendorID>
      <VendorName>sample string 33</VendorName>
      <WarehouseGUID>sample string 54</WarehouseGUID>
    </CourierItem>
    <CourierItem>
      <Address1>sample string 10</Address1>
      <Address2>sample string 11</Address2>
      <Address3>sample string 12</Address3>
      <AfterHoursNumber>sample string 18</AfterHoursNumber>
      <AltAfterHoursNumber>sample string 24</AltAfterHoursNumber>
      <AltEDISpecification>sample string 27</AltEDISpecification>
      <AltEmailAddress>sample string 26</AltEmailAddress>
      <AltFaxNumber>sample string 25</AltFaxNumber>
      <AltPhoneNumber>sample string 23</AltPhoneNumber>
      <CityName>sample string 13</CityName>
      <CompanyID>3</CompanyID>
      <CountryID>sample string 16</CountryID>
      <CourierGUID>sample string 2</CourierGUID>
      <CourierID>1</CourierID>
      <CourierKey>sample string 5</CourierKey>
      <CourierType>sample string 4</CourierType>
      <CurrencyID>sample string 32</CurrencyID>
      <DateOfBirth>2024-09-24T05:32:21.1459821-07:00</DateOfBirth>
      <DefaultCourierServiceID>1</DefaultCourierServiceID>
      <DefaultCourierServiceName>sample string 41</DefaultCourierServiceName>
      <DeletedDateTime>2024-09-24T05:32:21.1459821-07:00</DeletedDateTime>
      <DeletedUserID>1</DeletedUserID>
      <EDISpecification>sample string 22</EDISpecification>
      <EmailAddress>sample string 20</EmailAddress>
      <EmailAddressUrl>sample string 21</EmailAddressUrl>
      <FaxNumber>sample string 19</FaxNumber>
      <FirstName>sample string 56</FirstName>
      <IdBackgroundColor>sample string 59</IdBackgroundColor>
      <IdExpireDate>2024-09-24T05:32:21.1459821-07:00</IdExpireDate>
      <InsertDateTime>2024-09-24T05:32:21.1459821-07:00</InsertDateTime>
      <InsertUserID>39</InsertUserID>
      <IntegrationPartnerGUID>sample string 60</IntegrationPartnerGUID>
      <Intercompany>true</Intercompany>
      <IsGlobal>true</IsGlobal>
      <IsTSAApproved>true</IsTSAApproved>
      <LastName>sample string 58</LastName>
      <LegacyCourierID>sample string 37</LegacyCourierID>
      <LegacyVendorID>sample string 38</LegacyVendorID>
      <MiddleName>sample string 57</MiddleName>
      <Name>sample string 8</Name>
      <NameAndPhoneNumber>sample string 9</NameAndPhoneNumber>
      <OfficeID>1</OfficeID>
      <PhoneNumber>sample string 17</PhoneNumber>
      <PostalCode>sample string 15</PostalCode>
      <PrefAvailablity>sample string 30</PrefAvailablity>
      <PrefCommunication>sample string 28</PrefCommunication>
      <PrefCommunicationValue>sample string 29</PrefCommunicationValue>
      <QualityScore>31</QualityScore>
      <STANumber>sample string 55</STANumber>
      <SendData_Enabled>true</SendData_Enabled>
      <SendData_ExportMasterID>1</SendData_ExportMasterID>
      <SendData_FileNameFormat>sample string 48</SendData_FileNameFormat>
      <SendData_Format>sample string 53</SendData_Format>
      <SendData_FtpDirectory>sample string 49</SendData_FtpDirectory>
      <SendData_FtpKeepAlive>true</SendData_FtpKeepAlive>
      <SendData_FtpUseBinary>true</SendData_FtpUseBinary>
      <SendData_FtpUsePassive>true</SendData_FtpUsePassive>
      <SendData_Method>sample string 44</SendData_Method>
      <SendData_Password>sample string 47</SendData_Password>
      <SendData_Server>sample string 45</SendData_Server>
      <SendData_UserID>sample string 46</SendData_UserID>
      <StateProvID>sample string 14</StateProvID>
      <Status>sample string 6</Status>
      <StatusIcon>sample string 7</StatusIcon>
      <VendorExternalVendorNum>sample string 34</VendorExternalVendorNum>
      <VendorID>1</VendorID>
      <VendorName>sample string 33</VendorName>
      <WarehouseGUID>sample string 54</WarehouseGUID>
    </CourierItem>
  </Couriers>
</CourierSearchResp>