Skip to main content
Anchor to customer

customer

query

Returns a Customer resource by ID.

Anchor to Arguments

Arguments

Anchor to idid
•ID!
required

The ID of the Customer to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CustomerCustomer
•Customer

Information about a customer of the shop, such as the customer's contact details, purchase history, and marketing preferences.

Tracks the customer's total spending through the amountSpent field and provides access to associated data such as payment methods and subscription contracts.

Caution

Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.

Anchor to addressesV2addressesV2
•MailingAddressConnection!
non-null

The addresses associated with the customer.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to amountSpentamountSpent
•MoneyV2!
non-null

The total amount that the customer has spent on orders in their lifetime.

Anchor to canDeletecanDelete
•Boolean!
non-null

Whether the merchant can delete the customer from their store.

A customer can be deleted from a store only if they haven't yet made an order. After a customer makes an order, they can't be deleted from a store.

Anchor to companyContactProfilescompanyContactProfiles
•[CompanyContact!]!
non-null

A list of the customer's company contact profiles.

Anchor to createdAtcreatedAt
•DateTime!
non-null

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

Anchor to dataSaleOptOutdataSaleOptOut
•Boolean!
non-null

Whether the customer has opted out of having their data sold.

Anchor to defaultAddressdefaultAddress
•MailingAddress

The default address associated with the customer.

Anchor to defaultEmailAddressdefaultEmailAddress
•CustomerEmailAddress

The customer's default email address.

Anchor to defaultPhoneNumberdefaultPhoneNumber
•CustomerPhoneNumber

The customer's default phone number.

Anchor to displayNamedisplayName
•String!
non-null

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.

Anchor to eventsevents
•EventConnection!
non-null

A list of events associated with the customer.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•EventSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action
•string

The action that occured.

Example:

  • action:create
Anchor to comments
•boolean

Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.

Example:

  • false
  • true
Anchor to created_at
•time

Filter by the date and time when the event happened.

Example:

  • created_at:>2020-10-21
  • created_at:<now
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to subject_type
•string

The resource type affected by this event. See EventSubjectType for possible values.

Example:

  • PRODUCT_VARIANT
  • PRODUCT
  • COLLECTION
Anchor to firstNamefirstName
•String

The customer's first name.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to imageimage
•Image!
non-null

The image associated with the customer.

Arguments

Anchor to sizesize
•Int
Deprecated
Anchor to lastNamelastName
•String

The customer's last name.

Anchor to lastOrderlastOrder
•Order

The customer's last order.

Anchor to legacyResourceIdlegacyResourceId
•UnsignedInt64!
non-null

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

Anchor to lifetimeDurationlifetimeDuration
•String!
non-null

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

Example: 'about 12 years'.

Anchor to localelocale
•String!
non-null

The customer's locale.

Anchor to mergeablemergeable
•CustomerMergeable!
non-null

Whether the customer can be merged with another customer.

Anchor to metafieldmetafield
•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Arguments

Anchor to namespacenamespace
•String

The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to keykey
•String!
required

The key for the metafield.

Anchor to metafieldsmetafields
•MetafieldConnection!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

Arguments

Anchor to namespacenamespace
•String

The metafield namespace to filter by. If omitted, all metafields are returned.

Anchor to keyskeys
•[String!]

List of keys of metafields in the format namespace.key, will be returned in the same format.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to multipassIdentifiermultipassIdentifier
•String

A unique identifier for the customer that's used with Multipass login.

Anchor to notenote
•String

A note about the customer.

Anchor to numberOfOrdersnumberOfOrders
•UnsignedInt64!
non-null

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

Anchor to ordersorders
•OrderConnection!
non-null

A list of the customer's orders.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•OrderSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to cart_token
•string

Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order.

Example:

  • cart_token:abc123
Anchor to channel
•string

Filter by the channel information handle (ChannelInformation.channelDefinition.handle) field.

Example:

  • channel:web
  • channel:web,pos
Anchor to channel_id
•id

Filter by the channel id field.

Example:

  • channel_id:123
Anchor to chargeback_status
•string

Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution.

Valid values:

  • accepted
  • charge_refunded
  • lost
  • needs_response
  • under_review
  • won

Example:

  • chargeback_status:accepted
Anchor to checkout_token
•string

Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order.

Example:

  • checkout_token:abc123
Anchor to confirmation_number
•string

Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique.

Example:

  • confirmation_number:ABC123
Anchor to created_at
•time

Filter by the date and time when the order was created in Shopify's system.

Example:

  • created_at:2020-10-21T23:39:20Z
  • created_at:<now
  • created_at:<=2024
Anchor to credit_card_last4
•string

Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security.

Example:

  • credit_card_last4:1234
Anchor to current_total_price
•float

Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges.

Example:

  • current_total_price:10
  • current_total_price:>=5.00 current_total_price:<=20.99
Anchor to customer_id
•id

Filter orders by the customer id field.

Example:

  • customer_id:123
Anchor to delivery_method
•string

Filter by the delivery methodType field.

Valid values:

  • shipping
  • pick-up
  • retail
  • local
  • pickup-point
  • none

Example:

  • delivery_method:shipping
Anchor to discount_code
•string

Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255.

Example:

  • discount_code:ABC123
Anchor to email
•string

Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns.

Example:

  • email:example@shopify.com
Anchor to financial_status
•string

Filter by the order displayFinancialStatus field.

Valid values:

  • paid
  • pending
  • authorized
  • partially_paid
  • partially_refunded
  • refunded
  • voided
  • expired

Example:

  • financial_status:authorized
Anchor to fraud_protection_level
•string

Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes.

Valid values:

  • fully_protected
  • partially_protected
  • not_protected
  • pending
  • not_eligible
  • not_available

Example:

  • fraud_protection_level:fully_protected
Anchor to fulfillment_location_id
•id

Filter by the fulfillment location id (Fulfillment.location.id) field.

Example:

  • fulfillment_location_id:123
Anchor to fulfillment_status
•string

Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing.

Valid values:

  • unshipped
  • shipped
  • fulfilled
  • partial
  • scheduled
  • on_hold
  • unfulfilled
  • request_declined

Example:

  • fulfillment_status:fulfilled
Anchor to gateway
•string

Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways.

Example:

  • gateway:shopify_payments
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to location_id
•id

Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned.

Example:

  • location_id:123
Anchor to metafields.{namespace}.{key}
•mixed

Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.

Example:

  • metafields.custom.on_sale:true
  • metafields.product.material:"gid://shopify/Metaobject/43458085"
Anchor to name
•string

Filter by the order name field.

Example:

  • name:1001-A
Anchor to payment_id
•string

Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues.

Example:

  • payment_id:abc123
Anchor to payment_provider_id
•id

Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions.

Example:

  • payment_provider_id:123
Anchor to po_number
•string

Filter by the order poNumber field.

Example:

  • po_number:P01001
Anchor to processed_at
•time

Filter by the order processedAt field.

Example:

  • processed_at:2021-01-01T00:00:00Z
Anchor to reference_location_id
•id

Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location.

Example:

  • reference_location_id:123
Anchor to return_status
•string

Filter by the order's returnStatus to monitor returns processing and track which orders have active returns.

Valid values:

  • return_requested
  • in_progress
  • inspection_complete
  • returned
  • return_failed
  • no_return

Example:

  • return_status:in_progress
Anchor to risk_level
•string

Filter by the order risk assessment riskLevel field.

Valid values:

  • high
  • medium
  • low
  • none
  • pending

Example:

  • risk_level:high
Anchor to sales_channel
•string

Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes.

Example:

  • sales_channel: some_sales_channel
Anchor to sku
•string

Filter by the product variant sku field. Learn more about SKUs.

Example:

  • sku:ABC123
Anchor to source_identifier
•string

Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order.

Example:

  • source_identifier:1234-12-1000
Anchor to source_name
•string

Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods.

Example:

  • source_name:web
  • source_name:shopify_draft_order
Anchor to status
•string

Filter by the order's status to manage workflows or analyze the order lifecycle.

Valid values:

  • open
  • closed
  • cancelled
  • not_closed

Example:

  • status:open
Anchor to subtotal_line_items_quantity
•string

Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns.

Example:

  • subtotal_line_items_quantity:10
  • subtotal_line_items_quantity:5..20
Anchor to tag
•string

Filter objects by the tag field.

Example:

  • tag:my_tag
Anchor to tag_not
•string

Filter by objects that don’t have the specified tag.

Example:

  • tag_not:my_tag
Anchor to test
•boolean

Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.

Example:

  • test:true
Anchor to total_weight
•string

Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz.

Example:

  • total_weight:10.5kg
  • total_weight:>=5g total_weight:<=20g
  • total_weight:.5 lb
Anchor to updated_at
•time

Filter by the date and time when the order was last updated in Shopify's system.

Example:

  • updated_at:2020-10-21T23:39:20Z
  • updated_at:<now
  • updated_at:<=2024
Anchor to paymentMethodspaymentMethods
•CustomerPaymentMethodConnection!
non-null

A list of the customer's payment methods.

Arguments

Anchor to showRevokedshowRevoked
•Boolean
Default:false

Whether to show the customer's revoked payment method.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to productSubscriberStatusproductSubscriberStatus
•CustomerProductSubscriberStatus!
non-null

Possible subscriber states of a customer defined by their subscription contracts.

Anchor to statestate
•CustomerState!
non-null

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

Please note that this only meaningful when Classic Customer Accounts is active.

Anchor to statisticsstatistics
•CustomerStatistics!
non-null

The statistics for a given customer.

Anchor to storeCreditAccountsstoreCreditAccounts
•StoreCreditAccountConnection!
non-null

Returns a list of store credit accounts that belong to the owner resource. A store credit account owner can hold multiple accounts each with a different currency.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to currency_code
•string
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to subscriptionContractssubscriptionContracts
•SubscriptionContractConnection!
non-null

A list of the customer's subscription contracts.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to tagstags
•[String!]!
non-null

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

Anchor to taxExempttaxExempt
•Boolean!
non-null

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

Anchor to taxExemptionstaxExemptions
•[TaxExemption!]!
non-null

The list of tax exemptions applied to the customer.

Anchor to updatedAtupdatedAt
•DateTime!
non-null

The date and time when the customer was last updated.

Anchor to verifiedEmailverifiedEmail
•Boolean!
non-null

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

Anchor to addressesaddresses
•[MailingAddress!]!
non-nullDeprecated

Arguments

Anchor to firstfirst
•Int

Truncate the array result to this size.

Anchor to emailemail
•String
Deprecated
Anchor to emailMarketingConsentemailMarketingConsent
•CustomerEmailMarketingConsentState
Deprecated
Anchor to hasTimelineCommenthasTimelineComment
•Boolean!
non-nullDeprecated
Anchor to marketmarket
•Market
Deprecated
Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated

Arguments

Anchor to namespacenamespace
•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus
•MetafieldDefinitionPinnedStatus
Default:ANY

Filter by the definition's pinned status.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•MetafieldDefinitionSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to created_at
•time

Filter by the date and time when the metafield definition was created.

Example:

  • created_at:>2020-10-21T23:39:20Z
  • created_at:<now
  • created_at:<=2024
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to key
•string

Filter by the metafield definition key field.

Example:

  • key:some-key
Anchor to namespace
•string

Filter by the metafield definition namespace field.

Example:

  • namespace:some-namespace
Anchor to owner_type
•string

Filter by the metafield definition ownerType field.

Example:

  • owner_type:PRODUCT
Anchor to type
•string

Filter by the metafield definition type field.

Example:

  • type:single_line_text_field
Anchor to updated_at
•time

Filter by the date and time when the metafield definition was last updated.

Example:

  • updated_at:>2020-10-21T23:39:20Z
  • updated_at:<now
  • updated_at:<=2024
Anchor to phonephone
•String
Deprecated
Anchor to smsMarketingConsentsmsMarketingConsent
•CustomerSmsMarketingConsentState
Deprecated
Anchor to unsubscribeUrlunsubscribeUrl
•URL!
non-nullDeprecated
Anchor to validEmailAddressvalidEmailAddress
•Boolean!
non-nullDeprecated
Was this section helpful?