Customer List

GET 
/openapi/2022-01/customers

Retrieve a list of all customers with pagination.

Request

Query Parameters

ids string

ID list, separate with comma, e.g. 701670d5-4afd-40b5-8d4f-7e0e55683849,da1bb9af-2489-40df-a15e-f54abdf7fd86

limit int32
Record count in every page, maximum: 250
Default value: 10
page int32
Page number
Default value: 1
created_at_min string

Filter customer created at after date, e.g. 2016-01-18T23:41:00Z

created_at_max string

Filter customer created_at before date, e.g. 2016-01-18T23:41:00Z

updated_at_min string

Filter customer last updated at after, e.g. 2016-01-18T23:41:00Z

updated_at_max string

Filter customer last updated at before date, e.g. 2016-01-18T23:41:00Z

email string

Filter by email, e.g. [email protected]

contact string

Filter by contact,e.g., [email protected]

Responses

200

200

application/json

Schema

Schema

customers object[]
Array [
idstring
Example: 2dd957e3-2051-4cdf-8584-9c0046b4d1ae
first_namestring
Example: ryan
last_namestring
Example: zhang
namestring
Example: ryan zhang
emailstring
Example: [email protected]
phonestring
Example: +8615014471143
phone_area_code
contact_typestring
Example: email
accepts_marketingboolean
Default value: true
Example: true
source
free_taxboolean
Default value: true
Example: false
registeredboolean
Default value: true
Example: false
orders_countinteger
Default value: 0
Example: 0
last_order_at
total_spentstring
Example: 0.00
tagsstring
Example: New Customer
created_atstring
Example: 2024-04-17T11:10:33Z
updated_atstring
Example: 2024-04-17T11:10:33Z
subscribed_flaginteger
Default value: 0
Example: 5
sms_subscribed_flaginteger
Default value: 0
Example: 5
accepts_sms_marketingboolean
Default value: true
Example: true
default_address object
idstring
Example: 9ffa8dc0-25b8-4424-832e-bab46fcfeb20
customer_idstring
Example: 2dd957e3-2051-4cdf-8584-9c0046b4d1ae
first_namestring
Example: test
last_namestring
Example: test
companystring
Example:
citystring
Example: 深圳
provincestring
Example:
countrystring
Example: Aland lslands
zipstring
Example: 515300
province_codestring
Example:
country_codestring
Example: AX
genderstring
Example:
phonestring
Example: +86 150 1447 1143
phone_area_code
areastring
Example:
emailstring
Example: [email protected]
namestring
Example: test test
address1string
Example: 6 三聖街
address2string
Example: 1111
country_namestring
Example: Aland lslands
defaultboolean
Default value: true
Example: true
addresses object[]
Array [
idstring
Example: 9ffa8dc0-25b8-4424-832e-bab46fcfeb20
customer_idstring
Example: 2dd957e3-2051-4cdf-8584-9c0046b4d1ae
first_namestring
Example: test
last_namestring
Example: test
companystring
Example:
citystring
Example: 深圳
provincestring
Example:
countrystring
Example: Aland lslands
zipstring
Example: 515300
province_codestring
Example:
country_codestring
Example: AX
genderstring
Example:
phonestring
Example: +86 150 1447 1143
phone_area_code
areastring
Example:
emailstring
Example: [email protected]
namestring
Example: test test
address1string
Example: 6 三聖街
address2string
Example: 1111
country_namestring
Example: Aland lslands
defaultboolean
Default value: true
Example: true
]
]

Example

{
  "customers": [
    {
      "id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
      "first_name": "ryan",
      "last_name": "zhang",
      "name": "ryan zhang",
      "email": "[email protected]",
      "phone": "+8615014471143",
      "phone_area_code": {},
      "contact_type": "email",
      "accepts_marketing": true,
      "source": {},
      "free_tax": false,
      "registered": false,
      "orders_count": 0,
      "last_order_at": {},
      "total_spent": "0.00",
      "tags": "New Customer",
      "created_at": "2024-04-17T11:10:33Z",
      "updated_at": "2024-04-17T11:10:33Z",
      "subscribed_flag": 5,
      "sms_subscribed_flag": 5,
      "accepts_sms_marketing": true,
      "default_address": {
        "id": "9ffa8dc0-25b8-4424-832e-bab46fcfeb20",
        "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
        "first_name": "test",
        "last_name": "test",
        "company": "",
        "city": "深圳",
        "province": "",
        "country": "Aland lslands",
        "zip": "515300",
        "province_code": "",
        "country_code": "AX",
        "gender": "",
        "phone": "+86 150 1447 1143",
        "phone_area_code": {},
        "area": "",
        "email": "[email protected]",
        "name": "test test",
        "address1": "6 三聖街",
        "address2": "1111",
        "country_name": "Aland lslands",
        "default": true
      },
      "addresses": [
        {
          "id": "9ffa8dc0-25b8-4424-832e-bab46fcfeb20",
          "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
          "first_name": "test",
          "last_name": "test",
          "company": "",
          "city": "深圳",
          "province": "",
          "country": "Aland lslands",
          "zip": "515300",
          "province_code": "",
          "country_code": "AX",
          "gender": "",
          "phone": "+86 150 1447 1143",
          "phone_area_code": {},
          "area": "",
          "email": "[email protected]",
          "name": "test test",
          "address1": "6 三聖街",
          "address2": "1111",
          "country_name": "Aland lslands",
          "default": true
        }
      ]
    }
  ]
}

Result

{
  "customers": [
    {
      "id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
      "first_name": "ryan",
      "last_name": "zhang",
      "name": "ryan zhang",
      "email": "[email protected]",
      "phone": "+8615014471143",
      "phone_area_code": null,
      "contact_type": "email",
      "accepts_marketing": true,
      "source": null,
      "free_tax": false,
      "registered": false,
      "orders_count": 0,
      "last_order_at": null,
      "total_spent": "0.00",
      "tags": "New Customer",
      "created_at": "2024-04-17T11:10:33Z",
      "updated_at": "2024-04-17T11:10:33Z",
      "subscribed_flag": 5,
      "sms_subscribed_flag": 5,
      "accepts_sms_marketing": true,
      "default_address": {
        "id": "9ffa8dc0-25b8-4424-832e-bab46fcfeb20",
        "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
        "first_name": "test",
        "last_name": "test",
        "company": "",
        "city": "深圳",
        "province": "",
        "country": "Aland lslands",
        "zip": "515300",
        "province_code": "",
        "country_code": "AX",
        "gender": "",
        "phone": "+86 150 1447 1143",
        "phone_area_code": null,
        "area": "",
        "email": "[email protected]",
        "name": "test test",
        "address1": "6 三聖街",
        "address2": "1111",
        "country_name": "Aland lslands",
        "default": true
      },
      "addresses": [
        {
          "id": "9ffa8dc0-25b8-4424-832e-bab46fcfeb20",
          "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae",
          "first_name": "test",
          "last_name": "test",
          "company": "",
          "city": "深圳",
          "province": "",
          "country": "Aland lslands",
          "zip": "515300",
          "province_code": "",
          "country_code": "AX",
          "gender": "",
          "phone": "+86 150 1447 1143",
          "phone_area_code": null,
          "area": "",
          "email": "[email protected]",
          "name": "test test",
          "address1": "6 三聖街",
          "address2": "1111",
          "country_name": "Aland lslands",
          "default": true
        }
      ]
    }
  ]
}

400

400

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Exceeds maximum limit of 250"
  ]
}

Result

{
  "errors": [
    "Exceeds maximum limit of 250"
  ]
}

406

406

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Created at max time format error"
  ]
}

Result

{
  "errors": [
    "Created at max time format error",
    "Updated at min time format error",
    "Updated at max time format error"
  ]
}