Query all customers in groups

Requires read_customers access scope.
For more info, refer to:
access permission.
GET https://{handle}.myshopline.com/admin/openapi/v20260301/customer_saved_searches/:id/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 .
Ask a customer list under a group
Path Parameters
  • id string required
    Group id
Query Parameters
  • order string
    Sorting rule 1: Reverse order according to the last order time (default) 2: Reverse order according to the number of orders
    Example: 1
  • page_info string
    The unique identifier for pagination queries, used to locate a specific page.
    This parameter value is obtained from the link value in the response header of this API after you have queried the pagination information.
    For example, if the link value you obtained is <https://{handle}.myshopline.com/admin/openapi/{version}/customer_saved_searches/:id/customers.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" , the value of page_info is eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 .
    For more information on how to use pagination, refer to Paging Mechanism.
    Example: eyJxdWVyeVBhcmFtU3RyaW5nIjoie1wic2l6ZVwiOjEsXCJzb3J0XCI6W1widWlkOmRlc2NcIl0sXCJzdG9yZUlkXCI6XCIxNjM5NjQwNTgxMzQ2XCIsXCJ1aWRcIjpcIjBcIixcImNyZWF0ZVRpbWVcIjpcIjw9MTY0OTg1NTYwMDAwMFwiLFwidXBkYXRlVGltZVwiOlwiXCJ9Iiwic2luY2VJZExpc3QiOlsiNDIwMTY4MDE5NSJdLCJwYWdlIjoyLCJzaXplIjoxLCJpbml0U29ydCI6WyJ1aWQ6ZGVzYyJdLCJzb3J0IjpbInVpZDpkZXNjIl0sImRpcmVjdGlvbiI6Im5leHQifQ
  • fields string
    Limit the fields of the returned object
    Example: id
  • limit string
    Query of query quantity , default 50 , can not exceed 250
    Example: 10
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
Status Codes
For the complete list of codes and messages, see Http status code.
Response Headers
  • link
    The URL link that provides the pagination data. You can obtain page_info from this parameter for subsequent pagination requests.
    This parameter is returned when the requested page has a previous or next page.
    For more information on how to use pagination, refer to Paging Mechanism.
  • 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
  • customersobject[]
    Customer list
  • accepts_marketing boolean
    Accept mail marketing or not
    Example: true
  • accepts_marketing_updated_at string
    Mail subscription time
    Example: 2022-05-31T15:32:46+08:00
  • addressesobject[]
    Customer address list
  • address1 string
    Address 1
    Example: 7720 Cherokee Road
  • address2 string
    Address 2
    Example: Apartment 2
  • city string
    Tertiary address
    Example: Hagerman
  • country string
    Primary address
    Example: United States
  • country_code string
    Primary address encoding
    Example: US
  • customer_id string
    Customer ID using this address
    Example: 4201825054
  • default boolean
    Is it the default address
    Example: true
  • first_name string
    Customer's first name
    Example: Bob
  • id string
    Address ID
    Example: 207119551
  • last_name string
    Customer's last name
    Example: Norman
  • phone string
    Telephone number
    Example: 008615834564475
  • province string
    Secondary address
    Example: Kentucky
  • province_code string
    Secondary address encoding
    Example: KY
  • zip string
    Postal code
    Example: 40202
  • created_at string
    Customer information created in
    Example: 2022-09-07T10:53:31+08:00
  • currency string
    Currency
    Example: USD
  • email string
    E-mail
    Example: zhangsan@gmail.com
  • email_subscribe_flag integer
    Mailbox subscription status 0 : cancelled subscription , 1 : already available , 2 : not available
    Example: 1
  • first_name string
    Customer username
    Example: Bob
  • id string
    Customer id
    Example: 4201825054
  • last_name string
    Customer username
    Example: Norman
  • last_order_id string
    Recent order number
    Example: 2005473211984312275741
  • last_order_name string
    Name of recent order
    Example: order1
  • last_order_time string
    Recent order time
    Example: 2022-09-07T10:53:31+08:00
  • mobile_subscribe_flag string
    Mobile phone subscription status 0 : cancelled subscription , 1 : already available , 2 : not available , 3 : in confirmation , 4 : invalid , 5 : deleted
    Example: 1
  • nick_name string
    User full name
    Example: Bob Norman
  • note string
    Customer notes
    Example: Placed an order that had a fraud warning
  • orders_count long
    Customer cumulative order qty
    Example: 12
  • phone string
    Phone number
    Example: 008615834564475
  • state integer
    Customer status .0 disabled account ; 1 enabled account ; 2 invited account ; 3 valid account
    Example: 2
  • tags string
    Customer label Join with English comma
    Example: loyal
  • total_spent string
    Customer cumulative consumption amount
    Example: 100
  • updated_at string
    Customer information updated at
    Example: 2022-09-07T10:53:31+08:00
  • verified_email boolean
    Verify if e-mail or not
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— path required
— header required
— query
— query
— query
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/customer_saved_searches/id/customers.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Query group users
Response
{
  "customers": [
    {
      "accepts_marketing": false,
      "addresses": [],
      "created_at": "2023-04-12T15:54:10+08:00",
      "email": "******@example.com",
      "email_subscribe_flag": 2,
      "first_name": "S*****",
      "id": "4214250090",
      "last_name": "T*****",
      "mobile_subscribe_flag": 1,
      "nick_name": "S***** T*****",
      "orders_count": 2,
      "phone": "0086138****5678",
      "state": 1,
      "total_spent": "800",
      "updated_at": "2023-04-13T22:53:48+08:00"
    }
  ]
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.