Searches for customers that match a supplied query

请求参数

Path 参数

api_version

string

必需

Query 参数

fields

string

可选

Show only certain fields, specified by a comma-separated list of field names.

limit

string

可选

The maximum number of results to show.

order

string

可选

Set the field and direction by which to order results.

query

string

可选

Text to search for in the shop's customer data.
Note: Supported queries: accepts_marketing,
activation_date, address1, address2, city,
company, country, customer_date, customer_first_name,
customer_id, customer_last_name, customer_tag, email,
email_marketing_state, first_name, first_order_date, id,
last_abandoned_order_date, last_name, multipass_identifier,
orders_count, order_date, phone, province,
shop_id, state, tag, total_spent,
updated_at, verified_email, product_subscriber_status. All other queries
returns all customers.

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

返回响应

🟢200Searches for customers that match a supplied query

application/json

Body

customers

array [object {25}]

可选

id

number

可选

email

string

可选

accepts_marketing

boolean

可选

created_at

string

可选

updated_at

string

可选

first_name

string

可选

last_name

string

可选

orders_count

number

可选

state

string

可选

total_spent

string

可选

last_order_id

number

可选

note

null

可选

verified_email

boolean

可选

multipass_identifier

null

可选

tax_exempt

boolean

可选

tags

string

可选

last_order_name

string

可选

currency

string

可选

phone

string

可选

addresses

array [object {17}]

可选

accepts_marketing_updated_at

string

可选

marketing_opt_in_level

null

可选

tax_exemptions

array

可选

admin_graphql_api_id

string

可选

default_address

object

可选

示例

Search for a customer with a specified email addressSearch for all customers with a specified last name and show certain fieldsSearch for all customers with a specified tag and show only certain fieldsSearch for all customers with an address in the United States and a specified first nameSearch for customers matching a specified email domainSearch for customers who have verified their email address and show only certain fields

{
    "customers": [
        {
            "id": 207119551,
            "email": "bob.norman@mail.example.com",
            "accepts_marketing": false,
            "created_at": "2023-01-03T12:13:43-05:00",
            "updated_at": "2023-01-03T12:13:43-05:00",
            "first_name": "Bob",
            "last_name": "Norman",
            "orders_count": 1,
            "state": "disabled",
            "total_spent": "199.65",
            "last_order_id": 450789469,
            "note": null,
            "verified_email": true,
            "multipass_identifier": null,
            "tax_exempt": false,
            "tags": "",
            "last_order_name": "#1001",
            "currency": "USD",
            "phone": "+16136120707",
            "addresses": [
                {
                    "id": 207119551,
                    "customer_id": 207119551,
                    "first_name": null,
                    "last_name": null,
                    "company": null,
                    "address1": "Chestnut Street 92",
                    "address2": "",
                    "city": "Louisville",
                    "province": "Kentucky",
                    "country": "United States",
                    "zip": "40202",
                    "phone": "555-625-1199",
                    "name": "",
                    "province_code": "KY",
                    "country_code": "US",
                    "country_name": "United States",
                    "default": true
                }
            ],
            "accepts_marketing_updated_at": "2005-06-12T11:57:11-04:00",
            "marketing_opt_in_level": null,
            "tax_exemptions": [],
            "admin_graphql_api_id": "gid://shopify/Customer/207119551",
            "default_address": {
                "id": 207119551,
                "customer_id": 207119551,
                "first_name": null,
                "last_name": null,
                "company": null,
                "address1": "Chestnut Street 92",
                "address2": "",
                "city": "Louisville",
                "province": "Kentucky",
                "country": "United States",
                "zip": "40202",
                "phone": "555-625-1199",
                "name": "",
                "province_code": "KY",
                "country_code": "US",
                "country_name": "United States",
                "default": true
            }
        }
    ]
}