POST api/Ksms

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
auth	string	None.
ShipperName	string	None.
Address1	string	None.
City	string	None.
State	string	None.
PostalCode	string	None.
TSAShipperID	string	None.
IACShipperID	string	None.
Status	string	None.
KsmsAddressID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "ShipperName": "sample string 2",
  "Address1": "sample string 3",
  "City": "sample string 4",
  "State": "sample string 5",
  "PostalCode": "sample string 6",
  "TSAShipperID": "sample string 7",
  "IACShipperID": "sample string 8",
  "Status": "sample string 9",
  "KsmsAddressID": 1
}

application/xml, text/xml

Sample:

<KsmsSearchParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <Address1>sample string 3</Address1>
  <City>sample string 4</City>
  <IACShipperID>sample string 8</IACShipperID>
  <KsmsAddressID>1</KsmsAddressID>
  <PostalCode>sample string 6</PostalCode>
  <ShipperName>sample string 2</ShipperName>
  <State>sample string 5</State>
  <Status>sample string 9</Status>
  <TSAShipperID>sample string 7</TSAShipperID>
  <auth>sample string 1</auth>
</KsmsSearchParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

KsmsSearchResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
Items	Collection of KsmsAddressItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Items": [
    {
      "KsmsAddressID": 1,
      "CompanyID": 2,
      "ShipperName": "sample string 3",
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "PostalCode": "sample string 8",
      "Country": "sample string 9",
      "Phone": "sample string 10",
      "LastTransactionDate": "2025-12-03T11:31:30.2145996+00:00",
      "E3NotificationFlag": true,
      "TSAShipperID": "sample string 12",
      "IACShipperID": "sample string 13",
      "Status": "sample string 14",
      "ReasonForStatus": "sample string 15",
      "InsertUserID": 16,
      "InsertUserName": "sample string 17",
      "InsertDateTime": "2025-12-03T11:31:30.2145996+00:00",
      "KSMS_Icon": "sample string 19",
      "OpsAddressCount": 20,
      "KSMSData_ShipperName": "sample string 21",
      "KSMSData_Address1": "sample string 22",
      "KSMSData_Address2": "sample string 23",
      "KSMSData_City": "sample string 24",
      "KSMSData_State": "sample string 25",
      "KSMSData_PostalCode": "sample string 26",
      "KSMSData_Country": "sample string 27",
      "KSMSData_Phone": "sample string 28",
      "KSMSData_LastTransactionDate": "sample string 29",
      "KSMSData_E3NotificationFlag": "sample string 30",
      "KSMSData_TSAShipperId": "sample string 31",
      "KSMSData_IACShipperId": "sample string 32"
    },
    {
      "KsmsAddressID": 1,
      "CompanyID": 2,
      "ShipperName": "sample string 3",
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "PostalCode": "sample string 8",
      "Country": "sample string 9",
      "Phone": "sample string 10",
      "LastTransactionDate": "2025-12-03T11:31:30.2145996+00:00",
      "E3NotificationFlag": true,
      "TSAShipperID": "sample string 12",
      "IACShipperID": "sample string 13",
      "Status": "sample string 14",
      "ReasonForStatus": "sample string 15",
      "InsertUserID": 16,
      "InsertUserName": "sample string 17",
      "InsertDateTime": "2025-12-03T11:31:30.2145996+00:00",
      "KSMS_Icon": "sample string 19",
      "OpsAddressCount": 20,
      "KSMSData_ShipperName": "sample string 21",
      "KSMSData_Address1": "sample string 22",
      "KSMSData_Address2": "sample string 23",
      "KSMSData_City": "sample string 24",
      "KSMSData_State": "sample string 25",
      "KSMSData_PostalCode": "sample string 26",
      "KSMSData_Country": "sample string 27",
      "KSMSData_Phone": "sample string 28",
      "KSMSData_LastTransactionDate": "sample string 29",
      "KSMSData_E3NotificationFlag": "sample string 30",
      "KSMSData_TSAShipperId": "sample string 31",
      "KSMSData_IACShipperId": "sample string 32"
    }
  ]
}

application/xml, text/xml

Sample:

<KsmsSearchResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Items>
    <KsmsAddressItem>
      <Address1>sample string 4</Address1>
      <Address2>sample string 5</Address2>
      <City>sample string 6</City>
      <CompanyID>2</CompanyID>
      <Country>sample string 9</Country>
      <E3NotificationFlag>true</E3NotificationFlag>
      <IACShipperID>sample string 13</IACShipperID>
      <InsertDateTime>2025-12-03T11:31:30.2145996+00:00</InsertDateTime>
      <InsertUserID>16</InsertUserID>
      <InsertUserName>sample string 17</InsertUserName>
      <KSMSData_Address1>sample string 22</KSMSData_Address1>
      <KSMSData_Address2>sample string 23</KSMSData_Address2>
      <KSMSData_City>sample string 24</KSMSData_City>
      <KSMSData_Country>sample string 27</KSMSData_Country>
      <KSMSData_E3NotificationFlag>sample string 30</KSMSData_E3NotificationFlag>
      <KSMSData_IACShipperId>sample string 32</KSMSData_IACShipperId>
      <KSMSData_LastTransactionDate>sample string 29</KSMSData_LastTransactionDate>
      <KSMSData_Phone>sample string 28</KSMSData_Phone>
      <KSMSData_PostalCode>sample string 26</KSMSData_PostalCode>
      <KSMSData_ShipperName>sample string 21</KSMSData_ShipperName>
      <KSMSData_State>sample string 25</KSMSData_State>
      <KSMSData_TSAShipperId>sample string 31</KSMSData_TSAShipperId>
      <KSMS_Icon>sample string 19</KSMS_Icon>
      <KsmsAddressID>1</KsmsAddressID>
      <LastTransactionDate>2025-12-03T11:31:30.2145996+00:00</LastTransactionDate>
      <OpsAddressCount>20</OpsAddressCount>
      <Phone>sample string 10</Phone>
      <PostalCode>sample string 8</PostalCode>
      <ReasonForStatus>sample string 15</ReasonForStatus>
      <ShipperName>sample string 3</ShipperName>
      <State>sample string 7</State>
      <Status>sample string 14</Status>
      <TSAShipperID>sample string 12</TSAShipperID>
    </KsmsAddressItem>
    <KsmsAddressItem>
      <Address1>sample string 4</Address1>
      <Address2>sample string 5</Address2>
      <City>sample string 6</City>
      <CompanyID>2</CompanyID>
      <Country>sample string 9</Country>
      <E3NotificationFlag>true</E3NotificationFlag>
      <IACShipperID>sample string 13</IACShipperID>
      <InsertDateTime>2025-12-03T11:31:30.2145996+00:00</InsertDateTime>
      <InsertUserID>16</InsertUserID>
      <InsertUserName>sample string 17</InsertUserName>
      <KSMSData_Address1>sample string 22</KSMSData_Address1>
      <KSMSData_Address2>sample string 23</KSMSData_Address2>
      <KSMSData_City>sample string 24</KSMSData_City>
      <KSMSData_Country>sample string 27</KSMSData_Country>
      <KSMSData_E3NotificationFlag>sample string 30</KSMSData_E3NotificationFlag>
      <KSMSData_IACShipperId>sample string 32</KSMSData_IACShipperId>
      <KSMSData_LastTransactionDate>sample string 29</KSMSData_LastTransactionDate>
      <KSMSData_Phone>sample string 28</KSMSData_Phone>
      <KSMSData_PostalCode>sample string 26</KSMSData_PostalCode>
      <KSMSData_ShipperName>sample string 21</KSMSData_ShipperName>
      <KSMSData_State>sample string 25</KSMSData_State>
      <KSMSData_TSAShipperId>sample string 31</KSMSData_TSAShipperId>
      <KSMS_Icon>sample string 19</KSMS_Icon>
      <KsmsAddressID>1</KsmsAddressID>
      <LastTransactionDate>2025-12-03T11:31:30.2145996+00:00</LastTransactionDate>
      <OpsAddressCount>20</OpsAddressCount>
      <Phone>sample string 10</Phone>
      <PostalCode>sample string 8</PostalCode>
      <ReasonForStatus>sample string 15</ReasonForStatus>
      <ShipperName>sample string 3</ShipperName>
      <State>sample string 7</State>
      <Status>sample string 14</Status>
      <TSAShipperID>sample string 12</TSAShipperID>
    </KsmsAddressItem>
  </Items>
</KsmsSearchResp>