Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleCustomers

List of customers. Represents information about a customers of the shop, such as the customer's contact details, their order history, and whether they've agreed to receive marketing material by email.

Field

Description

Accepts marketing

Whether the customer has agreed to receive marketing material.

Accepts marketing updated at

The date and time when the customer consented or objected to receiving marketing material by email.

Average order amount

The average amount that the customer spent per order.

Can delete

Whether the merchant can delete the customer from their store. A customer can be deleted from a store only if they have not yet made an order. After a customer makes an order, they can't be deleted from a store.

Created at

The date and time when the customer was added to the store.

Display name

The full name of the customer, based on the values for first_name and last_name. If the first_name and last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.

Email

The customer's email address.

First name

The customer's first name.

Has timeline comment

Whether the merchant has added timeline comments about the customer on the customer's page.

ID

Globally unique ID.

Last name

The customer's last name.

Legacy resource ID

The ID of the corresponding resource in the REST Admin API.

Lifetime duration

The amount of time since the customer was first added to the store. Example: 'about 12 years'.

Locale

The customer's locale.

Marketing opt-in level

The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines, that the customer gave when they consented to receive marketing material by email. If the customer does not accept email marketing, then this property will be null.

Note

A note about the customer.

Number of orders

The number of orders that the customer has made at the store in their lifetime.

Phone

The customer's phone number.

State

The state of the customer's account with the shop.

Tags

A comma separated list of tags that have been added to the customer.

Tax exempt

Whether the customer is exempt from being charged taxes on their orders.

Tax exemptions

The list of tax exemptions applied to the customer.

Updated at

The date and time when the customer was last updated.

Valid email address

Whether the email address is formatted correctly. This does not guarantee that the email address actually exists.

Verified email

Whether the customer has verified their email address. Defaults to true if the customer is created through the Shopify admin or API.

...

Expand
titleCustomers / Orders

A list of the customer's orders.

Field

Description

Order ID

Globally unique ID.

Expand
titleCustomers / SMS marketing consent

The current SMS marketing state for the customer's phone number.

Field

Description

Consent collected from

The source from which the SMS marketing information for the customer was collected.

Consent updated at

The date and time when the customer consented to receive marketing material by SMS. If no date is provided, then the date and time when the consent information was sent is used.

Marketing opt-in level

The marketing subscription opt-in level that was set when the customer consented to receive marketing information.

Marketing state

The current SMS marketing state for the customer.