POST api/Shipper/SearchAddresses

Use to search/retrieve the list of available addresses for this user

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
auth	string	None.
CompanyName	string	None.
CityName	string	None.
StateProvID	string	None.
AddressCode	string	None.
CountryID	string	None.
PostalCode	string	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "CompanyName": "sample string 2",
  "CityName": "sample string 3",
  "StateProvID": "sample string 4",
  "AddressCode": "sample string 5",
  "CountryID": "sample string 6",
  "PostalCode": "sample string 7"
}

application/xml, text/xml

Sample:

<SearchAddressesParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Shipper">
  <AddressCode>sample string 5</AddressCode>
  <CityName>sample string 3</CityName>
  <CompanyName>sample string 2</CompanyName>
  <CountryID>sample string 6</CountryID>
  <PostalCode>sample string 7</PostalCode>
  <StateProvID>sample string 4</StateProvID>
  <auth>sample string 1</auth>
</SearchAddressesParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchAddressesResp

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

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Addresses": [
    {
      "AddressGUID": "sample string 1",
      "CompanyID": 2,
      "AddressCode": "sample string 3",
      "CompanyName": "sample string 4",
      "Address1": "sample string 5",
      "Address2": "sample string 6",
      "Address3": "sample string 7",
      "CityName": "sample string 8",
      "StateProvID": "sample string 9",
      "PostalCode": "sample string 10",
      "CountryID": "sample string 11",
      "TimezoneID": "sample string 12",
      "Attention": "sample string 13",
      "PhoneNumber": "sample string 14",
      "EmailAddress": "sample string 15",
      "Reference": "sample string 16",
      "PickupInstructions": "sample string 17",
      "DeliveryInstructions": "sample string 18",
      "InsertUserGUID": "sample string 19",
      "InsertDateTime": "2024-09-21T16:56:45.4651957-07:00",
      "UserGroupGUID": "sample string 21",
      "GroupAvailable": true,
      "NotifyOrderAck": true,
      "NotifyOrderRouted": true,
      "NotifyDispatched": true,
      "NotifyPickedUp": true,
      "NotifyDepToAp": true,
      "NotifyObcCheckin": true,
      "NotifyDropped": true,
      "NotifyConfirmed": true,
      "NotifyDeparted": true,
      "NotifyArrived": true,
      "NotifyRecovered": true,
      "NotifyDelivered": true,
      "NotifyOrigQdt": true,
      "NotifyChangeQdt": true,
      "AirportID": "sample string 37",
      "PickupReadyDay": 1,
      "PickupReadyTime": "2024-09-21T16:56:45.4662043-07:00",
      "DeliveryRequestDay": 1,
      "DeliveryRequestTime": "2024-09-21T16:56:45.4662043-07:00",
      "PickupReady": "2024-09-22T16:56:00Z",
      "DeliveryRequest": "2024-09-22T16:56:00Z",
      "ServiceID": 1,
      "ServiceGUID": "sample string 38",
      "SingleLineDisplay": "sample string 4, sample string 5, sample string 8 sample string 9, sample string 10 sample string 11"
    },
    {
      "AddressGUID": "sample string 1",
      "CompanyID": 2,
      "AddressCode": "sample string 3",
      "CompanyName": "sample string 4",
      "Address1": "sample string 5",
      "Address2": "sample string 6",
      "Address3": "sample string 7",
      "CityName": "sample string 8",
      "StateProvID": "sample string 9",
      "PostalCode": "sample string 10",
      "CountryID": "sample string 11",
      "TimezoneID": "sample string 12",
      "Attention": "sample string 13",
      "PhoneNumber": "sample string 14",
      "EmailAddress": "sample string 15",
      "Reference": "sample string 16",
      "PickupInstructions": "sample string 17",
      "DeliveryInstructions": "sample string 18",
      "InsertUserGUID": "sample string 19",
      "InsertDateTime": "2024-09-21T16:56:45.4651957-07:00",
      "UserGroupGUID": "sample string 21",
      "GroupAvailable": true,
      "NotifyOrderAck": true,
      "NotifyOrderRouted": true,
      "NotifyDispatched": true,
      "NotifyPickedUp": true,
      "NotifyDepToAp": true,
      "NotifyObcCheckin": true,
      "NotifyDropped": true,
      "NotifyConfirmed": true,
      "NotifyDeparted": true,
      "NotifyArrived": true,
      "NotifyRecovered": true,
      "NotifyDelivered": true,
      "NotifyOrigQdt": true,
      "NotifyChangeQdt": true,
      "AirportID": "sample string 37",
      "PickupReadyDay": 1,
      "PickupReadyTime": "2024-09-21T16:56:45.4662043-07:00",
      "DeliveryRequestDay": 1,
      "DeliveryRequestTime": "2024-09-21T16:56:45.4662043-07:00",
      "PickupReady": "2024-09-22T16:56:00Z",
      "DeliveryRequest": "2024-09-22T16:56:00Z",
      "ServiceID": 1,
      "ServiceGUID": "sample string 38",
      "SingleLineDisplay": "sample string 4, sample string 5, sample string 8 sample string 9, sample string 10 sample string 11"
    }
  ]
}

application/xml, text/xml

Sample:

<SearchAddressesResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Shipper">
  <Addresses>
    <AddressItem>
      <Address1>sample string 5</Address1>
      <Address2>sample string 6</Address2>
      <Address3>sample string 7</Address3>
      <AddressCode>sample string 3</AddressCode>
      <AddressGUID>sample string 1</AddressGUID>
      <AirportID>sample string 37</AirportID>
      <Attention>sample string 13</Attention>
      <CityName>sample string 8</CityName>
      <CompanyID>2</CompanyID>
      <CompanyName>sample string 4</CompanyName>
      <CountryID>sample string 11</CountryID>
      <DeliveryInstructions>sample string 18</DeliveryInstructions>
      <DeliveryRequestDay>1</DeliveryRequestDay>
      <DeliveryRequestTime>2024-09-21T16:56:45.4662043-07:00</DeliveryRequestTime>
      <EmailAddress>sample string 15</EmailAddress>
      <GroupAvailable>true</GroupAvailable>
      <InsertDateTime>2024-09-21T16:56:45.4651957-07:00</InsertDateTime>
      <InsertUserGUID>sample string 19</InsertUserGUID>
      <NotifyArrived>true</NotifyArrived>
      <NotifyChangeQdt>true</NotifyChangeQdt>
      <NotifyConfirmed>true</NotifyConfirmed>
      <NotifyDelivered>true</NotifyDelivered>
      <NotifyDepToAp>true</NotifyDepToAp>
      <NotifyDeparted>true</NotifyDeparted>
      <NotifyDispatched>true</NotifyDispatched>
      <NotifyDropped>true</NotifyDropped>
      <NotifyObcCheckin>true</NotifyObcCheckin>
      <NotifyOrderAck>true</NotifyOrderAck>
      <NotifyOrderRouted>true</NotifyOrderRouted>
      <NotifyOrigQdt>true</NotifyOrigQdt>
      <NotifyPickedUp>true</NotifyPickedUp>
      <NotifyRecovered>true</NotifyRecovered>
      <PhoneNumber>sample string 14</PhoneNumber>
      <PickupInstructions>sample string 17</PickupInstructions>
      <PickupReadyDay>1</PickupReadyDay>
      <PickupReadyTime>2024-09-21T16:56:45.4662043-07:00</PickupReadyTime>
      <PostalCode>sample string 10</PostalCode>
      <Reference>sample string 16</Reference>
      <ServiceGUID>sample string 38</ServiceGUID>
      <ServiceID>1</ServiceID>
      <StateProvID>sample string 9</StateProvID>
      <TimezoneID>sample string 12</TimezoneID>
      <UserGroupGUID>sample string 21</UserGroupGUID>
    </AddressItem>
    <AddressItem>
      <Address1>sample string 5</Address1>
      <Address2>sample string 6</Address2>
      <Address3>sample string 7</Address3>
      <AddressCode>sample string 3</AddressCode>
      <AddressGUID>sample string 1</AddressGUID>
      <AirportID>sample string 37</AirportID>
      <Attention>sample string 13</Attention>
      <CityName>sample string 8</CityName>
      <CompanyID>2</CompanyID>
      <CompanyName>sample string 4</CompanyName>
      <CountryID>sample string 11</CountryID>
      <DeliveryInstructions>sample string 18</DeliveryInstructions>
      <DeliveryRequestDay>1</DeliveryRequestDay>
      <DeliveryRequestTime>2024-09-21T16:56:45.4662043-07:00</DeliveryRequestTime>
      <EmailAddress>sample string 15</EmailAddress>
      <GroupAvailable>true</GroupAvailable>
      <InsertDateTime>2024-09-21T16:56:45.4651957-07:00</InsertDateTime>
      <InsertUserGUID>sample string 19</InsertUserGUID>
      <NotifyArrived>true</NotifyArrived>
      <NotifyChangeQdt>true</NotifyChangeQdt>
      <NotifyConfirmed>true</NotifyConfirmed>
      <NotifyDelivered>true</NotifyDelivered>
      <NotifyDepToAp>true</NotifyDepToAp>
      <NotifyDeparted>true</NotifyDeparted>
      <NotifyDispatched>true</NotifyDispatched>
      <NotifyDropped>true</NotifyDropped>
      <NotifyObcCheckin>true</NotifyObcCheckin>
      <NotifyOrderAck>true</NotifyOrderAck>
      <NotifyOrderRouted>true</NotifyOrderRouted>
      <NotifyOrigQdt>true</NotifyOrigQdt>
      <NotifyPickedUp>true</NotifyPickedUp>
      <NotifyRecovered>true</NotifyRecovered>
      <PhoneNumber>sample string 14</PhoneNumber>
      <PickupInstructions>sample string 17</PickupInstructions>
      <PickupReadyDay>1</PickupReadyDay>
      <PickupReadyTime>2024-09-21T16:56:45.4662043-07:00</PickupReadyTime>
      <PostalCode>sample string 10</PostalCode>
      <Reference>sample string 16</Reference>
      <ServiceGUID>sample string 38</ServiceGUID>
      <ServiceID>1</ServiceID>
      <StateProvID>sample string 9</StateProvID>
      <TimezoneID>sample string 12</TimezoneID>
      <UserGroupGUID>sample string 21</UserGroupGUID>
    </AddressItem>
  </Addresses>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</SearchAddressesResp>