Interface: CreateRecipientAddress
Extends
Omit<CreateAddressRequest,"customer_id"|"discounts"|"order_attributes"|"order_notes"|"payment_method_id"|"presentment_currency"|"shipping_lines_override">
Properties
address1
address1:
string
The street associated with the Address. Minimum length is 1 character.
Inherited from
Omit.address1
address2?
optionaladdress2:string
Any additional information associated with the Address.
Inherited from
Omit.address2
city
city:
string
The city associated with the address.
Inherited from
Omit.city
company?
optionalcompany:string
The company associated with the address.
Inherited from
Omit.company
country_code
country_code:
string
2-letter country code.
Inherited from
Omit.country_code
email
email:
string
first_name
first_name:
string
The customer’s first name associated with the address.
Inherited from
Omit.first_name
is_gift?
optionalis_gift:boolean
Set to true when this address is being used for redeeming gifts.
Inherited from
Omit.is_gift
last_name
last_name:
string
The customer’s last name associated with the address.
Inherited from
Omit.last_name
order_note?
optionalorder_note:string
Notes to be added to all orders associated with the address.
Inherited from
Omit.order_note
phone
phone:
string
The phone number associated with the address. Must be included in the request schema but can be an empty string.
Inherited from
Omit.phone
province
province:
string
The state or province associated with the address.
Inherited from
Omit.province
zip
zip:
string
The zip or postal code associated with the address.
Inherited from
Omit.zip