MageSmith
OBJECT Magento 2.4.9

Customer

Defines the customer name, addresses, and other details.

Declared or extended by: CompareList, Customer, LoginAsCustomer, Review, Sales, Wishlist

Fields

compare_list CompareList

The contents of the customer's compare list.

created_at String

Timestamp indicating when the account was created.

group_id Int Deprecated
prefix String

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

firstname String

The customer's first name.

middlename String

The customer's middle name.

lastname String

The customer's family name.

suffix String

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

email String

The customer's email address. Required.

default_billing String

The ID assigned to the billing address.

default_shipping String

The ID assigned to the shipping address.

dob String Deprecated

The customer's date of birth.

date_of_birth String

The customer's date of birth.

taxvat String

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

id ID! Required

The unique ID assigned to the customer.

is_subscribed Boolean

Indicates whether the customer is subscribed to the company's newsletter.

addresses [CustomerAddress]

An array containing the customer's shipping and billing addresses.

addressesV2 CustomerAddresses

An array containing the customer's shipping and billing addresses.

gender Int

The customer's gender (Male - 1, Female - 2).

custom_attributes [AttributeValueInterface]

Customer's custom attributes.

confirmation_status ConfirmationStatusEnum! Required

The customer's confirmation status.

Customer group assigned to the customer

allow_remote_shopping_assistance Boolean! Required

Indicates whether the customer has enabled remote shopping assistance.

reviews ProductReviews! Required

Contains the customer's product reviews.

wishlists [Wishlist!]! Required

An array of wishlists. In Magento Open Source, customers are limited to one wish list. The number of wish lists is configurable for Adobe Commerce.

wishlist Wishlist! Required Deprecated

Return a customer's wish lists.

wishlist_v2 Wishlist

Retrieve the wish list identified by the unique ID for a `Wishlist` object.

Operations returning Customer

Every Magento dev tool, in one hosted workspace.

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