This Web Service returns the entire list of customers, in a JSON array format.
The customers entity on StoresAce is global to all stores. So, any customer can belong to any store.
Therefore, the argument store won't take any effect on filter results.
This method can be used to synchronize customers with any ERP software,
but also with other external Loyalty or E-Commerce Platforms.
Bellow is a description list of some main fields you may get and post to this method:
| Field | Description |
|---|---|
| CustomerId | Customer Internal Code |
| FederalTaxId | Customer Tax Number |
| OrganizationName | Customer Full Name |
| EmailAddress | Email Address |
| Address | Location Address Lines |
| Telephone | Contact Telephones and Mobile Numbers |
| CardId | Customer Card ID in case of having Loyalty Program Card |
| BirthDate | Date of Birth |
| TotalPoints | When Loyalty module is active, this returns customer current points count |
| Discount | Discounts to apply on Customers Sales |
| Limits | Sales Maximum Daily Limit Values |
To apply filters or search criteria on customers list, the GET request type can receive the following arguments:
| Argument | Description |
|---|---|
| FederalTaxId | Filter by Customer Tax Number |
| CustomerId | Filter by Customer Internal Code |
| CardId | Filter by Loyalty Card Number |
| MobileTelephone | Filter by Mobile Telephone Number |
| EmailAddress | Filter by Email Address |
If you have any further questions, please contact us using the chat icon in the bottom of this page or directly from your StoresAce Environment.