POST api/Shipper/AddAddress

Use this method to add an address to the users address book

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
auth	Unique authorization identifier	string	None.
AddressCode		string	Max length: 15
CompanyName		string	Required Max length: 50
Address1		string	Max length: 50
Address2		string	Max length: 50
Address3		string	Max length: 50
CityName		string	Required Max length: 50
StateProvID		string	Max length: 3
PostalCode		string	Max length: 10
CountryID		string	Required Max length: 2
TimezoneID		string	Max length: 10
Attention		string	Max length: 50
PhoneNumber		string	Max length: 25
EmailAddress		string	Max length: 100
Reference		string	Max length: 50
PickupInstructions		string	Max length: 500
DeliveryInstructions		string	Max length: 500
GroupAvailable		boolean	None.
NotifyOrderAck		boolean	Required
NotifyOrderRouted		boolean	Required
NotifyDispatched		boolean	Required
NotifyPickedUp		boolean	Required
NotifyDepToAp		boolean	Required
NotifyObcCheckin		boolean	Required
NotifyDropped		boolean	Required
NotifyConfirmed		boolean	Required
NotifyDeparted		boolean	Required
NotifyArrived		boolean	Required
NotifyRecovered		boolean	Required
NotifyDelivered		boolean	Required
NotifyOrigQdt		boolean	Required
NotifyChangeQdt		boolean	Required
AirportID		string	Max length: 3
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",
  "AddressCode": "sample string 2",
  "CompanyName": "sample string 3",
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "Address3": "sample string 6",
  "CityName": "sample string 7",
  "StateProvID": "sample string 8",
  "PostalCode": "sample string 9",
  "CountryID": "sample string 10",
  "TimezoneID": "sample string 11",
  "Attention": "sample string 12",
  "PhoneNumber": "sample string 13",
  "EmailAddress": "sample string 14",
  "Reference": "sample string 15",
  "PickupInstructions": "sample string 16",
  "DeliveryInstructions": "sample string 17",
  "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 33",
  "PickupReadyDay": 1,
  "PickupReadyTime": "2025-03-14T10:27:31.9453131-07:00",
  "DeliveryRequestDay": 1,
  "DeliveryRequestTime": "2025-03-14T10:27:31.9453131-07:00",
  "ServiceID": 1
}

application/xml, text/xml

Sample:

<AddAddressParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Shipper">
  <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>2025-03-14T10:27:31.9453131-07:00</DeliveryRequestTime>
  <EmailAddress>sample string 14</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 13</PhoneNumber>
  <PickupInstructions>sample string 16</PickupInstructions>
  <PickupReadyDay>1</PickupReadyDay>
  <PickupReadyTime>2025-03-14T10:27:31.9453131-07:00</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>
</AddAddressParm>

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>