Skip to main content
The Customers API gives you access to every customer record in your Eaglecart store. Use it to sync customer data with your CRM, build loyalty program integrations, segment audiences for marketing campaigns, or automate account creation when customers register through external channels.
Eaglecart supports GDPR right-to-erasure requests. To submit a data erasure request for a customer, contact Eaglecart support with the customer ID. Erasure removes all personally identifiable information associated with the account and cannot be undone.

The Customer Object

string
Unique identifier for the customer (e.g. cus_01HABC456).
string
Customer’s first name.
string
Customer’s last name.
string
Customer’s email address. Must be unique within your store.
string
Customer’s phone number in E.164 format (e.g. +14155552671).
integer
Total number of orders the customer has placed in your store.
number
Total amount the customer has spent across all orders, in your store’s base currency.
string
ISO 8601 timestamp of when the customer account was created.
object
The customer’s default shipping address.

List Customers

Retrieve a paginated list of all customers in your store. Filter by email to look up a specific customer without knowing their ID. GET /customers
string
Filter to return the customer with this exact email address.
integer
Number of customers to return per page. Defaults to 20. Maximum is 100.
integer
Page number to retrieve. Defaults to 1.
Response

Get a Customer

Retrieve a single customer by their ID. GET /customers/:id
string
required
The unique ID of the customer to retrieve.
Response

Create a Customer

Create a new customer account in your store. Email addresses must be unique — attempting to create a customer with a duplicate email returns 422 Unprocessable Entity. POST /customers
string
required
Customer’s email address. Must be unique within your store.
string
Customer’s first name.
string
Customer’s last name.
string
Customer’s phone number in E.164 format.
object
Default shipping address to associate with the new customer.
Response

Update a Customer

Update an existing customer’s profile. Send only the fields you want to modify. PATCH /customers/:id
string
required
The unique ID of the customer to update.
string
Updated first name.
string
Updated last name.
string
Updated phone number in E.164 format.
object
Updated default shipping address. Providing this field replaces the existing default address entirely.
Response

Error Handling

The Customers API uses standard HTTP status codes. All error responses include a JSON body with a code field and a human-readable message.