Appearance

Get Customers ​

Endpoint ​

http
GET /unified/ecommerce/customers/{id}
Integrations supported
  • Bigcommerce
  • Commerce7
  • Shopify
  • Wix
  • WooCommerce
  • Zoho Inventory

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
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. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body ​

id
string

The unique identifier for customer

Supported in
  • Bigcommerce
  • Commerce7
  • Shopify
  • Wix
  • WooCommerce
  • Zoho Inventory
first_name
string

The first name of customer

Supported in
  • Bigcommerce
  • Commerce7
  • Shopify
  • Wix
  • WooCommerce
  • Zoho Inventory
last_name
string

The last name of customer

Supported in
  • Bigcommerce
  • Commerce7
  • Shopify
  • Wix
  • WooCommerce
  • Zoho Inventory
name
string

The full name of customer

Supported in
  • Commerce7
  • Shopify
  • Wix
  • Zoho Inventory
company_name
string

The company name of customer

Supported in
  • Bigcommerce
  • Wix
  • Zoho Inventory
status
string

The status of customer. If no clear mapping exists, then raw value is returned.

All possible enum values:
  • active
  • inactive
Supported in
  • Commerce7
  • Shopify
  • Zoho Inventory
currency
string

The currency associated to customer

Supported in
  • Shopify
  • Zoho Inventory
emails
object[]

The emails of customer

Supported in
  • Bigcommerce
  • Commerce7
  • Shopify
  • Wix
  • WooCommerce
  • Zoho Inventory
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
  • Commerce7
  • Shopify
  • Wix
  • WooCommerce
  • Zoho Inventory
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
  • Commerce7
  • Shopify
  • Wix
  • WooCommerce
  • Zoho Inventory
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

Supported in
  • Commerce7
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
  • Commerce7
  • Shopify
  • Wix
  • WooCommerce
  • Zoho Inventory
updated_at
string · date-time

The date and time when customer was updated

Supported in
  • Bigcommerce
  • Commerce7
  • Shopify
  • Wix
  • WooCommerce
  • Zoho Inventory
remote_data
object

Raw data returned from the remote API call.