Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CustomerAddress

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:customer_address"

links

links: { fx:customer: Customer; fx:store: Backend.Rels.Store; self: Backend.Rels.CustomerAddress }

Type declaration

props

props: { address1: string; address2: string; address_name: string; city: string; company: string; country: string; date_created: null | string; date_modified: null | string; first_name: string; ignore_address_restrictions: boolean; is_default_billing: boolean; is_default_shipping: boolean; last_name: string; phone: string; postal_code: string; region: string }

Type declaration

  • address1: string

    The first line of the street address.

  • address2: string

    The second line of the street address.

  • address_name: string

    The name of this address. This is also the value used as the shipto entry for a multiship item.

  • city: string

    The city of this address.

  • company: string

    The company associated with this address.

  • country: string

    The country code of this address.

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • first_name: string

    The given name associated with this address.

  • ignore_address_restrictions: boolean

    By default, the country value must be valid according to the store's location_filtering value in the template_config. For instance, if your store is configured to only allow shipping and billing to the US, attempting to set the country to CA (Canada) will error. If true is passed in, the country can be any valid values. For customer_address resources that aren't the default shipping or billing, the validation will assume the shipping restrictions. NOTE: This does not currently take the region filtering into account. Defaults to false.

  • is_default_billing: boolean

    Specifies if this address is the default billing address for the customer.

  • is_default_shipping: boolean

    Specifies if this address is the default shipping address for the customer.

  • last_name: string

    The surname associated with this address.

  • phone: string

    The phone of this address.

  • postal_code: string

    The postal code of this address.

  • region: string

    The two character code for states in the United States. Other countries may call this a province. When a two character code isn't available, use the full region name.

Optional Readonly zooms

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc