POST api/Shipper/UpdateAddress

Use this method to update an address

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
auth	Unique authorization identifier	string	None.
AddressGUID	The identifier of the address to update	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.
ServiceID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "AddressGUID": "sample string 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",
  "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 34",
  "PickupReadyDay": 1,
  "PickupReadyTime": "2024-09-21T19:32:24.8697078-07:00",
  "DeliveryRequestDay": 1,
  "DeliveryRequestTime": "2024-09-21T19:32:24.870708-07:00",
  "ServiceID": 1
}

application/xml, text/xml

Sample:

<UpdateAddressParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Shipper">
  <Address1>sample string 5</Address1>
  <Address2>sample string 6</Address2>
  <Address3>sample string 7</Address3>
  <AddressCode>sample string 3</AddressCode>
  <AddressGUID>sample string 2</AddressGUID>
  <AirportID>sample string 34</AirportID>
  <Attention>sample string 13</Attention>
  <CityName>sample string 8</CityName>
  <CompanyName>sample string 4</CompanyName>
  <CountryID>sample string 11</CountryID>
  <DeliveryInstructions>sample string 18</DeliveryInstructions>
  <DeliveryRequestDay>1</DeliveryRequestDay>
  <DeliveryRequestTime>2024-09-21T19:32:24.870708-07:00</DeliveryRequestTime>
  <EmailAddress>sample string 15</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 14</PhoneNumber>
  <PickupInstructions>sample string 17</PickupInstructions>
  <PickupReadyDay>1</PickupReadyDay>
  <PickupReadyTime>2024-09-21T19:32:24.8697078-07:00</PickupReadyTime>
  <PostalCode>sample string 10</PostalCode>
  <Reference>sample string 16</Reference>
  <ServiceID>1</ServiceID>
  <StateProvID>sample string 9</StateProvID>
  <TimezoneID>sample string 12</TimezoneID>
  <auth>sample string 1</auth>
</UpdateAddressParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase

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.

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/Mnx.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>