Skip to content

List Customers

Endpoint

http
GET /unified/ecommerce/customers
Integrations supported
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string
By default the `result` attribute is an array of objects. This parameter allows you to specify a field in each `result` objects to use as key, which transforms the `result` array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
Example: id
truto_ignore_limit
boolean
Ignores the `limit` query parameter.
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar
email
Supported in
  • Wix
  • WooCommerce
created_at
string · date-time
The date and time when customer was created
Supported in
  • Bigcommerce
  • Shopify
  • Wix
updated_at
string · date-time
The date and time when customer was updated
Supported in
  • Bigcommerce
  • Shopify
  • Wix
name
string
The full name of customer
Supported in
  • Bigcommerce
emails
array
The emails of customer
Supported in
  • Bigcommerce
sort_by
object
The field to sort the resource by. Should be in format `{ fieldName: direction }`. The direction can be `asc` or `desc`.
Supported in
  • Bigcommerce
  • Wix
created_at
string · date-time
The date and time when customer was created
All possible enum values:
  • asc
  • desc
Supported in
  • Bigcommerce
  • Wix
updated_at
string · date-time
The date and time when customer was updated
All possible enum values:
  • asc
  • desc
Supported in
  • Bigcommerce
  • Wix

Response Body

result
object[]
List of Customers
id
string
The unique identifier for customer
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
first_name
string
The first name of customer
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
last_name
string
The last name of customer
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
name
string
The full name of customer
Supported in
  • Shopify
  • Wix
company_name
string
The company name of customer
Supported in
  • Bigcommerce
  • Wix
status
string
The status of customer. If no clear mapping exists, then raw value is returned.
All possible enum values:
  • active
  • inactive
Supported in
  • Shopify
currency
string
The currency associated to customer
Supported in
  • Shopify
emails
object[]
The emails of customer
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
email
string
REQUIRED · The email of the customer
type
string
The type of email
is_primary
boolean
The status of email
phones
object[]
The phone numbers of customer
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
number
string
REQUIRED · The number of phone
extension
string
The extension of the phone number
type
string
The type of phone
addresses
object[]
The addresses of a customer
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
type
string
The type of an address of a customer
id
string
The unique identifier of an address of a customer
street_1
string
The first line of address of a customer
street_2
string
The second line of address of a customer
city
string
The city of the address of a customer
state
string
The state/province of the address of a customer
postal_code
string
The postal code of the address of a customer
country
string
The country of the address of a customer
orders
object[]
The orders of customer
id
string
The id of orders of the customer
total
string
The total amount of orders of email
status
string
The status of orders of the customer
created_at
string · date-time
The date and time when customer was created
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
updated_at
string · date-time
The date and time when customer was updated
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.