BigCommerce - Get Customers

Description

This module allows querying the customer base of a BigCommerce store. It can get a specific customer by ID or list customers with various filters such as email, name, company, and customer group.

Configuration

Required Credentials

• Store Hash: Unique hash of your BigCommerce store
• Access Token: API V3 access token

Parameters

Parameter	Type	Required	Description
credentials_id	credential	Yes	BigCommerce credentials
customer_id	string	No	Specific customer ID
email	string	No	Filter by email
name	string	No	Search by name (partial)
company	string	No	Search by company
customer_group_id	number	No	Customer group ID
date_created_min	string	No	Minimum creation date (ISO 8601)
date_created_max	string	No	Maximum creation date (ISO 8601)
include_addresses	boolean	No	Include addresses in response
sort	select	No	Sorting
limit	number	No	Result limit (default: 50)
page	number	No	Results page (default: 1)

Output

{
  "success": true,
  "customers": [...],
  "total": 250,
  "total_pages": 5,
  "current_page": 1,
  "message": "50 customers retrieved"
}

Customer Fields

• id: Customer ID
• email: Email
• first_name: First name
• last_name: Last name
• company: Company
• phone: Phone
• customer_group_id: Group ID
• date_created: Creation date
• date_modified: Modification date
• addresses: Array of addresses (if include_addresses=true)

Usage Example

Get customer by ID

{
  "customer_id": "123"
}

Search customer by email

{
  "email": "cliente@ejemplo.com"
}

List customers from a group

{
  "customer_group_id": 5,
  "include_addresses": true,
  "limit": 100
}

Customers created this month

{
  "date_created_min": "2024-01-01T00:00:00Z",
  "date_created_max": "2024-01-31T23:59:59Z",
  "sort": "date_created:desc"
}

API Used

• Endpoint: GET /stores/{store_hash}/v3/customers
• Documentation: BigCommerce Customers API

Notes

• Uses the BigCommerce V3 API for customers
• The maximum limit per page is 250 customers
• Addresses are included only if explicitly requested
• Name search uses partial matching (LIKE)
• Email must be exact for filtering

Related Nodes

• BigcommerceCreateCustomer - Create customer
• BigcommerceUpdateCustomer - Update customer
• BigcommerceGetOrders - Get customer orders