Skip to content

Customer API ​

Use the Customer API to view and manage customer accounts, profile details, order histories, and customer lookups.

Endpoints ​

EndpointMethodPathDescription
Fetch CustomersGET/v1/customersList registered customers
Show CustomerGET/v1/customers/{customerId}Get specific customer details
Order-Based CustomersGET/v1/customers/order-basedCustomers from orders (registered + guest)
Lookup Customers (V2)GET/v2/customers/lookupPaginated customer lookup for picker dropdowns
Update Customer ProfilePATCH/v1/customers/profile/updateUpdate authenticated customer profile
Activate CustomerPATCH/v1/customers/{customerId}/activateReactivate customer account
Deactivate CustomerPATCH/v1/customers/{customerId}/deactivateDeactivate customer account

Build with joy