| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
(Mandatory) Recipient ID |
string |
None. |
| Contact |
(Optional) Contact Name |
string |
None. |
| Company |
(Optional) Company Name |
string |
None. |
| CountryCode |
(Mandatory) Country Code |
string |
None. |
| ProvinceOrState |
(Optional) Province/State Code |
string |
None. |
| City |
(Mandatory) City |
string |
None. |
| Postal |
(Optional) Postal / Zip Code |
string |
None. |
| Address1 |
(Mandatory) Address 1 |
string |
None. |
| Address2 |
(Optional) Address 2 |
string |
None. |
| Address3 |
(Optional) Address 3 |
string |
None. |
| Tel |
(Optional) Telephone # |
string |
None. |
| Extension |
(Optional) Telephone Extension |
string |
None. |
| Fax |
(Optional) Fax # |
string |
None. |
|
(Optional) Email |
string |
None. |
|
| Email1 |
(Optional) Email 1 |
string |
None. |
| Email2 |
(Optional) Email 2 |
string |
None. |
| IsResidential |
(Optional) Address is residential |
boolean |
None. |
| TaxID |
(Optional)Tax ID |
string |
None. |
| Instructions |
(Optional)Recipient Instructions |
string |
None. |
| ShipmentInstructions |
(Optional)Shipment Instructions |
string |
None. |
| RecipientType |
Recipient Type |
string |
None. |
| AddressLocation |
(Optional)Recipient Type |
string |
None. |
| PreferredCarrier |
(Optional) Preferred Carrier |
integer |
None. |
| PreferredServiceCode |
(Optional) Preferred Carrier Service Code |
string |
None. |
| PreferredBillingType |
(Optional) Preferred Billing Type |
WS_Repository.Models.Requests.Ship.BillingType |
None. |
| PreferredCustomerPricingValue |
(Optional) Preferred Customer Pricing Value |
decimal number |
None. |
| PreferredCustomerPricingCalculationType |
(Optional) Preferred Customer Pricing Calculation Type |
WS_Repository.Models.Requests.AddressBook.CustomerMarkupType |
None. |
| RecipientLogoBase64String |
(Optional) Recipient Logo in base64 string - Logo size must be less than 50KB |
string |
None. |
| CarrierAccounts |
(Optional) Recipient Carrier Accounts |
Collection of WS_Repository.Models.Requests.AddressBook.RecipientCarrierAccount |
None. |
| PreferredDepartmentCode |
(Optional) Preferred Department Code |
string |
None. |
| PreferredDepartmentName |
(Optional) Preferred Department Name |
string |
None. |