Check customer information via email

Requires read_customers access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20260301/customers/query_user_by_email.json

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Query customer details via email.

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

email string required

User mailbox
Example: *******@example.com

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

customerobject

Customer details
accepts_marketing boolean

Mail subscription or not
Example: true
accepts_marketing_updated_at string

Email subscription time (see IOS8601 for the format)
Example: 2022-05-31T15:32:46+08:00
accepts_mobile_marketing boolean

Accept telemarketing or not
Example: true
accepts_mobile_marketing_updated_at string

Telephone subscription time (see IOS8601 for the format)
Example: 2022-05-31T15:32:46+08:00
addressesobject[]

Address information list
address1 string

Address 1
Example: 7720 Cherokee Road
address2 string

Address 2
Example: Apartment
city string

City
Example: Hagerman
company string

Company
Example: C****
country string

Country
Example: United States
country_code string

Country code
Example: US
customer_id string

Customer id
Example: 2277270272
default boolean

Default address or not
first_name string

Name
Example: S*****
id string

Address ID
Example: SL201UA5006511321220969539
last_name string

Last name
Example: T*****
phone string

Telephone number
Example: 0086158****4475
province string

Province
Example: Kentucky
province_code string

Provincial encoding
Example: KY
province_code_v2 string

The province code（ISO-3166-2 format) of the address.
zip string

Zip code
Example: 40202
asid string

FB login ID
Example: ***********9455
birthday string

Customer birthday Format: YYYYMMDD
Example: 19970102
created_at string

Creation time (see IOS8601 for the format)
Example: 2022-09-07T10:53:31+08:00
currency string

Currency
Example: USD
default_addressobject

Default address
address1 string

Address 1
Example: 7720 Cherokee Road
address2 string

Address 2
Example: Apartment 2
city string

City
Example: Hagerman
company string

Company
Example: C****
country string

Country
Example: United States
country_code string

Country code
Example: US
customer_id string

Customer id
Example: 2277270272
default boolean

Default address or not
first_name string

Name
Example: T*****
id string

Address ID
Example: SL201UA5006511323520969534
last_name string

Last name
Example: S*****
phone string

Telephone number
Example: 0086158****4475
province string

Province
Example: Kentucky
province_code string

Provincial encoding
Example: KY
province_code_v2 string

The province code（ISO-3166-2 format) of the address.
Example: KY
zip string

Zip code
Example: 40202
email string

Mail
Example: ******@example.com
email_subscribe_flag integer

Mailbox subscription status 0 : cancelled subscription , 1 : already available , 2 : not available
Example: 1
first_name string

User name
Example: S*****
gender string

Gender : male / female / others/secret
Example: female
id string

Customer id
Example: 2277270272
language string

Customer language
Example: en
last_name string

User last name
Example: T*****
last_order_id string

Recent order number
Example: 2005473211984312275741
mobile_subscribe_flag integer

Mobile phone subscription status 0 : cancelled subscription , 1 : already available , 2 : not available
nick_name string

Nickname
Example: S***** T*****
note string

Remark
Example: mark
orders_count long

Order quantity
Example: 12
phone string

Phone number
Example: 0086158****4475
social_customer array

Social media user ID
Example: ["************5231"]
state integer

Customer status [ 0 : disabled account , 1 : to enable account , 2 : invited account , 3 : valid account ]
Example: 2
tags string

Customer tag
Example: loyal
total_spent string

Total cost amount
Example: 100
updated_at string

Update time (see IOS8601 for the format)
Example: 2022-09-07T10:53:31+08:00
verified_email boolean

Verify if e-mail or not

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

Body

Body required

{
  "email": "*******@example.com"
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/customers/query_user_by_email.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal