POST api/Address

Search the list of addresses

Request Information

URI Parameters

None.

Body Parameters

AddressParm
NameDescriptionTypeAdditional information
auth

Authorization token

 string

None.
CompanyName

Company name of address

 string

None.
CityName

City name of address

 string

None.
StateProvID

State abbreviation of address

 string

None.
AddressCode

Address code

 string

None.
CountryID

Country code (ie. US, GB, AU, etc)

 string

None.
PostalCode

Postal code of address

 string

None.
ReturnAllIfNoParms

true = If all parameters are blank, return all records, false=return no records if all parameters are blank

 boolean

None.
IncludeBlank

Include a "blank" address item, AddressGUID will be empty

 boolean

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddressResp
NameDescriptionTypeAdditional information
IsSuccessful

Used to determine if method call was successful (true) or failure (false)

 boolean

None.
ErrorMessage

The error message if method call was not successful

 string

None.
Addresses

List of address

 Collection of AddressItem

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample: 
<AddressResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <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>
      <DeliveryRequest>2024-09-19T00:53:43.417012-07:00</DeliveryRequest>
      <DeliveryRequestDay>1</DeliveryRequestDay>
      <DeliveryRequestTime>2024-09-19T00:53:43.417012-07:00</DeliveryRequestTime>
      <DropOff>true</DropOff>
      <EmailAddress>sample string 15</EmailAddress>
      <GroupAvailable>true</GroupAvailable>
      <HoldForPickup>true</HoldForPickup>
      <InsertDateTime>2024-09-19T00:53:43.417012-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>
      <PickupReady>2024-09-19T00:53:43.417012-07:00</PickupReady>
      <PickupReadyDay>1</PickupReadyDay>
      <PickupReadyTime>2024-09-19T00:53:43.417012-07:00</PickupReadyTime>
      <PostalCode>sample string 10</PostalCode>
      <Reference>sample string 16</Reference>
      <ServiceGUID>sample string 38</ServiceGUID>
      <ServiceID>1</ServiceID>
      <SingleLineDisplay>sample string 39</SingleLineDisplay>
      <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>
      <DeliveryRequest>2024-09-19T00:53:43.417012-07:00</DeliveryRequest>
      <DeliveryRequestDay>1</DeliveryRequestDay>
      <DeliveryRequestTime>2024-09-19T00:53:43.417012-07:00</DeliveryRequestTime>
      <DropOff>true</DropOff>
      <EmailAddress>sample string 15</EmailAddress>
      <GroupAvailable>true</GroupAvailable>
      <HoldForPickup>true</HoldForPickup>
      <InsertDateTime>2024-09-19T00:53:43.417012-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>
      <PickupReady>2024-09-19T00:53:43.417012-07:00</PickupReady>
      <PickupReadyDay>1</PickupReadyDay>
      <PickupReadyTime>2024-09-19T00:53:43.417012-07:00</PickupReadyTime>
      <PostalCode>sample string 10</PostalCode>
      <Reference>sample string 16</Reference>
      <ServiceGUID>sample string 38</ServiceGUID>
      <ServiceID>1</ServiceID>
      <SingleLineDisplay>sample string 39</SingleLineDisplay>
      <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>
</AddressResp>