POST api/Courier

Request Information

URI Parameters

None.

Body Parameters

CourierLookupParm
NameDescriptionTypeAdditional information
auth

string

None.
Name

string

None.
OfficeID

integer

None.
CourierType

string

None.
CourierKey

string

None.
Status

string

None.
AirportID

string

None.
CountryID

string

None.
StateProvID

string

None.
CityName

string

None.
PostalCode

string

None.
ShowDeleted

boolean

None.
IsTSAApproved

boolean

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": true
}

application/xml, text/xml

Sample: 
<CourierLookupParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.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>true</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>
</CourierLookupParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CourierLookupResp
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.
ErrorMessage

string

None.
Couriers

Collection of CourierItem

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "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",
      "Address1": "sample string 9",
      "Address2": "sample string 10",
      "Address3": "sample string 11",
      "CityName": "sample string 12",
      "StateProvID": "sample string 13",
      "PostalCode": "sample string 14",
      "CountryID": "sample string 15",
      "PhoneNumber": "sample string 16",
      "AfterHoursNumber": "sample string 17",
      "FaxNumber": "sample string 18",
      "EmailAddress": "sample string 19",
      "EDISpecification": "sample string 20",
      "AltPhoneNumber": "sample string 21",
      "AltAfterHoursNumber": "sample string 22",
      "AltFaxNumber": "sample string 23",
      "AltEmailAddress": "sample string 24",
      "AltEDISpecification": "sample string 25",
      "PrefCommunication": "sample string 26",
      "PrefAvailablity": "sample string 27",
      "QualityScore": 28,
      "CurrencyID": "sample string 29",
      "VendorID": 1,
      "VendorName": "sample string 30",
      "VendorExternalVendorNum": "sample string 31",
      "IsGlobal": true,
      "IsTSAApproved": true,
      "DeletedUserID": 1,
      "DeletedDateTime": "2025-12-03T12:34:54.7514031+00:00",
      "InsertUserID": 34,
      "InsertDateTime": "2025-12-03T12:34:54.7514031+00:00",
      "Intercompany": true,
      "SendData_Enabled": true,
      "SendData_Method": "sample string 38",
      "SendData_Server": "sample string 39",
      "SendData_UserID": "sample string 40",
      "SendData_Password": "sample string 41",
      "SendData_FileNameFormat": "sample string 42",
      "SendData_FtpDirectory": "sample string 43",
      "SendData_FtpUsePassive": true,
      "SendData_FtpUseBinary": true,
      "SendData_FtpKeepAlive": true,
      "SendData_Format": "sample string 47",
      "SendData_ExportMasterID": 1,
      "WarehouseGUID": "sample string 48",
      "RestrictPcsWtUpdate": true,
      "STANumber": "sample string 50",
      "IntegrationPartnerGUID": "sample string 51",
      "IntegrationCompanyGUID": "sample string 52",
      "IntegrationCompanyName": "sample string 53",
      "MawbIdentifier": "sample string 54",
      "MawbContactName": "sample string 55"
    },
    {
      "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",
      "Address1": "sample string 9",
      "Address2": "sample string 10",
      "Address3": "sample string 11",
      "CityName": "sample string 12",
      "StateProvID": "sample string 13",
      "PostalCode": "sample string 14",
      "CountryID": "sample string 15",
      "PhoneNumber": "sample string 16",
      "AfterHoursNumber": "sample string 17",
      "FaxNumber": "sample string 18",
      "EmailAddress": "sample string 19",
      "EDISpecification": "sample string 20",
      "AltPhoneNumber": "sample string 21",
      "AltAfterHoursNumber": "sample string 22",
      "AltFaxNumber": "sample string 23",
      "AltEmailAddress": "sample string 24",
      "AltEDISpecification": "sample string 25",
      "PrefCommunication": "sample string 26",
      "PrefAvailablity": "sample string 27",
      "QualityScore": 28,
      "CurrencyID": "sample string 29",
      "VendorID": 1,
      "VendorName": "sample string 30",
      "VendorExternalVendorNum": "sample string 31",
      "IsGlobal": true,
      "IsTSAApproved": true,
      "DeletedUserID": 1,
      "DeletedDateTime": "2025-12-03T12:34:54.7514031+00:00",
      "InsertUserID": 34,
      "InsertDateTime": "2025-12-03T12:34:54.7514031+00:00",
      "Intercompany": true,
      "SendData_Enabled": true,
      "SendData_Method": "sample string 38",
      "SendData_Server": "sample string 39",
      "SendData_UserID": "sample string 40",
      "SendData_Password": "sample string 41",
      "SendData_FileNameFormat": "sample string 42",
      "SendData_FtpDirectory": "sample string 43",
      "SendData_FtpUsePassive": true,
      "SendData_FtpUseBinary": true,
      "SendData_FtpKeepAlive": true,
      "SendData_Format": "sample string 47",
      "SendData_ExportMasterID": 1,
      "WarehouseGUID": "sample string 48",
      "RestrictPcsWtUpdate": true,
      "STANumber": "sample string 50",
      "IntegrationPartnerGUID": "sample string 51",
      "IntegrationCompanyGUID": "sample string 52",
      "IntegrationCompanyName": "sample string 53",
      "MawbIdentifier": "sample string 54",
      "MawbContactName": "sample string 55"
    }
  ]
}

application/xml, text/xml

Sample: 
<CourierLookupResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <Couriers>
    <CourierItem>
      <Address1>sample string 9</Address1>
      <Address2>sample string 10</Address2>
      <Address3>sample string 11</Address3>
      <AfterHoursNumber>sample string 17</AfterHoursNumber>
      <AltAfterHoursNumber>sample string 22</AltAfterHoursNumber>
      <AltEDISpecification>sample string 25</AltEDISpecification>
      <AltEmailAddress>sample string 24</AltEmailAddress>
      <AltFaxNumber>sample string 23</AltFaxNumber>
      <AltPhoneNumber>sample string 21</AltPhoneNumber>
      <CityName>sample string 12</CityName>
      <CompanyID>3</CompanyID>
      <CountryID>sample string 15</CountryID>
      <CourierGUID>sample string 2</CourierGUID>
      <CourierID>1</CourierID>
      <CourierKey>sample string 5</CourierKey>
      <CourierType>sample string 4</CourierType>
      <CurrencyID>sample string 29</CurrencyID>
      <DeletedDateTime>2025-12-03T12:34:54.7514031+00:00</DeletedDateTime>
      <DeletedUserID>1</DeletedUserID>
      <EDISpecification>sample string 20</EDISpecification>
      <EmailAddress>sample string 19</EmailAddress>
      <FaxNumber>sample string 18</FaxNumber>
      <InsertDateTime>2025-12-03T12:34:54.7514031+00:00</InsertDateTime>
      <InsertUserID>34</InsertUserID>
      <IntegrationCompanyGUID>sample string 52</IntegrationCompanyGUID>
      <IntegrationCompanyName>sample string 53</IntegrationCompanyName>
      <IntegrationPartnerGUID>sample string 51</IntegrationPartnerGUID>
      <Intercompany>true</Intercompany>
      <IsGlobal>true</IsGlobal>
      <IsTSAApproved>true</IsTSAApproved>
      <MawbContactName>sample string 55</MawbContactName>
      <MawbIdentifier>sample string 54</MawbIdentifier>
      <Name>sample string 8</Name>
      <OfficeID>1</OfficeID>
      <PhoneNumber>sample string 16</PhoneNumber>
      <PostalCode>sample string 14</PostalCode>
      <PrefAvailablity>sample string 27</PrefAvailablity>
      <PrefCommunication>sample string 26</PrefCommunication>
      <QualityScore>28</QualityScore>
      <RestrictPcsWtUpdate>true</RestrictPcsWtUpdate>
      <STANumber>sample string 50</STANumber>
      <SendData_Enabled>true</SendData_Enabled>
      <SendData_ExportMasterID>1</SendData_ExportMasterID>
      <SendData_FileNameFormat>sample string 42</SendData_FileNameFormat>
      <SendData_Format>sample string 47</SendData_Format>
      <SendData_FtpDirectory>sample string 43</SendData_FtpDirectory>
      <SendData_FtpKeepAlive>true</SendData_FtpKeepAlive>
      <SendData_FtpUseBinary>true</SendData_FtpUseBinary>
      <SendData_FtpUsePassive>true</SendData_FtpUsePassive>
      <SendData_Method>sample string 38</SendData_Method>
      <SendData_Password>sample string 41</SendData_Password>
      <SendData_Server>sample string 39</SendData_Server>
      <SendData_UserID>sample string 40</SendData_UserID>
      <StateProvID>sample string 13</StateProvID>
      <Status>sample string 6</Status>
      <StatusIcon>sample string 7</StatusIcon>
      <VendorExternalVendorNum>sample string 31</VendorExternalVendorNum>
      <VendorID>1</VendorID>
      <VendorName>sample string 30</VendorName>
      <WarehouseGUID>sample string 48</WarehouseGUID>
    </CourierItem>
    <CourierItem>
      <Address1>sample string 9</Address1>
      <Address2>sample string 10</Address2>
      <Address3>sample string 11</Address3>
      <AfterHoursNumber>sample string 17</AfterHoursNumber>
      <AltAfterHoursNumber>sample string 22</AltAfterHoursNumber>
      <AltEDISpecification>sample string 25</AltEDISpecification>
      <AltEmailAddress>sample string 24</AltEmailAddress>
      <AltFaxNumber>sample string 23</AltFaxNumber>
      <AltPhoneNumber>sample string 21</AltPhoneNumber>
      <CityName>sample string 12</CityName>
      <CompanyID>3</CompanyID>
      <CountryID>sample string 15</CountryID>
      <CourierGUID>sample string 2</CourierGUID>
      <CourierID>1</CourierID>
      <CourierKey>sample string 5</CourierKey>
      <CourierType>sample string 4</CourierType>
      <CurrencyID>sample string 29</CurrencyID>
      <DeletedDateTime>2025-12-03T12:34:54.7514031+00:00</DeletedDateTime>
      <DeletedUserID>1</DeletedUserID>
      <EDISpecification>sample string 20</EDISpecification>
      <EmailAddress>sample string 19</EmailAddress>
      <FaxNumber>sample string 18</FaxNumber>
      <InsertDateTime>2025-12-03T12:34:54.7514031+00:00</InsertDateTime>
      <InsertUserID>34</InsertUserID>
      <IntegrationCompanyGUID>sample string 52</IntegrationCompanyGUID>
      <IntegrationCompanyName>sample string 53</IntegrationCompanyName>
      <IntegrationPartnerGUID>sample string 51</IntegrationPartnerGUID>
      <Intercompany>true</Intercompany>
      <IsGlobal>true</IsGlobal>
      <IsTSAApproved>true</IsTSAApproved>
      <MawbContactName>sample string 55</MawbContactName>
      <MawbIdentifier>sample string 54</MawbIdentifier>
      <Name>sample string 8</Name>
      <OfficeID>1</OfficeID>
      <PhoneNumber>sample string 16</PhoneNumber>
      <PostalCode>sample string 14</PostalCode>
      <PrefAvailablity>sample string 27</PrefAvailablity>
      <PrefCommunication>sample string 26</PrefCommunication>
      <QualityScore>28</QualityScore>
      <RestrictPcsWtUpdate>true</RestrictPcsWtUpdate>
      <STANumber>sample string 50</STANumber>
      <SendData_Enabled>true</SendData_Enabled>
      <SendData_ExportMasterID>1</SendData_ExportMasterID>
      <SendData_FileNameFormat>sample string 42</SendData_FileNameFormat>
      <SendData_Format>sample string 47</SendData_Format>
      <SendData_FtpDirectory>sample string 43</SendData_FtpDirectory>
      <SendData_FtpKeepAlive>true</SendData_FtpKeepAlive>
      <SendData_FtpUseBinary>true</SendData_FtpUseBinary>
      <SendData_FtpUsePassive>true</SendData_FtpUsePassive>
      <SendData_Method>sample string 38</SendData_Method>
      <SendData_Password>sample string 41</SendData_Password>
      <SendData_Server>sample string 39</SendData_Server>
      <SendData_UserID>sample string 40</SendData_UserID>
      <StateProvID>sample string 13</StateProvID>
      <Status>sample string 6</Status>
      <StatusIcon>sample string 7</StatusIcon>
      <VendorExternalVendorNum>sample string 31</VendorExternalVendorNum>
      <VendorID>1</VendorID>
      <VendorName>sample string 30</VendorName>
      <WarehouseGUID>sample string 48</WarehouseGUID>
    </CourierItem>
  </Couriers>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</CourierLookupResp>