Contacts
Contacts represent data about a specific customer. Carts, orders, attributes are associated with contacts.
In a B2B environment a contact is part of a company representing the organisation he/she is working for. Orders for the company, in a B2B environment, are placed by a specific contact.
The contact API is only available on the Propeller cloud version. The legacy version of Propeller does not support this API
Contact Lookup keys
| Key | Type | Description |
|---|---|---|
id | integer | Propeller contact id |
sourceId | string | External system unique id. sourceId should be combined with source |
Fields
| Name | Description | Type |
|---|---|---|
debtorId (deprecated) | A unique id representing the company of this contact. A debtorId can be automatically generated by Propellor | integer string |
firstName | Contact first name | string |
middleName | Contact middle name | string |
lastName | Contact last name | string |
abbreviation | Contact abbreviation | string |
title | Contact title | string |
dateOfBirth | Contact date of birth | date |
gender | Contact gender | enum m=Male f=Female u=Undefined |
ssn | Contact ssn | string |
phone | Contact phone number | string |
email | A valid email address | string |
parent | Parent company | JSON object that identifies the parent. id or sourceId in combination with source |
pricelistAmount | A pricesheet code in case of special pricing agreements | string |
pricelistPercentage | A pricesheet code in case of special pricing agreements | string |
primaryLanguage | Contact primary language | string ISO 639-1 |
sourceId | External system unique id | string |
source | External system | string |
User Errors
This section describes error codes specific for the User resource.
| Code | Error Type | Status Code | Message | Reason |
|---|---|---|---|---|
50004 | ContactExists | 400 | Contactalready exists | Contact with such lookup key already exists |
50005 | ContactMultipleFound | 400 | Multuple contacts found. Please provide additional filters | Multiple contacts with such lookup key exist |
50006 | ContactNotFound | 404 | Contactdoes not exist | Contact with such lookup key not found |
50007 | ParentContactNotFound | 404 | Parent contact not found | Parent contact with such lookup key not found. This error is typical when working with contact sub-resources (e.g. attributes) |
50008 | ContactNotAllowed | 404 | Contact is not allowed | Usually when contact is in Recycle Bin and can't be used |
📄️ Create Contact Pricing
Use this endpoint to define [pricing](/rest/pricesheets) for an existing contact. The contact can be identified by it's lookup key. It is required to provide either `categories` or `products` or both in the payload.
📄️ Delete Contact Pricing
Use this endpoint to delete pricing for an existing contact. The contact can be identified by it's lookup key.
📄️ Create Contact
Use this endpoint to create a single contact. If a contact is successfully created, the response will include the user `id`.
📄️ Get Contact by lookup key
Use this endpoint to retrieve contact details by lookup key. If multiple contacts with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the contact (e.g. `source` and `language` for lookup key `sourceId`).
📄️ Delete Contact by lookup key
Delete a `contact` by a specific lookupKey / lookupId combination. A deleted `contact` will be moved to the Propeller Recycle bin. This means the deleted contact can be restored, however, only via the Propeller backoffice.
📄️ Update Contact by lookup key
Use this endpoint to update contact by lookup key. If multiple contacts with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the contact (e.g. `source` and `language` for lookup key `sourceId`).
📄️ Bulk Contacts by source id
The bulk endpoints offer an efficient way of importing/updating large amounts of contacts with just a single API call. When using the bulk `sourceId` endpoint, the contacts are identified by `sourceId`, `source` and `language`. If a contact doesn't already exist, it will be created. If it does exist, the contact found will be updated.
📄️ Bulk Contacts by Id
The bulk endpoints offer an efficient way of importing/updating large amounts of contacts with just a single API call. When using the bulk `id` endpoint, the contacts are identified by `id`. If a contact doesn't already exist, it will be created. If it does exist, the contact found will be updated.
📄️ Search Contacts
> The contacts search endpoint is only available on the Propeller cloud version.