Skip to main content

Interface: UpdateAddressRequest

Extends​

Properties​

address1?​

optional 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?​

optional 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?​

optional country_code: string

2-letter country code.

Inherited from​

CreateAddressRequest.country_code

discounts?​

optional discounts: object[]

code​

code: string

first_name?​

optional 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?​

optional last_name: string

The customer’s last name associated with the address.

Inherited from​

CreateAddressRequest.last_name

order_attributes?​

optional order_attributes: Property[]

Replaces cart_attributes. Extra information that is added to the order.

Inherited from​

CreateAddressRequest.order_attributes

order_note?​

optional order_note: string

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

Inherited from​

CreateAddressRequest.order_note

payment_method_id?​

optional payment_method_id: number

Payment method id for the Payment_method to be associated to this address.

Inherited from​

CreateAddressRequest.payment_method_id

phone?​

optional 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?​

optional province: string

The state or province associated with the address.

Inherited from​

CreateAddressRequest.province

shipping_lines_override?​

optional shipping_lines_override: object[]

Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when Charge is created or regenerated

code​

code: string

price​

price: string

title​

title: string

Inherited from​

CreateAddressRequest.shipping_lines_override

zip?​

optional zip: string

The zip or postal code associated with the address.

Inherited from​

CreateAddressRequest.zip