POST api/{ext}/address/Create

Use this method to create an address

Request Information

URI Parameters

Name	Description	Type	Additional information
ext		string	None.

Body Parameters

AddressItem

Name	Type	Additional information
AddressGUID	string	None.
CompanyID	integer	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.
InsertUserGUID	string	None.
InsertDateTime	date	None.
UserGroupGUID	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.
PickupReady	date	None.
DeliveryRequest	date	None.
AirportID2	string	None.
AirportID3	string	None.
DistanceToAirport	integer	None.
DistanceToAirport2	integer	None.
DistanceToAirport3	integer	None.
DistanceUOM	string	None.
SingleLineDisplay	string	None.

Request Formats

application/json, text/json

Sample:

{
  "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": "2025-04-29T13:18:49.1144035+00: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": "2025-04-29T13:18:49.1144035+00:00",
  "DeliveryRequestDay": 1,
  "DeliveryRequestTime": "2025-04-29T13:18:49.1144035+00:00",
  "PickupReady": "2025-04-29T13:18:49.1144035+00:00",
  "DeliveryRequest": "2025-04-29T13:18:49.1144035+00:00",
  "AirportID2": "sample string 38",
  "AirportID3": "sample string 39",
  "DistanceToAirport": 1,
  "DistanceToAirport2": 1,
  "DistanceToAirport3": 1,
  "DistanceUOM": "sample string 40",
  "SingleLineDisplay": "sample string 41"
}

application/xml, text/xml

Sample:

<AddressItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Shipper1.Models">
  <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>
  <AirportID2>sample string 38</AirportID2>
  <AirportID3>sample string 39</AirportID3>
  <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>2025-04-29T13:18:49.1144035+00:00</DeliveryRequest>
  <DeliveryRequestDay>1</DeliveryRequestDay>
  <DeliveryRequestTime>2025-04-29T13:18:49.1144035+00:00</DeliveryRequestTime>
  <DistanceToAirport>1</DistanceToAirport>
  <DistanceToAirport2>1</DistanceToAirport2>
  <DistanceToAirport3>1</DistanceToAirport3>
  <DistanceUOM>sample string 40</DistanceUOM>
  <EmailAddress>sample string 15</EmailAddress>
  <GroupAvailable>true</GroupAvailable>
  <InsertDateTime>2025-04-29T13:18:49.1144035+00: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>2025-04-29T13:18:49.1144035+00:00</PickupReady>
  <PickupReadyDay>1</PickupReadyDay>
  <PickupReadyTime>2025-04-29T13:18:49.1144035+00:00</PickupReadyTime>
  <PostalCode>sample string 10</PostalCode>
  <Reference>sample string 16</Reference>
  <SingleLineDisplay>sample string 41</SingleLineDisplay>
  <StateProvID>sample string 9</StateProvID>
  <TimezoneID>sample string 12</TimezoneID>
  <UserGroupGUID>sample string 21</UserGroupGUID>
</AddressItem>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.