RecipientDetailsRequest
Properties
| Name |
Type |
Description |
Notes |
| address |
AddressRequest |
|
[optional] |
| phone_number |
str |
|
[optional] |
| email_address |
str |
|
[optional] |
| address_book_reference |
str |
The presence or not of <b>addressBookReference</b> and a valid <b>recipient address object</b> in the request body will determine which of the following behaviours occur:-</br></br>1) addressBookReference <b>provided</b> and a valid recipient address object <b>provided</b> - In addition to the provided recipient address fields being used for the order creation, an existing account Address Book Reference with matching addressBookReference will be overwritten with all provided recipient address fields, including phone and email. If no existing account Address Book Reference with matching addressBookReference can be found then a new one will be created with the provided addressBookReference and address fields, including phone and email.</br>2) addressBookReference <b>provided</b> and a valid recipient address object <b>not provided</b> - An account Address Book Reference with the provided addressBookReference will be used for the order if it exists.</br>3) addressBookReference <b>not provided</b> and a valid recipient address object <b>provided</b> - All provided recipient address fields, including phone and email, will be used for the order creation.</br>4) All other scenarios will result in a validation error. |
[optional] |
Example
from click_and_drop_api.models.recipient_details_request import RecipientDetailsRequest
# TODO update the JSON string below
json = "{}"
# create an instance of RecipientDetailsRequest from a JSON string
recipient_details_request_instance = RecipientDetailsRequest.from_json(json)
# print the JSON string representation of the object
print(RecipientDetailsRequest.to_json())
# convert the object into a dict
recipient_details_request_dict = recipient_details_request_instance.to_dict()
# create an instance of RecipientDetailsRequest from a dict
recipient_details_request_from_dict = RecipientDetailsRequest.from_dict(recipient_details_request_dict)