Contact
Contacts include customers, suppliers and staff. The contact service allows you to manage these contacts, the groups they are members of and the tags they are associated with, along with lead source information. Contacts play a key role in order management, as all orders and credits are associated with contacts.
Resources
| Represents a company entity within the Brightpearl system, and allows these entities to be created, retrieved, and modified. | |
| A contact represents an individual or organisation that your business has a relationship with. This includes customers, suppliers and staff. | |
| This endpoint removes information associated with a contact, it has been created to ease data protection operations for merchants. | |
| Represents a collection of contacts who are related, for example teams, departments or priority customers. | |
| Allows contacts to be added to and removed from contact groups, and the current group members to be queried. | |
| An contact note represents a note against a contact. | |
| Allows you to associate addresses with contacts. | |
| A contact status is used to indicate the state of an individual Contact. Note the difference between a contact's status and a contact's tags; ... | |
| These methods allow tags to be added to and removed from contacts. | |
| Contact custom fields are the user-defined data held against Brightpearl contacts. Several data types are available. Custom fields are separated between Supplier contacts and Customer contacts, and may only be assigned to one of these groups. | |
| Custom fields may be configured to allow you to hold additional information against your contacts. The fields available to a contact are defined from within the application and cannot be altered here, ... | |
| Lead sources track the origin of customers and sales for reporting purposes. | |
| Allows you to query addresses, and create new addresses to be associated with contacts. | |
| A resource to which orders and accounting transactions can be assigned for filtering reports. | |
| Tags are used to identify collections of contacts based on some common attribute, for example the sales channel they came from. |