POST api/Shipper/AddressUpdate

Update an existing address in users address book

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserGUID	string	None.
UserGroupGUID	string	None.
AddressGUID	string	None.
AddressCode	string	None.
CompanyName	string	None.
Address1	string	None.
Address2	string	None.
Address3	string	None.
CityName	string	None.
StateProvID	string	None.
PostalCode	string	None.
CountryID	string	None.
TimezoneID	string	None.
Attention	string	None.
PhoneNumber	string	None.
EmailAddress	string	None.
Reference	string	None.
PickupInstructions	string	None.
DeliveryInstructions	string	None.
GroupAvailable	boolean	None.
NotifyOrderAck	boolean	None.
NotifyOrderRouted	boolean	None.
NotifyDispatched	boolean	None.
NotifyPickedUp	boolean	None.
NotifyDepToAp	boolean	None.
NotifyObcCheckin	boolean	None.
NotifyDropped	boolean	None.
NotifyConfirmed	boolean	None.
NotifyDeparted	boolean	None.
NotifyArrived	boolean	None.
NotifyRecovered	boolean	None.
NotifyDelivered	boolean	None.
NotifyOrigQdt	boolean	None.
NotifyChangeQdt	boolean	None.
AirportID	string	None.
PickupReadyDay	integer	None.
PickupReadyTime	date	None.
DeliveryRequestDay	integer	None.
DeliveryRequestTime	date	None.
AirportID2	string	None.
AirportID3	string	None.
DistanceToAirport	integer	None.
DistanceToAirport2	integer	None.
DistanceToAirport3	integer	None.
DistanceUOM	string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "UserGroupGUID": "sample string 2",
  "AddressGUID": "sample string 3",
  "AddressCode": "sample string 4",
  "CompanyName": "sample string 5",
  "Address1": "sample string 6",
  "Address2": "sample string 7",
  "Address3": "sample string 8",
  "CityName": "sample string 9",
  "StateProvID": "sample string 10",
  "PostalCode": "sample string 11",
  "CountryID": "sample string 12",
  "TimezoneID": "sample string 13",
  "Attention": "sample string 14",
  "PhoneNumber": "sample string 15",
  "EmailAddress": "sample string 16",
  "Reference": "sample string 17",
  "PickupInstructions": "sample string 18",
  "DeliveryInstructions": "sample string 19",
  "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 35",
  "PickupReadyDay": 1,
  "PickupReadyTime": "2024-09-19T09:12:05.7523443+00:00",
  "DeliveryRequestDay": 1,
  "DeliveryRequestTime": "2024-09-19T09:12:05.7523443+00:00",
  "AirportID2": "sample string 36",
  "AirportID3": "sample string 37",
  "DistanceToAirport": 1,
  "DistanceToAirport2": 1,
  "DistanceToAirport3": 1,
  "DistanceUOM": "sample string 38"
}

application/xml, text/xml

Sample:

<AddressUpdateParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models.Shipper">
  <Address1>sample string 6</Address1>
  <Address2>sample string 7</Address2>
  <Address3>sample string 8</Address3>
  <AddressCode>sample string 4</AddressCode>
  <AddressGUID>sample string 3</AddressGUID>
  <AirportID>sample string 35</AirportID>
  <AirportID2>sample string 36</AirportID2>
  <AirportID3>sample string 37</AirportID3>
  <Attention>sample string 14</Attention>
  <CityName>sample string 9</CityName>
  <CompanyName>sample string 5</CompanyName>
  <CountryID>sample string 12</CountryID>
  <DeliveryInstructions>sample string 19</DeliveryInstructions>
  <DeliveryRequestDay>1</DeliveryRequestDay>
  <DeliveryRequestTime>2024-09-19T09:12:05.7523443+00:00</DeliveryRequestTime>
  <DistanceToAirport>1</DistanceToAirport>
  <DistanceToAirport2>1</DistanceToAirport2>
  <DistanceToAirport3>1</DistanceToAirport3>
  <DistanceUOM>sample string 38</DistanceUOM>
  <EmailAddress>sample string 16</EmailAddress>
  <GroupAvailable>true</GroupAvailable>
  <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 15</PhoneNumber>
  <PickupInstructions>sample string 18</PickupInstructions>
  <PickupReadyDay>1</PickupReadyDay>
  <PickupReadyTime>2024-09-19T09:12:05.7523443+00:00</PickupReadyTime>
  <PostalCode>sample string 11</PostalCode>
  <Reference>sample string 17</Reference>
  <StateProvID>sample string 10</StateProvID>
  <TimezoneID>sample string 13</TimezoneID>
  <UserGUID>sample string 1</UserGUID>
  <UserGroupGUID>sample string 2</UserGroupGUID>
</AddressUpdateParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase

Name	Description	Type	Additional information
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	Required
ErrorMessage	The error message if method call was not successful	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>