Customer information list query

Requires read_customers access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/v2/customers.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 information list V2

Query Parameters

created_at_max string
[]
Return object created before a certain time ( format see ISO8601 )
[]
Example: 2022-04-13T21:13:20+08:00
created_at_min string
[]
Return object created after a certain time ( format see ISO8601 )
[]
Example: 2022-04-13T21:13:20+08:00
fields string
[]
Limit the fields of the returned object
[]
Example: id
ids string
[]
Customer ids , different customers id separated by comma
[]
Example: 4201825024
limit integer
[]
Query of query quantity , default 50 , can not exceed 250
[]
Example: 10
page_info string
[]
The encrypted request parameters are used for the previous page and the next page, and the field is directly parsed and accessed.
[]
Example: eyJxdWVyeVBhcmFtU3RyaW5nIjoie1wic2l6ZVwiOjEsXCJzb3J0XCI6W1widWlkOmRlc2NcIl0sXCJzdG9yZUlkXCI6XCIxNjM5NjQwNTgxMzQ2XCIsXCJ1aWRcIjpcIjBcIixcInVwZGF0ZVRpbWVcIjpcIlwifSIsInNpbmNlSWRMaXN0IjpbIjU1NTUiXSwicGFnZSI6Miwic2l6ZSI6MSwiaW5pdFNvcnQiOlsidWlkOmRlc2MiXSwic29ydCI6WyJ1aWQ6ZGVzYyJdLCJkaXJlY3Rpb24iOiJuZXh0In0
since_id string
[]
Start position for data query ( customer id value )
[]
Example: 4201825024
updated_at_max string
[]
Return object updated before a certain time ( format see ISO8601 )
[]
Example: 2022-04-13T21:13:20+08:00
updated_at_min string
[]
Return object updated after a certain time ( format see ISO8601 )
[]
Example: 2022-04-13T21:13:20+08:00

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-04-13T21:13:20+08:00
accepts_mobile_marketing boolean
[]
Accept telemarketing or not
[]
Example: true
accepts_mobile_marketing_updated_at string
[]
Phone subscription time ( format see ISO8601 )
[]
Example: 2022-04-13T21:13:20+08:00
addressesobject[]
[]
Customer address 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
[]
Province
[]
Example: Kentucky
province_code string
[]
Provincial encoding
[]
Example: KY
zip string
[]
Zip code
[]
Example: 40202
asid string
[]
FB login ID
[]
Example: 481007156599455
birthday string
[]
Customer birthday Format: YYYYMMDD
[]
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
[]
Mail
[]
Example: gungcherny@gamil.com
email_marketing_consentobject
[]
E-mail marketing subscription information
consent_collected_from string
[]
Subscription information source
[]
Example: pop
consent_updated_at string
[]
Subscription change time
[]
Example: 2022-09-07T10:53:31+08:00
opt_in_level integer
[]
Subscription method ( 0 : unknown ; 1 : single_opt_in ; 2 : confirmed_opt_in )
[]
Example: 1
state integer
[]
Subscription status ( 0 : cancelled subscription ; 1 : on subscription ; 2 : not on subscription ; 3 : on-subscription confirmation )
[]
Example: 1
email_subscribe_flag integer
[]
Mailbox subscription status 0 : cancelled subscription , 1 : already available , 2 : not available , 3 : on-request confirmation , 5 : invalid ( status record after personal information is deleted )
[]
Example: 1
first_name string
[]
User name
[]
Example: Bob
gender string
[]
Gender : male / female / others/secret
[]
Example: female
id string
[]
Customer id
[]
Example: 4201825054
language string
[]
Customer language
[]
Example: en
last_name string
[]
User last name
[]
Example: Norman
last_order_id string
[]
Recent order number
[]
Example: 2005473211984312275741
last_order_name string
[]
Recent custom single number
[]
Example: #20279M
mobile_subscribe_flag integer
[]
Mobile phone subscription status 0 : cancelled subscription , 1 : already available , 2 : not available
multipass_identifier string
[]
Multipass markers
[]
Example: multipassIdentifier
nick_name string
[]
Nickname
[]
Example: BobNorman
note string
[]
Remark
[]
Example: Placed an order that had a fraud warning
orders_count long
[]
Order quantity
[]
Example: 12
phone string
[]
Phone number
[]
Example: 008615834564475
sms_marketing_consentobject
[]
Sms marketing subscription information
consent_collected_from string
[]
Subscription information source
[]
Example: pop
consent_updated_at string
[]
Subscription change time
[]
Example: 2022-09-07T10:53:31+08:00
opt_in_level integer
[]
Subscription method ( 0 : unknown ; 1 : single_opt_in ; 2 : confirmed_opt_in )
[]
Example: 1
state integer
[]
Subscription status ( 0 : cancelled subscription ; 1 : on subscription ; 2 : not available
[]
Example: 1
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

Base URL

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

ParamOptions

Authorization — header required

created_at_max — query

created_at_min — query

fields — query

ids — query

limit — query

page_info — query

since_id — query

updated_at_max — query

updated_at_min — query

Language

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