Skip to main content

Interface: CreateRecipientAddress

Extends​

  • Omit<CreateAddressRequest, "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​

CreateAddressRequest.address1

address2?​

optional address2?: string

Any additional information associated with the Address.

Inherited from​

CreateAddressRequest.address2

city​

city: string

The city associated with the address.

Inherited from​

CreateAddressRequest.city

company?​

optional company?: string

The company associated with the address.

Inherited from​

CreateAddressRequest.company

country_code​

country_code: string

2-letter country code.

Inherited from​

CreateAddressRequest.country_code

email​

email: string

first_name​

first_name: string

The customer’s first name associated with the address.

Inherited from​

CreateAddressRequest.first_name

is_gift?​

optional is_gift?: boolean

Set to true when this address is being used for redeeming gifts.

Inherited from​

CreateAddressRequest.is_gift

last_name​

last_name: string

The customer’s last name associated with the address.

Inherited from​

CreateAddressRequest.last_name

order_note?​

optional order_note?: string | null

Notes to be added to all orders associated with the address.

Inherited from​

CreateAddressRequest.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​

CreateAddressRequest.phone

province​

province: string | null

The state or province associated with the address.

Inherited from​

CreateAddressRequest.province

zip​

zip: string

The zip or postal code associated with the address.

Inherited from​

CreateAddressRequest.zip