Admin API/Customers/Queries

customers

query

Customers of the shop. Search: phone:, email:, tag:, country:, city:, orders_count:>2, blocked:true, or free text (name, phone, email).

Returns CustomerConnection!

query Customers($first: Int, $query: String) {
  customers(first: $first, query: $query) {
    nodes {
      id
      email
      phone
      createdAt
      blocked
      blockedReason
      addresses {
        id
        name
        phone
        address1
        address2
        city
      }
      amountSpent {
        amount
        currencyCode
      }
      defaultAddress {
        id
        name
        phone
        address1
        address2
        city
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

# Variables
{
  "first": 10,
  "query": "status:active"
}

Arguments

afterString
beforeString
firstInt
lastInt
queryString
reverseBoolean
sortKeyCustomerSortKeys

Returned fields

edges[CustomerEdge!]!required
nodes[Customer!]!required
pageInfoPageInfo!required

query Customers($first: Int, $query: String) { customers(first: $first, query: $query) { nodes { id email phone createdAt blocked blockedReason addresses { id name phone address1 address2 city } amountSpent { amount currencyCode } defaultAddress { id name phone address1 address2 city } } pageInfo { hasNextPage endCursor } } } # Variables { "first": 10, "query": "status:active" }