POST api/Address/Create

Create a new address

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
auth		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	Pickup ready time (HH:mm)	string	None.
DeliveryRequestDay		integer	None.
DeliveryRequestTime	Delivery requested time (HH:mm)	string	None.
ServiceID		integer	None.
HoldForPickup		boolean	None.
DropOff		boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "Address3": "sample string 6",
  "AddressCode": "sample string 2",
  "AirportID": "sample string 33",
  "Attention": "sample string 12",
  "CityName": "sample string 7",
  "CompanyName": "sample string 3",
  "CountryID": "sample string 10",
  "DeliveryInstructions": "sample string 17",
  "DeliveryRequestDay": 1,
  "DeliveryRequestTime": "sample string 35",
  "DropOff": true,
  "EmailAddress": "sample string 14",
  "GroupAvailable": true,
  "HoldForPickup": true,
  "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 13",
  "PickupInstructions": "sample string 16",
  "PickupReadyDay": 1,
  "PickupReadyTime": "sample string 34",
  "PostalCode": "sample string 9",
  "Reference": "sample string 15",
  "ServiceID": 1,
  "StateProvID": "sample string 8",
  "TimezoneID": "sample string 11",
  "auth": "sample string 1"
}

application/xml, text/xml

Sample:

<AddressCreateParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <Address1>sample string 4</Address1>
  <Address2>sample string 5</Address2>
  <Address3>sample string 6</Address3>
  <AddressCode>sample string 2</AddressCode>
  <AirportID>sample string 33</AirportID>
  <Attention>sample string 12</Attention>
  <CityName>sample string 7</CityName>
  <CompanyName>sample string 3</CompanyName>
  <CountryID>sample string 10</CountryID>
  <DeliveryInstructions>sample string 17</DeliveryInstructions>
  <DeliveryRequestDay>1</DeliveryRequestDay>
  <DeliveryRequestTime>sample string 35</DeliveryRequestTime>
  <DropOff>true</DropOff>
  <EmailAddress>sample string 14</EmailAddress>
  <GroupAvailable>true</GroupAvailable>
  <HoldForPickup>true</HoldForPickup>
  <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 13</PhoneNumber>
  <PickupInstructions>sample string 16</PickupInstructions>
  <PickupReadyDay>1</PickupReadyDay>
  <PickupReadyTime>sample string 34</PickupReadyTime>
  <PostalCode>sample string 9</PostalCode>
  <Reference>sample string 15</Reference>
  <ServiceID>1</ServiceID>
  <StateProvID>sample string 8</StateProvID>
  <TimezoneID>sample string 11</TimezoneID>
  <auth>sample string 1</auth>
</AddressCreateParm>

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	None.
ErrorMessage	The error message if method call was not successful	string	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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