MageSmith
OBJECT Magento 2.4.9

CustomerAddress

Contains detailed information about a customer's billing or shipping address.

Declared or extended by: Customer

Fields

id Int Deprecated

The ID of a `CustomerAddress` object.

uid ID

The unique ID for a `CustomerAddress` object.

customer_id Int Deprecated

The customer ID

An object containing the region name, region code, and region ID.

region_id Int

The unique ID for a pre-defined region.

country_id String Deprecated

The customer's country.

country_code CountryCodeEnum

The customer's country.

street [String]

An array of strings that define the street number and name.

company String

The customer's company.

telephone String

The customer's telephone number.

fax String

The customer's fax number.

postcode String

The customer's ZIP or postal code.

city String

The customer's city or town.

firstname String

The first name of the person associated with the shipping/billing address.

lastname String

The family name of the person associated with the shipping/billing address.

middlename String

The middle name of the person associated with the shipping/billing address.

prefix String

An honorific, such as Dr., Mr., or Mrs.

suffix String

A value such as Sr., Jr., or III.

vat_id String

The customer's Value-added tax (VAT) number (for corporate customers).

default_shipping Boolean

Indicates whether the address is the customer's default shipping address.

default_billing Boolean

Indicates whether the address is the customer's default billing address.

custom_attributes [CustomerAddressAttribute] Deprecated
custom_attributesV2 [AttributeValueInterface!]! Required

Custom attributes assigned to the customer address.

extension_attributes [CustomerAddressAttribute]

Contains any extension attributes for the address.

Operations returning CustomerAddress

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.