Customer information retrieval

Requires read_customers access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20220901/customers/v2/search.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 .

[]

Customer information check v 2

Query Parameters

fields string
[]
Limit the fields of the returned object
[]
Example: id
limit integer
[]
Query of query quantity , default 50 , can not exceed 250
[]
Example: 10
order integer
[]
Sort rules default order by user creation time
page_info string
[]
The input parameter after encryption , including all of the picnic conditions parameter , for the previous page , take the page , directly take the field of access
[]
Example: eyJxdWVyeVBhcmFtU3RyaW5nIjoie1wic2l6ZVwiOjUwLFwic29ydFwiOltcInVpZDpkZXNjXCJdLFwic3RvcmVJZFwiOlwiMTYzOTY0MDU4MTM0NlwiLFwidWlkXCI6XCIwXCIsXCJ1cGRhdGVUaW1lXCI6XCJcIn0iLCJzaW5jZUlkTGlzdCI6WyI0MjAxNzk5MTAzIl0sInBhZ2UiOjIsInNpemUiOjUwLCJpbml0U29ydCI6WyJ1aWQ6ZGVzYyJdLCJzb3J0IjpbInVpZDpkZXNjIl0sImRpcmVjdGlvbiI6Im5le
query string
[]
Query conditions , support ( accepts_marketing , email_subscribe_flag , customer_date , customer_first_name , customer_id , tags ,Orders_count , order_date , state , total_spent , updated_at , verified_email ) different fields are divided by a number ; separated , the field and the field value are separated by a colon : separated .Example : customer_id : 1 ; orders_count : 2
[]
Example: email_subscribe_flag:1
query_param string
[]
The fuzzy prompt condition search range includes mobile phones number , mailbox , customer name , common address information
[]
Example: 130

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Response

[]

For more information about status codes, see Http status code.

Response Headers

link
[]
Contain the request parameters of the previous page and the next page
traceId
[]
traceId

Response Body

customersobject[]
[]
Customer list
accepts_marketing boolean
[]
Mail subscription or not
[]
Example: true
accepts_marketing_updated_at string
[]
Mail subscription time ( format see ISO8601 )
[]
Example: 2022-05-31T15:32:46+08:00
accepts_mobile_marketing boolean
[]
Example: true
accepts_mobile_marketing_updated_at string
[]
Phone subscription time ( format see ISO8601 )
[]
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 2
city string
[]
City
[]
Example: Hagerman
company string
[]
Company
[]
Example: Joy
country string
[]
Country
[]
Example: United States
country_code string
[]
Country code
[]
Example: US
customer_id string
[]
Customer id
[]
Example: 4201825054
default boolean
[]
Default address or not
[]
Example: true
first_name string
[]
Name
[]
Example: Bob
id string
[]
Address ID
[]
Example: 207119551
last_name string
[]
Last name
[]
Example: Norman
phone string
[]
Telephone number
[]
Example: 008615834564475
province string
[]
Save
[]
Example: Kentucky
province_code string
[]
Provincial encoding
[]
Example: KY
zip string
[]
Zip code
[]
Example: 40202
asid string
[]
FB login ID
[]
Example: 481007156599455
birthday string
[]
Example: 19970102
created_at string
[]
Create time ( format see ISO8601 )
[]
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: Joy
country string
[]
Country
[]
Example: United States
country_code string
[]
Country code
[]
Example: US
customer_id string
[]
customer id
[]
Example: 4201825054
default boolean
[]
Default address or not
[]
Example: true
first_name string
[]
name
[]
Example: Bob
id string
[]
Address ID
[]
Example: 207119551
last_name string
[]
Last name
[]
Example: Norman
phone string
[]
Telephone number
[]
Example: 008615834564475
province string
[]
Province
[]
Example: Kentucky
province_code string
[]
Provincial encoding
[]
Example: KY
zip string
[]
Zip code
[]
Example: 40202
email string
[]
Mailbox
[]
Example: 123@qq.com
email_subscribe_flag integer
[]
Mailbox subscription status 0 : cancelled subscription , 1 : already available , 2 : not available
[]
Example: 1
first_name string
[]
User nickname
[]
Example: Bob
gender string
[]
Example: female
id string
[]
Customer id
[]
Example: 4201825054
language string
[]
Example: en
last_name string
[]
Example: Norman
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: BobNorman
note string
[]
Notes
[]
Example: Placed an order that had a fraud warning
orders_count long
[]
Order quantity
[]
Example: 12
phone string
[]
Phone number
[]
Example: 008615834564475
social_customer array
[]
Social media user ID
[]
Example: [6612273988815231]
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 ( format see ISO8601 )
[]
Example: 2022-09-07T10:53:31+08:00
verified_email boolean
[]
Verify if e-mail or not

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

fields — query

limit — query

order — query

page_info — query

query — query

query_param — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20220901/customers/v2/search.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

Error loading component.