Shopify attributes

legacyResourceId

Shopify customer identifier.

• Number*. Example: 4435209126053.

acceptsMarketing

Whether the customer has consented to receive marketing material via email.

• Number*. Example:0.

acceptsMarketingUpdatedAt

The date and time (ISO 8601 format) when the customer consented or objected to receiving marketing material by email.

• Date*. Example: 2021-02-02T10:23:58Z.

addresses

A list of the ten most recently updated addresses for the customer.

• Array*. See address object for detailed description of each entry in the array.

averageOrderAmountV2

The average amount that the customer spent per order.

• Array*. Example:

  {
    "amount": "0.00",
    "currencyCode": "EUR"
  }

canDelete

Whether the merchant can delete the customer from their store.

• Number.* Example:1.

createdAt

The date and time (ISO 8601 format) when the customer was created.

• Date*. Example: 2021-02-02T10:23:58Z

defaultAddress

The default address for the customer. Same properties as address.

• Array*. See address object for detailed description of each entry in the array.

displayName

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

• String*. Example: John Doe

email

The unique email address of the customer.

• String*. Example: [email protected]

firstName

The customer's first name.

• String*. Example:John

lastName

The customer's last name.

• String*. Example:Doe

hasNote

Whether the customer has a note associated with them.

• Number.* Example:0

hasTimelineComment

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

• Number.* Example:0

lifetimeDuration

The amount of time since the customer was first added to the store.

• String*. Example: about 1 month

locale

The customer's language.

• String*. Example:en

marketingOptInLevel

The marketing subscription opt-in that the customer gave when they consented to receive marketing material by email.

• Number*.

note

A note about the customer.

• String*. Example: Repeating customer

ordersCount

The number of orders associated with this customer.

• Number.* Example: 14

lastOrder

Customer’s last order information.
See last order object for detailed description of each property.

state

The state of the customer's account with a shop. Default value: disabled.

• String*. Valid values:

disabled: The customer doesn't have an active account. Customer accounts can be disabled from the Shopify admin at any time.
invited: The customer has received an email invite to create an account.
enabled: The customer has created an account.
declined: The customer declined the email invite to create an account.

tags

Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values.

• Array*. Example: [example1,example2]

taxExempt

Whether the customer is exempt from paying taxes on their order. If 1, then taxes won't be applied to an order at checkout. If 0, then taxes will be applied at checkout.

• Number.* Example:0

taxExemptions

Whether the customer is exempt from paying specific taxes on their order. Canadian taxes only. See Shopify's documentation for valid values (under tax_exemptions).

• Array*. Example:

  [
    "CA_STATUS_CARD_EXEMPTION",
    "CA_BC_RESELLER_EXEMPTION"
  ]

totalSpent

The total amount of money that the customer has spent across their order history.

• Number*. Example: 50.76

totalSpentV2

The total amount of money with currency that the customer has spent across their order history.

• Array*. Example:

  {
    "amount": "0.00",
    "currencyCode": "EUR"
  }

updatedAt

The date and time (ISO 8601 format) when the customer information was last updated.

• Date*. Example: 2021-02-12T12:36:03Z

validEmailAddress

Whether the email address is valid.

• Number*. Example:1

verifiedEmail

Whether the customer has verified their email address.

• Number*. Example:1

address1

The customer's mailing address.
Example:Sunset Blvd, 92

address2

An additional field for the customer's address.
Example: Apt. 2

city

The customer's city, town, or village.
Example: Louisville

company

The customer's company.
Example: Clara Enterprises Inc.

country

The customer's country.
Example: US

country_code

Two-letter country code corresponding to the customer's country.
Example: US

country_name

The customer's normalized country name.
Example: United States

customer_id

A unique identifier for the customer.
Example: 6940095564

default

Whether this address is the default address for the customer. Boolean.
Example: true

first_name

The customer's first name.
Example: Clara

id

A unique identifier for the address.
Example: 207119551

last_name

The customer's last name.
Example: Norman

name

The customer's first and last names.
Example: Clara Norman

phone

The customer's phone number at this address.
Example: 555-625-1199

province

The customer's region name. Typically a province, a state, or a prefecture.
Example: Kentucky

province_code

The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

zip

The customer's postal code, also known as zip, postcode, Eircode, etc.
Example: 40202

id

A unique id for the customer
Example: gid://shopify/Order/3744530170021

cancelReason

Reason the order was canceled. Returns null if the order wasn't canceled.
Example: declined

cancelledAt

Date and time the order was canceled. Returns null if the order wasn't canceled.
Example: 2021-05-15T13:04:22Z

cartDiscountAmountSet

Amount of the order-level discount (does not contain any line item discounts) in shop and presentment currencies.
Example: 29.99

closed

Whether the order is closed. Boolean.
Example: false

closedAt

Date and time when the order closed. If the order is not closed, then this field is null.
Example: 2021-05-15T16:05:11Z

confirmed

Whether inventory has been reserved for the order. Boolean.
Example: true

createdAt

Date and time when the order was created in Shopify
Example: 2021-04-15T13:59:31Z

currentSubtotalLineItemsQuantity

The sum of the quantities for the line items that contribute to the order's subtotal.
Example: 1

currentSubtotalPriceSet

The subtotal of line items and their discounts minus the line items that have been returned. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
Example:

{
  "presentmentMoney": {
    "amount": "0.5",
    "currencyCode": "EUR"
  },
  "shopMoney": {
    "amount": "0.5",
    "currencyCode": "EUR"
  }
}

currentTotalDiscountsSet

The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned.
Example:

{
  "presentmentMoney": {
    "amount": "0.0",
    "currencyCode": "EUR"
  }
}

currentTotalPriceSet

The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned.
Example:

{
  "presentmentMoney": {
    "amount": "0.5",
    "currencyCode": "EUR"
  }
}

displayFulfillmentStatus

Fulfillment status for the order that can be shown to the merchant. This field does not capture all the possible details of an order's fulfillment state. It should only be used for display summary purposes.
Example: UNFULFILLED

totalDiscountsSet

Total amount discounted from the order (include order-level and line item discounts) in shop and presentment currencies.
Example:

{
  "presentmentMoney": {
    "amount": "0.0",
    "currencyCode": "EUR"
  }

totalPriceSet

Total amount of the order (includes taxes and discounts) in shop and presentment currencies.
Example:

{
  "presentmentMoney": {
    "amount": "0.5",
    "currencyCode": "EUR"
  }

totalRefundedSet

Total amount refunded for the order in shop and presentment currencies.
Example:

{
  "presentmentMoney": {
    "amount": "0.0",
    "currencyCode": "EUR"
  },
  "shopMoney": {
    "amount": "0.0",
    "currencyCode": "EUR"
  }
}