RecipientDetailsRequest.md

ClickAndDrop::RecipientDetailsRequest

Properties

Name	Type	Description	Notes
address	AddressRequest		[optional]
phone_number	String		[optional]
email_address	String		[optional]
address_book_reference	String	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

require 'click_and_drop'

instance = ClickAndDrop::RecipientDetailsRequest.new(
  address: null,
  phone_number: null,
  email_address: null,
  address_book_reference: null
)